Mail Merge with Record Builder

The Mail Merge Record Action Builder retrieves a mail merge template from the database and merges with one record.


Select the record type that will be merged with the template.


Choose the variable that will contain the record id to be merged.


Select the Document Object Type that will contain your template.


The Template Criteria will be used to ascertain what document to be retrieved.


Values can be passed into Criteria by creating a parameter.

By enclosing a value in { } brackets, that flags the word as a parameter. The name of the parameter, in the picture, would be documentName.

Parameters will have the value substituted during the script execution.


If parameters are found in the Criteria, they wil be listed in the Name drop down.

Name – the name of the parameter within the criteria.

Type – type of value to be expected (String, Bool, Date, Decimal, Number).

Variable – the variable that will hold the value. The drop down will contain existing variables or type in a new variable name.

Click the Add button to add the parameter name and value to be substituted.



Click Yes to save the document as a Pdf.

File Path – the variable that will hold the path to the new document file. Note: this variable needs to be set before this point in the script.

Deleting the File Path variable name will bypass the saving file portion of the script.


Selecting Yes will send the document contents to the default printer.

Created Script


Get Record Data – retrieves a record, from the database, using the ID.

Add Text Criteria Parameter – maps a Criteria Parameter to a value to be substituted with.

Find Record By Criteria – retrieves the first record, in the database, that matches a Criteria and sets that record to a variable.

Get Record Content – gets the document content from the record.


New Document Item – creates a new DocumentItem and sets that to a variable.

Set DocumentItem Content – sets the newly created DocumentItem content to the record content variable.

Document Record Mail Merge – generates the mail merge record with template.

Save Document File – takes a path and saves the final mail merge contents to that path.

Print Document – sends the final mail merge content to the default printer.