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.
Did this article solve your issue?
Let us know so we can improve!
Loading
Salesforce Help | Article
Cookie Consent Manager
General Information
Required Cookies
Functional Cookies
Advertising Cookies
General Information
We use three kinds of cookies on our websites: required, functional, and advertising. You can choose whether functional and advertising cookies apply. Click on the different cookie categories to find out more about each category and to change the default settings.
Privacy Statement
Required Cookies
Always Active
Required cookies are necessary for basic website functionality. Some examples include: session cookies needed to transmit the website, authentication cookies, and security cookies.
Functional Cookies
Functional cookies enhance functions, performance, and services on the website. Some examples include: cookies used to analyze site traffic, cookies used for market research, and cookies used to display advertising that is not directed to a particular individual.
Advertising Cookies
Advertising cookies track activity across websites in order to understand a viewer’s interests, and direct them specific marketing. Some examples include: cookies used for remarketing, or interest-based advertising.