Overview

Automation in Salesforce plays a pivotal role in boosting productivity, and Apex is a key driver of this efficiency. MergeUp simplifies document generation by incorporating built-in Apex merging functions. These functions enable you to automate and streamline your processes, ultimately saving you valuable time.

Syntax

mergeup.Merge_Parameters parameters = new mergeup.Merge_Parameters();

parameters.templateId = templateId;
parameters.recordId = recordId;
parameters.fileName = fileName;
parameters.fileType = fileType;
parameters.dateLocale = dateLocale;
parameters.numberLocale = numberLocale;
parameters.defaultCurrency = defaultCurrency;
parameters.timeZone = timeZone;
parameters.altUploadRecord = altUploadRecord;

mergeup.Merge_Response res = mergeup.Api_Utils.mergeDocument(parameters);

Parameters

Merge_Parameters

• templateId:

  • Type: Id
  • Description: The Id of the Template record that will be used for the merge. This is required.

• recordId (optional): 

  • Type: Id
  • Description: The Id of the record where the merged document will be uploaded and that any record type queries will be based on.

• fileName (optional): 

  • Type: String
  • Description: The name that will be given to the merged template. Defaults to the file name defined on the template.

• fileType (optional): 

  • Type: String
  • Description: The file type that will be given to the merged template. Valid options are 'docx' and 'pdf'. Defaults to the file type defined on the template.

• dateLocale (optional): 

  • Type: String
  • Description: The date locale that will be used to format dates and datetimes. Defaults to the organization locale, unless an override is specified on the template.

• numberLocale (optional): 

  • Type: String
  • Description: The number locale that will be used to format numbers, currencies, and percents. Defaults to the organization locale, unless an override is specified on the template.

• defaultCurrency (optional): 

  • Type: String
  • Description: The currency code that will be used to format currencies. Defaults to the organization default currency, unless an override is specified on the template.

• timeZone (optional): 

  • Type: String
  • Description: The time zone that will be used to format datetimes. Defaults to the organization default time zone, unless an override is specified on the template.

• altUploadRecord (optional): 

  • Type: Id
  • Description: If provided, the merged document will be uploaded to the Alternative Upload Record instead of the record defined for querying the data from.

Merge_Response

• fileId:

  • Type: String
  • Description: The Content Document Id of the merged document.

• mergeLogUpsertKey: 

  • Type: String
  • Description: Upsert key of the Merge Log associated with this merge.

• errorCode: 

  • Type: String
  • Description: Code associated with the error.

• errorMessage: 

  • Type: String
  • Description: Description of the error.

• completed: 

  • Type: Boolean
  • Description: Set to true if the merge has been completed; otherwise, it will be false if the merge is still in progress or failed.

Examples

The following example demonstrates the process of querying a template with an Account query and assigning it as the 'templateId.' Subsequently, it queries an Account and sets the Account's Id as the 'recordId.' This code is designed to merge a document for the queried record using the 'Account Template Test' template. The function returns an instance of the Merge_Response class, enabling you to access the file Id for the generated document and any error messages generated during the merge.

List<mergeup__Template__c> template = [SELECT Id FROM mergeup__Template__c WHERE Name = 'Account Template Test' LIMIT 1];
List<Account> acc = [SELECT Id FROM Account LIMIT 1];

mergeup.Merge_Parameters parameters = new mergeup.Merge_Parameters();

parameters.templateId = template[0].Id;
parameters.recordId = acc[0].Id;
// Set any other parameters as needed

mergeup.Merge_Response res = mergeup.Api_Utils.mergeDocument(parameters);

String returnedId;
String errors;

if(res.completed){
    returnedId = res.fileId;
} else {
    errors = res.errorMessage;
    // You can query the MergeUp Merge Log to check if the merge is still pending
    List<mergeup__Merge_Log__c> mergeLog = [SELECT mergeup__Status__c FROM mergeup__Merge_Log__c WHERE mergeup__Upsert_Key__c = :res.mergeLogUpsertKey];
    if (mergeLog.mergeup__Status__c == 'Queued') {
        // Handle pending merge according to your needs
    }
}
// Implement your logic to handle the returnedId or errors according to your needs

Notes

• The "mergeup__" and "mergeup." prefixes are needed because the code is inside of a managed package.
• You must create a MergeUp template before you can query them, as well as have permissions.
• If you are receiving errors from the MergeUp API, look up the error code you are receiving in our guide for Resolving Common Errors.
• It's essential to stay informed and keep your configuration up-to-date with MergeUp's updates and changes to ensure the continued smooth operation of your code.