---
schema_version: "1"
id: 4e5ca42bc35a4b86a557e1cea406dbc092fb50ad13440ef5eca7c4bef336069e
title: Step Properties for the fndSingleDocxLwc Omniscript
collection: admin
version: current
locale: en-us
portal_url: https://docs.salesforce.com/admin/current/en-us/ind/264-0-0/doc_gen_omniscript_step_properties_394328.md
canonical_url: https://help.salesforce.com/s/articleView?id=ind.doc_gen_omniscript_step_properties_394328.htm&release=264.0.0&type=5
source_site: help.salesforce.com
content_type: documentation
content_hash: cad3328bb55b06b4f59e71849ce257866e0526d78e8eae5b8fe6a3b836ed0db9
description: 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.
products:
  - Omnistudio Document Generation
release: "264"
---
# 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.

<table class="slds-table slds-table_bordered slds-max-medium-table_stacked slds-m-bottom_small ">
      <colgroup>
        <col style="width:35%">
        <col style="width:65%">
      </colgroup>
      <thead class="slds-text-title_caps ">
        <tr class="">
          <th scope="col" class="slds-cell-wrap" style="vertical-align:top;" id="d10374e36">
            <p style="margin-bottom:0;">Omniscript Step</p>
          </th>
          <th scope="col" class="slds-cell-wrap" style="vertical-align:top;" id="d10374e42">
            <p style="margin-bottom:0;">Properties</p>
          </th>
        </tr>
      </thead>
      <tbody>
        <tr class="">
          <td data-label="Omniscript Step" class="slds-cell-wrap" style="vertical-align:top;" headers="d10374e36 ">
            <p style="margin-bottom:0;">Script Configuration</p>
          </td>

          <td data-label="Properties" class="slds-cell-wrap" style="vertical-align:top;" headers="d10374e42 ">
            <p><strong class="uicontrol">Type</strong> —
              <code>docGenerationSample</code>
            </p>
            <p style="margin-bottom:0;"><strong class="uicontrol">SubType</strong> —
              <code>fndSingleDocxLwc</code>
            </p>
          </td>

        </tr>
        <tr class="">
          <td data-label="Omniscript Step" class="slds-cell-wrap" style="vertical-align:top;" headers="d10374e36 ">
            <p style="margin-bottom:0;">EnterObject</p>
          </td>

          <td data-label="Properties" class="slds-cell-wrap" style="vertical-align:top;" headers="d10374e42 ">
            <p><strong class="uicontrol">ObjectId</strong> — The Salesforce Object ID, which is
              assigned to the contextID later in the <strong class="uicontrol">SetValues</strong>
              step.</p>
            <p style="margin-bottom:0;"><strong class="uicontrol">TemplateType</strong> — Either <code>Microsoft
                      Word .DOCX Template</code> or <code>Microsoft PowerPoint .PPTX
                    Template</code>.</p>
          </td>

        </tr>
        <tr class="">
          <td data-label="Omniscript Step" class="slds-cell-wrap" style="vertical-align:top;" headers="d10374e36 ">
            <p style="margin-bottom:0;">GetDocumentTemplates</p>
          </td>

          <td data-label="Properties" class="slds-cell-wrap" style="vertical-align:top;" headers="d10374e42 ">
            <p style="margin-bottom:0;">Invokes the <code>DocGenSample-ExtractDocumentTemplatesLWC</code>
              Omnistudio Data Mapper, which retrieves all active DOCX or PPTX document
              templates.</p>
          </td>

        </tr>
        <tr class="">
          <td data-label="Omniscript Step" class="slds-cell-wrap" style="vertical-align:top;" headers="d10374e36 ">
            <p style="margin-bottom:0;">PickTemplate</p>
          </td>

          <td data-label="Properties" class="slds-cell-wrap" style="vertical-align:top;" headers="d10374e42 ">
            <p style="margin-bottom:0;">Displays the document templates in the <code>clmSelectableItems</code>
              Lightning Web Component.</p>
          </td>

        </tr>
        <tr class="">
          <td data-label="Omniscript Step" class="slds-cell-wrap" style="vertical-align:top;" headers="d10374e36 ">
            <p style="margin-bottom:0;">SetValues</p>
          </td>

          <td data-label="Properties" class="slds-cell-wrap" style="vertical-align:top;" headers="d10374e42 ">
            <p style="margin-bottom:0;">Sets the <code>selectedTemplate</code> and <code>templateType</code>
              values to be passed to the <strong class="uicontrol">Generate Document</strong>
              step.</p>
          </td>

        </tr>
        <tr class="">
          <td data-label="Omniscript Step" class="slds-cell-wrap" style="vertical-align:top;" headers="d10374e36 ">
            <p style="margin-bottom:0;">GenerationOptions</p>
          </td>

          <td data-label="Properties" class="slds-cell-wrap" style="vertical-align:top;" headers="d10374e42 ">
            <p><strong class="uicontrol">DownloadFileFormat</strong> — The document type for download:
              <code>All</code> (default), <code>Microsoft Word</code>, <code>Microsoft
                  PowerPoint</code>, <code>PDF</code>, or <code>None</code>.
            </p>
            <p id="doc_gen_omniscript_step_properties_394328__uuid-2087cbbf-0141-211a-db10-23b4a78a3c86_para-idm263242750938890"><a name="doc_gen_omniscript_step_properties_394328__uuid-2087cbbf-0141-211a-db10-23b4a78a3c86_para-idm263242750938890"><!-- --></a><strong class="uicontrol">AttachFileFormat</strong> — The document type for attachment:
              <code>Microsoft Word</code> (default), <code>Microsoft PowerPoint</code>,
              <code>PDF</code>, <code>Word, PDF</code>, <code>PowerPoint,
                PDF</code>, or <code>None</code>.
            </p>
            <p><strong class="uicontrol">DocumentViewer</strong>
              — The preview format: <code>PDF</code> or <code>None</code>. A value of
              <code>None</code> means you can't preview the
              document.
            </p>
            <p><strong class="uicontrol">DocumentTitle</strong>&nbsp;— Title for the generated
              document. In Document Generation 2.0, this is a mandatory
              field.</p>
            <p><strong class="uicontrol">UseTemplateDRExtract</strong> — Specifies whether to
              use the Data Mapper Extract associated with the selected template.</p>
            <p>The
              <strong class="uicontrol">DocGenerationMechanism</strong> and
              <strong class="uicontrol">PdfGenerationSource</strong> are both read-only and set to
              <code>ClientSide</code>. If you customize the Omniscript, you can make these
              selectable.
            </p>
            <p><strong class="uicontrol">Insert Space for Repeating Content Tokens</strong> —
              Specifies whether the repeating content token's output is separated with spaces in a
              generated document.</p>
            <p><strong class="uicontrol">documentGenerationFontSource </strong>-
              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.</p>
            <p style="margin-bottom:0;"><strong class="uicontrol">Keep Intermediate</strong> — [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.</p>
          </td>

        </tr>
        <tr class="">
          <td data-label="Omniscript Step" class="slds-cell-wrap" style="vertical-align:top;" headers="d10374e36 ">
            <p style="margin-bottom:0;">Set Generation Options</p>
          </td>

          <td data-label="Properties" class="slds-cell-wrap" style="vertical-align:top;" headers="d10374e42 ">
            <p style="margin-bottom:0;">Sets the <code>attachFileFormat</code>,
              <code>docGenerationMechanism</code>, <code>documentViewer</code>,
              <code>downloadFileFormat</code>, <code>pdfGenerationSource</code>,
              <code>useTemplateDRExtract,</code><code>documentGenerationFontSource</code>,
              <code> insertSpaceforRepeatingContentTokens</code>, and
              <code>documentTitle</code> values to be passed to the <strong class="uicontrol">Generate
                Document</strong> step.
            </p>
          </td>

        </tr>
        <tr class="">
          <td data-label="Omniscript Step" class="slds-cell-wrap" style="vertical-align:top;" headers="d10374e36 ">
            <p style="margin-bottom:0;">Generate Document</p>
          </td>

          <td data-label="Properties" class="slds-cell-wrap" style="vertical-align:top;" headers="d10374e42 ">
            <p>Uses the <code>clmOsDocxGenerateDocument</code> Lightning Web Component to
              generate and display the document. The <strong class="uicontrol">Email
                Word/Powerpoint</strong> and <strong class="uicontrol">Email PDF</strong> options send a
              message to the email address of the current user. This Lightning Web Component
              calls the <span class="apiname">DocgenAppHandler</span> Apex class.</p>
            <p>Pass these parameters to the LWC:</p>
            <ul>
              <li>
                <strong class="uicontrol">context-id</strong>: [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.
              </li>

              <li>
                <strong class="uicontrol">selected-template</strong>: [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: <code>{"Name": "TestGouse", "VersionNumber": 1, "DocumentGenerationMechanism": "ClientSide", "TemplateType": "MicrosoftWord", "Id": "2dtWU000000NUqDYAW", "Select": true}</code>
              </li>

              <li>
                <strong class="uicontrol">debug</strong>: [Optional] Displays the debug statement for the template query when turned on.
              </li>

              <li>
                <strong class="uicontrol">document-title</strong>: [Optional] Overrides the default document name of your document.
              </li>

              <li>
                <strong class="uicontrol">keep-intermediate</strong>: [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.
              </li>

              <li>
                <strong class="uicontrol">show-delete-icon</strong>: [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.
              </li>

              <li>
                <strong class="uicontrol">show-download-guidance</strong>: [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.
              </li>

            </ul>
          </td>

        </tr>
      </tbody>
    </table>