Merge_Parameters

Overview

This class defines the parameters and options used to generate a single merged document in MergeUp.

A Merge_Parameters instance encapsulates all configuration required to control a merge operation, including the template to use, data scope, output file properties, localization settings, and document delivery behavior. These parameters determine how data is queried, formatted, and applied during the merge, as well as how and where the resulting document is stored.

Constructors

global Merge_Parameters()

Default constructor. Initializes the class.

Fields

global templateId → Id

The Id of the MergeUp Template record that will be used for the merge.

global recordId → Id

The Id of the record where the merged document will be uploaded and that any record type queries will be based on. Note that the object type must match the object type of the template's Template Group when using a Record Template.

global recordIds → List<Id>

A list of record IDs used to restrict the results of General Queries defined in the template. Only records whose IDs match the specified values are included in the query results. IDs from multiple sObject types are supported and are applied to the corresponding General Queries for each sObject type.

Behavior

• This parameter does not support multiple General Queries for the same sObject. An error is thrown if a provided ID could apply to more than one General Query.
• Any WHERE clauses on applicable General Queries are ignored when this parameter is specified; filtering is determined solely by the provided record IDs.

• By default, the merged document is saved to the running user’s Files and is not associated with any record, folder, or library.
  

  • To attach the document to a specific record or library, specify altUploadRecord.

global fileName → String

The name that will be given to the merged template. Defaults to the file name defined on the template.

global fileType → String

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.

global dateLocale → String

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.

global numberLocale → String

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.

global defaultCurrency → String

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

global timeZone → String

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.

global altUploadRecord → Id

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

global options → String

If provided, then these additional parameters will be used instead of what is defined on the Template Additional Parameters field.