Flow Actions

Generate Document (Sync)

Introduction

The CloudFiles: Generate Document (Sync) action operates synchronously, providing immediate outputs after execution. This differs from the asynchronous Generate Document action, which publishes a Document Generated CloudFiles Event without immediate results.

This synchronous action allows you to seamlessly integrate document generation into synchronous flows requiring real-time execution, offering greater flexibility in automation.

Like the asynchronous action, this feature also enables automated document creation within Salesforce Flow Builder. Instead of manually selecting templates and generating documents via the CloudFiles Doc-Gen LWC on a Record Detail page, it streamlines the process based on specific triggers and criteria set in your flow.

Below is how the action looks like. Detailed descriptions of the input and output parameters are provided in the following section.

Document image




What This Action Does

The CloudFiles: Generate Document (Sync) flow action automates document creation using predefined templates and criteria set within Salesforce Flow Builder.

  • Document Generation:
    • Creates documents in PDF or DOCX format based on specified parameters.
    • Supports dynamic template assignment (e.g., based on record type or decision logic).
  • Storage Options:
    • Save the generated file in Salesforce by:
      • Linking it to a specific record as a content document.
      • Placing it in a designated file library.
    • Store the file in external storage when using the package with the CloudFiles | Document Management & Sharing Platform
  • Dynamic Variables:
    • Insert placeholders into templates for dynamic content.
    • Assign values to these variables within the flow (e.g., user name, dates).
  • PDF Security Features:
    • Configure advanced security options for PDFs, such as:
      • Allowing/disallowing printing or form field editing.
      • Locking the document for edits.
      • Setting an owner password or a view password.

Example Use Case:

Automatically generate a contract in PDF or DOCX format from a dynamically assigned template (e.g., based on record type). The contract:

  1. Includes dynamic variables like the user's name.
  2. Is locked for edits and protected with an owner password.
  3. Is saved in a specified location, such as a Salesforce File on the Opportunity record or in the dedicated Opportunity's external storage folder.

This action simplifies document generation while providing flexibility and control over content and security.

Input Parameters

Here is a list of all input parameters with a summary. For details, check out the individual sections below:

  1. CloudFiles Variables: Pass custom runtime variables and edit the fields.
  2. Destination: Information specifying where the generated template/document will be stored.
  3. Document Type (docx/pdf): The type of document to be created, either PDF or DOCX.
  4. Parameters: Parameters for editing the document, such as password protection, locking, or printing permissions.
  5. Record ID: The record ID of the object for which the document is to be generated, such as “Triggering Account > Account ID”.
  6. Template: The newly created resource, such as “TemplateId” in the example shown in Document Generation using CloudFiles.

Cloudfiles Variables

The CloudFiles Variables parameter allows you to input values for custom runtime variables used in templates. This feature supports dynamic document generation by enabling flexible data assignment at runtime.

Steps to Configure CloudFiles Variables Input Parameter

  1. Create Resources for Runtime Variables:
    • Create a new Apex-Defined Variable of the Apex class cldfs_CloudFilesVariable for each runtime variable you want to use.
    • Each variable includes two fields:
      • Key: The API name of the runtime variable (retrieved from the "Resources" section in the Template Builder).
      • ValueString: The value to be assigned to the variable.
  2. Assign Key-Value Pairs:
    • Use an Assignment Element in your flow to populate the runtime variables:
      • Set the Key to the API name of the runtime variable from the MS Word, Excel, or PowerPoint template.
      • Assign the desired ValueString.

      • 

        Document image
        
  3. Build a Collection Variable:
    • Create a Collection Variable of the same Apex class (cldfs_CloudFilesVariable).
    • Add all the configured individual runtime variables to the Collection Variable.

    • 

      Document image
      
  4. Input the Collection in the Action:
    • Input the Collection Variable into the CloudFiles: Generate Document (Sync) action's CloudFiles Variables paramter.

This configuration enables dynamic assignment of variables, ensuring document outputs are flexible and tailored to meet specific requirements. Runtime variables can personalize templates, automate complex workflows, and support highly customized document generation scenarios.

Destination

The Destination parameter determines where the generated document will be stored after CloudFiles completes the document generation process.

Steps to Configure Destination:

  1. Create an Apex-Defined Variable of Apex Class cldfs__Resource

    1. 

      Document image
      
  2. Assign the necessary metadata (e.g., Library, DriveId, Id) based on the chosen storage option.
  3. To Save in Salesforce
    • Default Behavior (Salesforce Files):
      • If no destination parameter is specified, the file is stored in the Salesforce File Library.
    • Link to a Specific Record:
      • Assign the following fields:
        • Library: Set to salesforce.
        • Id: Set to the RecordId of the Salesforce record to which the file will be linked.

        • 

          Document image
          
  4. To Store in External Storage
    • When using CloudFiles with the CloudFiles | Document Management & Sharing Platform:
      • Assign the following fields to define the external storage location:
        • Library: Specify the library name.
        • DriveId: Specify the ID of the connected drive.
        • Id: Specify the ID of the folder or location within the drive.

        • 

          Document image
          
  5. Pass the configured variable as the Destination Parameter in the CloudFiles: Generate Document (Sync) action.

    1. 

      Document image
      

This setup provides flexibility to store files in Salesforce or external storage, aligning with your business needs.

Document Type (docx / pptx / xlsx / pdf)

The Document Type parameter specifies the format of the file to be generated based on the chosen template.

  • docx:Generates a file using the MS Word Template in .docx format.
  • pptx:Generates a file using the MS PowerPoint Template in .pptx format.
  • xlsx:Generates a file using the MS Excel Template in .xlsx format.
  • pdf:Generates a file in .pdf format, using any MS Word, PowerPoint, or Excel Template.

Select the appropriate type based on your requirements and the template used.

Record ID

The Record ID parameter specifies the Salesforce record to be used as the data source for generating the document. The document is created based on the data from this record and the predefined template. Provide the Record ID of the object for which the template was designed (e.g., Opportunity, Contact, or Custom Object).

Parameters

The Parameters input allows you to configure advanced security features for the generated PDF documents.

Steps to Configure:

  1. Create an Apex-Defined resource of Apex class cldfs_DocGenParamsin the flow.

    1. 

      Document image
      
  2. In an Assignment element:
    1. Assign the Variable's fields.
    2. Set the desired parameters to $GlobalConstant.True or $GlobalConstant.False.
    3. If no value is set, parameters default to false.

    4. 

      Document image
      
  3. AllowFillingPdfFormFields: Enables users to fill out form fields in the PDF if the template includes them. ( Options: TRUE or FALSE )
  4. AllowPdfPrinting: Permits printing of the generated PDF. ( Options: TRUE or FALSE )
  5. LockPdf: Locks the PDF to prevent any edits.( Options: TRUE or FALSE )
  6. PdfOwnerPassword: Specifies an owner password to restrict editing access to those with the password. Enter the password as a string value.
  7. PdfViewPassword: Specifies a view password to restrict viewing access to those with the password. Enter the password as a string value.

Use these parameters to customize the security settings of the generated PDF based on your requirements.

Template

Input the 24-Digit CloudFiles "TemplateId" of a published Template can be found in the CloudFiles App under the Document Generation Tab. This ID is essential for identifying and using the correct template for document generation, ensuring that the documents are formatted and populated as intended based on the specified template.

Document image


Output Parameters

The CloudFiles: Generate Document (Sync) action provides immediate outputs, accessible in the flow's All Resources.

Document image


Below are the 4 output parameters and their details:

Document

  • This Output paramter specifies the metadata details of the generated file.
  • This parameter is populated only if the Destination input parameter is configured. If not, it will be null.

Field Details:

  • When saved in Salesforce and linked to a record:
    • id: The generated file's Content Document ID.
    • library: salesforce.
    • Other fields will be null.
  • When saved in external storage:
    • Contains metadata details of the file stored in the external storage.

Content Version Id

  • If no Destination parameter is specified, the file is stored in the Salesforce File Library.
  • This parameter holds the Content Version ID of the generated file in Salesforce.

Document Name

The name of the generated document.

Download Url

A dynamic URL to download the generated file.





PREVIOUS
Generate Document
NEXT
Generate Document (Batch)
Docs powered by Archbee