Salesforce Docs Portal

Step Properties for the fndSingleDocxLwc Omniscript

This Omniscript consists of steps, which run sequentially when the Omniscript is invoked. Each step has properties that determine the action the step performs. If you want to change the steps, Salesforce recommends that you either create a new version or clone a copy of this Omniscript.

Omniscript Step

Properties

Script Configuration

Type — docGenerationSample

SubType — fndSingleDocxLwc

EnterObject

ObjectId — The Salesforce Object ID, which is assigned to the contextID later in the SetValues step.

TemplateType — Either Microsoft Word .DOCX Template or Microsoft PowerPoint .PPTX Template.

GetDocumentTemplates

Invokes the DocGenSample-ExtractDocumentTemplatesLWC Omnistudio Data Mapper, which retrieves all active DOCX or PPTX document templates.

PickTemplate

Displays the document templates in the clmSelectableItems Lightning Web Component.

SetValues

Sets the selectedTemplate and templateType values to be passed to the Generate Document step.

GenerationOptions

DownloadFileFormat — The document type for download: All (default), Microsoft Word, Microsoft PowerPoint, PDF, or None.

AttachFileFormat — The document type for attachment: Microsoft Word (default), Microsoft PowerPoint, PDF, Word, PDF, PowerPoint, PDF, or None.

DocumentViewer — The preview format: PDF or None. A value of None means you can't preview the document.

DocumentTitle — Title for the generated document. In Document Generation 2.0, this is a mandatory field.

UseTemplateDRExtract — Specifies whether to use the Data Mapper Extract associated with the selected template.

The DocGenerationMechanism and PdfGenerationSource are both read-only and set to ClientSide. If you customize the Omniscript, you can make these selectable.

Insert Space for Repeating Content Tokens — Specifies whether the repeating content token's output is separated with spaces in a generated document.

documentGenerationFontSource - Specifies the source of the font used for rendering values during document generation. Possible values include Rich Text Editor Font, Document Font. The default value is Rich Text Editor Font. Rich Text Editor Font uses the font defined in the rich text field data, while Document Font uses the font defined in the document template.

Keep Intermediate — [Optional] Specifies whether intermediate DOCX or PPTX files generated for PDF conversion are retained. When both attachFileFormat and downloadFileFormat are set to pdf, setting keep-intermediate=false triggers the system to delete the intermediate file after conversion, reducing storage usage. Supports singleDocxLwc, singleWebLwc, and multiDocxLwc OmniScripts through the LWCs ClmOsDocxGenerateDocument, ClmOsWebGenerateDocument, and ClmOsMultiDocxGenerateDocument. By default, keep-intermediate is set to true, maintaining existing behavior.

Set Generation Options

Sets the attachFileFormat, docGenerationMechanism, documentViewer, downloadFileFormat, pdfGenerationSource, useTemplateDRExtract,documentGenerationFontSource, insertSpaceforRepeatingContentTokens, and documentTitle values to be passed to the Generate Document step.

Generate Document

Uses the clmOsDocxGenerateDocument Lightning Web Component to generate and display the document. The Email Word/Powerpoint and Email PDF options send a message to the email address of the current user. This Lightning Web Component calls the DocgenAppHandler Apex class.

Pass these parameters to the LWC:

  • context-id: [Required] SObjectId, such as QuoteId, OpportunityId, OrderId, or ContractID. If context-id is null, the file looks for context-id in the data JSON of the Omniscript, which is set in the Set Values step.
  • selected-template: [Required] Passes the selected template. This parameter accepts the JSON format of the selected template. For capturing selectedTemplate details, see clmSelectableItems Lightning Web Component. Example JSON node: {"Name": "TestGouse", "VersionNumber": 1, "DocumentGenerationMechanism": "ClientSide", "TemplateType": "MicrosoftWord", "Id": "2dtWU000000NUqDYAW", "Select": true}
  • debug: [Optional] Displays the debug statement for the template query when turned on.
  • document-title: [Optional] Overrides the default document name of your document.
  • keep-intermediate: [Optional] Specifies whether intermediate DOCX or PPTX files generated for PDF conversion are retained. When both attachFileFormat and downloadFileFormat are set to pdf and keep-intermediate is false, the system deletes the intermediate file after conversion, which helps reduce storage usage. This parameter applies to singleDocxLwc, singleWebLwc, and multiDocxLwc Omniscripts through the LWCs ClmOsDocxGenerateDocument, ClmOsWebGenerateDocument, and ClmOsMultiDocxGenerateDocument. By default, keep-intermediate is true, which preserves existing behavior.
  • show-delete-icon: [Optional] The default value is true. If true, the delete icon appears in the document preview after the document is generated. If false, the delete icon doesn't appear in the document preview after the document is generated.
  • show-download-guidance: [Optional] The default value is true. If true, the message "For a seamless preview experience, use the Download button instead of the download icon to open your file." appears in the document preview after the document is generated. If false, the message doesn't appear in the document preview after the document is generated.