Overview

Utilizing a flow can significantly enhance and simplify your document generation process by automating tasks and reducing manual clicks. MergeUp provides two built-in Flow actions for document merging:

• Merge Document: Best when the flow will submit 10 or fewer merge requests in the same transaction and you want the merge result returned immediately.
• Merge Document (Async): Best when a bulkified flow transaction may submit more than 10 merge requests or when the flow can poll for completion later.

For detailed instructions on creating flows, please refer to Salesforce's flow documentation here: Create or Modify a Flow (salesforce.com). The example below shows a record-triggered flow that generates a document on an Opportunity when the Stage changes.

Choosing the Right Action

• Use Merge Document when the current transaction will submit 10 or fewer merge requests.
• Use Merge Document (Async) when the flow may submit more than 10 merge requests in one transaction, such as a bulkified record-triggered flow.
• Use Merge Document (Async) when you want one MergeUp Batch for the whole invocation and plan to monitor the related Merge Logs or MergeUp Batch after submission.

Input Parameters

Both Flow actions accept mergeup__Merge_Parameters. For the complete and maintained field list, see the Merge_Parameters article.

Output Parameters

Merge Document returns mergeup__Merge_Response. For the complete and maintained field list, see the Merge_Response article.

Merge Document (Async) returns mergeup__Merge_Async_Response. For the complete and maintained field list, see the Merge_Async_Response article.

Examples

The following example shows a record-triggered flow that merges a document on an Opportunity when the Stage equals "Proposal/Price Quote".

1. Create your flow. In this example, we will create a record-triggered flow.

   

2. The Configure Start panel will open. Select "Opportunity" as the object and "A record is updated" for the "Trigger the Flow When" section.

   

3. Scroll down and set "Condition Requirements" to "All Conditions Are Met (AND)". Then configure the record's Stage field, the equals operator, and your desired value. In this example, we use "Proposal/Price Quote".

   

4. Select "Only when a record is updated to meet the condition requirements" in the "When to Run the Flow for Updated Records" section. Also make sure "Actions and Related Records" is selected in the "Optimize the Flow For" section.

   

5. Select "Include a Run Asynchronously path to access an external system after the original transaction for the triggering record is successfully committed." This is required for record-triggered flows that call MergeUp merge actions.

   

6. Click "Done".

7. Your flow will split into two paths. Click the "+" symbol on the "Run Asynchronously" path and select the "Action" node.

   

8. When the New Action dialog appears, search for the "Merge Document" action and select it. If your flow may submit more than 10 merge requests in the same transaction, select "Merge Document (Async)" instead.

   

9. Fill out the following information for the Action.

   • Label: "Merge a Document"
   • API Name: "Merge_a_Document" (this will fill automatically)
   • Record Id: "{!$Record.Id}"
   • Template Id: The Id of the Template you want to merge
10. Click "Done".
11. Debug and test to verify the flow works as expected. You can then save the flow and activate the current version.

Notes

• The MergeUp merge actions must be put in the asynchronous path of record-triggered flows since they contain a callout.
• The synchronous Merge Document action supports up to 10 merge requests per transaction.
• For larger bulkified transactions, use Merge Document (Async) and monitor the related Merge Logs or MergeUp Batch after submission.

Next Steps

• Using Merge Document (Async) in Flows
• MergeUp Global Configuration
• Using Quick Actions