Generate Document (Sync)

introduction the cloudfiles generate document (sync) action operates synchronously, providing immediate outputs after execution this differs from the asynchronous generate document docid\ qfdwhv81mxgwsly7nppsc 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 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 includes dynamic variables like the user's name is locked for edits and protected with an owner password 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 cloudfiles variables pass custom runtime variables and edit the fields destination information specifying where the generated template/document will be stored document type (docx/pdf) the type of document to be created, either pdf or docx parameters parameters for editing the document, such as password protection, locking, or printing permissions record id the record id of the object for which the document is to be generated, such as “triggering account > account id” 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 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 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 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 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 create an apex defined variable of apex class cldfs resource assign the necessary metadata (e g , library, drive id, id) based on the chosen storage option 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 record id of the salesforce record to which the file will be linked 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 drive id specify the id of the connected drive id specify the id of the folder or location within the drive pass the configured variable as the destination parameter in the cloudfiles generate document (sync) action 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 create an apex defined resource of apex class cldfs docgenparams in the flow in an assignment element assign the variable's fields set the desired parameters to $globalconstant true or $globalconstant false if no value is set, parameters default to false allowfillingpdfformfields enables users to fill out form fields in the pdf if the template includes them (options true or false) allowpdfprinting permits printing of the generated pdf (options true or false) lockpdf locks the pdf to prevent any edits (options true or false) pdfownerpassword specifies an owner password to restrict editing access to those with the password enter the password as a string value 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 " template id " of a published template which can be found in the cloudfiles app under the document generation t ab 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 output parameters the cloudfiles generate document (sync) action provides immediate outputs, accessible in the flow's all resources 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 i d the generated file's content document id l ibrary 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