How to Use Merge Field Variables
  • 09 Jul 2024
  • 2 Minutes to read
  • Dark
    Light

How to Use Merge Field Variables

  • Dark
    Light

Article summary

This guide will accompany the Custom Document Template Module to show the user how to insert merge field variables into a custom document template.
Full List of Merge Field Variables: https://www.loantrackingsoftware.com/variables

Open your custom document template using Word and go to the Insert Tab and find the 'Field' option (Orange arrows in image) to insert a new merge field variable.
For MacOS

On Windows

Once you click the button the Field prompt will appear. You'll want to select Mail Merge under Categories and MergeField under Field names.
Once those are selected, the text field below will populate "MERGEFIELD" and you'll be able to enter your merge field variable namethere.
Note: You must enter merge field variable names (as well as UDF variables) using [Upper] Camel Case (Case-sensitive) wording with no spaces between words.
Example: ThisIsACamelCaseExample or UpperCamelCase, the first letter in each word/letter is capitalized. 

Note: For UDF merge field variables, between the colons (shown in the image below), you'll want to distinguish between UDF categories, since UDFs can be assigned as part of a Loan or a Contact. 

Below you'll see this is a UDF on a Loan, with the UDF's Title being 'Test UDF' with a space but in the MERGEFIELD entry you're required to enter 'TestUDF' with no spaces and UpperCamelCase as noted previously. 


Once you finish typing the merge field variable name, click 'OK'. You'll see this variable listed within 'carrots', <<BorrowerFirst>>

After that's done, you'll want to upload the finalized custom document you've created under the Admin tab.

If you've made edits to the document, you can also click the 'Update' button (right-hand options column) to re-upload the edited document as well. 

From there you'll want to go to a loan's Documents tab and click the 'Generate Document' button. 

On the next screen, we'll see the UDF value found a match and returned a result. 

Then you'll see it populated in the PDF/Word document downloadable files once it's been generated. 


How to Insert a Table Variable

The same as with other variables, reference the variables list and look for the table variable names. We will use the 'Schedule' and 'Amortization' schedule table variables in our example.
First, you'll want to insert 2x2 or 3x3 tables in your word document, then simply insert the table variable name by typing it in under row 1 column 1 (Shown below). 

From here, we can start generating the document and/or test. We get the following through a test:

_____________________
To view a list of the most current available merge field variables, click here.
Download custom document templates here.

Please let us know if you encounter any issues. If you'd like to request a new merge field variable please email the request to support@brytsoftware.com.


Developer Notes:
<< UDF:UDF Category (ex. Loan or Contact):UDFName (ex. OriginalClosingDate – concatenated & case-sensitive) >>