Prerequisites

• You need to be authenticated for merging to test documents. Follow our guide to ensure your org is set up for merging: Step 2: Setup Authentication and Permission Sets
• A template document will already need to be loaded onto your template record: Uploading a Template Document

Overview

To ensure a seamless merging experience, utilize the Debug button on your Template Documents to validate that they are accurate and error-free before making them available to your users. The Debug button allows you to run simulated merges on your new Template Document without needing to activate it, meaning you can find and correct any errors while your users continue to merge without interruption.

Steps

1. Navigate to the "Template Files" tab on a MergeUp Template record.

   

2. If not already done, upload a template file to be tested.

   

3. Click the "Debug" button. 

   

4. The Debug Template modal will be configured differently depending on whether the Template uses a Record Query or a General Query:

   • For Record Queries, select a record to test with.

     

   • For General Queries, you don't need to select any test data. The test data will be queried from the org automatically.

     

5. Click "Run Test"

6. On a successful test merge, you can review the merged document for errors using the "Download Test Run" button. You can also run another test by clicking the "Run Test" button again.

   

7. You can also view "Previous Test Runs" from the tab. From here, you can download and review any previous test runs, delete individual test runs, or clear all previous test runs with the "Delete all previous Test Runs" button.

   

Notes

• Test Run files are not attached to the records that you select to test with. Rather, the files are uploaded to the Template record and differentiated from the Template Files using the "MergeUp Template File Type" field on ContentVersion.
• Error messages are added to the document where the errors happened, using the same formatting as if the data had merged successfully.

Next Steps

• Learn how to merge your templates:

  • Using Merge Single Document LWC - Record
  • Using Merge Single Document LWC - General