Create a Custom Generate Document Button

Generate documents from any object such as a contract, order, quote, work order, or opportunity by integrating Omniscript into a custom button. This example uses the fndSingleDocxLwc Omniscript to generate single client-side documents from Microsoft Word .docx or Microsoft PowerPoint .pptx templates.

1. Retrieve Lightning URL from the fndSingleDocxLwc Omniscript.
   1. Open the fndSingleDocxLwc Omniscript.
   2. From the Actions dropdown list, click How to Launch.
   3. Scroll to Lightning, and then copy the URL starting from /lightning/cmp/omnistudio.
      

      Here's an example.

      /lightning/cmp/omnistudio__vlocityLWCOmniWrapper?c__target=c:docGenerationSampleFndSingleDocxLwcEnglish&c__layout=lightning&c__tabIcon=custom:custom18

   4. Click Done.
2. Create a custom Generate Document button.
   1. In Setup, click Object Manager.
   2. Click the object for which you want to create the custom Generate Document button. For example, Work Order.
   3. Click Buttons, Links, and Actions.
   4. Click New Button or Link.
   5. Enter these details:

      • Label: Generate Document

      • Name: Generate_Document

      • Display Type: Detail Page Button

      • Behavior: Display in new window

      • Content Source: URL

      • Button or Link URL: Paste the Lightning URL that you copied from the fndSingleDocxLwc Omniscript.

      
   6. Save your work, and then click OK.
   7. To add the template type as a parameter, enter &c__TemplateType=MicrosoftWord at the end of the URL.
      Here's an example.

      /lightning/cmp/omnistudio__vlocityLWCOmniWrapper?c__target=c:docGenerationSampleFndSingleDocxLwcEnglish&c__layout=lightning&c__tabIcon=custom:custom18&c__TemplateType=MicrosoftWord

   8. To add the Object ID as a parameter, at the end of the URL, enter &c__ObjectId=.
   9. From the Insert Field dropdown list, select the object work ID to add the custom Generate Document button to your object. For example, Work Order ID.
      The object work ID parameter is added to the URL.

      Here's an example.

      /lightning/cmp/omnistudio__vlocityLWCOmniWrapper?c__target=c:docGenerationSampleFndSingleDocxLwcEnglish&c__layout=lightning&c__tabIcon=custom:custom18&c__TemplateType=MicrosoftWord&c__ObjectId={!WorkOrder.Id}

      

      Note During the document generation process the work ID parameter is replaced with an actual work ID.
   10. Save your work.
3. Add the Generate Document custom button to the object.
   1. In Setup, click Object Manager.
   2. Click yourobject > Page Layouts > yourobjectLayout > Buttons.

      For example, Work Order > Page Layouts > Work Order Layout > Buttons.

   3. Select Generate Document, and then drag it to the Custom Buttons section.
      

      The Generate Document custom button is added to the Actions menu.

   4. Save your changes.

      You can now directly generate documents from your object by using the Generate Document custom button.

4. Generate the Microsoft Word .docx document.
   1. On your object page, from the Actions dropdown list, click Generate Document.

      The fndSingleDocxLwc Omniscript is triggered. The Object ID and Template Type fields are populated by default.

      
   2. Click Next.
   3. Select a template, and then click Next.
      

      Note

      To hide the Pick a template window and to customize the fndSingleDocxLwc Omniscript, see Customize fndSingleDocxLwc Omniscript.

   4. Select the generation options, and then click Next.
      

      The document is generated.

      

      You can download the .pdf and .docx version and attach the appropriate object record or email it.