Utilize the Field Map feature to automatically sync incoming data to your document fields or modify the data values before being merged into your document.
What is Field Map?
Turn on Field Map
Customize the Field Map
Common Use Cases
What is Field Map?
Field Map is a data manipulation layer that takes place before we use your data to populate the merge document(s). Within this feature you can use any of the field modifiers, conditional statements, loops, or other allowed PHP functions. Field Map can be used to alter data points, combine data points, add to data, create new fields, etc. It's advised to only use this feature if you understand how it will alter your data.
Turn on Field Map
Step 1: Navigate to the Settings tab, select "Advanced Settings."
Step 2: Choose Use Field Map for custom integrations from the options.
Step 3: Click "Save Settings" and you'll see a new Field Map tab to customize.
Customize the Field Map
Within the Field Map tab, all fields within your document, settings, and deliveries are listed. Below are some examples of how you can modify existing fields and combine fields to make cleaner data. (If you're working with an external data source, where you cannot customize the variable names, you can align your external variables with your document merge tags.)
Common Use Cases
A common use case is for fillable PDF documents that generally have an unusual naming scheme in their field names. If you use a Webhook that doesn’t allow you to customize the variable names which are used, the Field Map can use the configured fillable PDF fields and indicate what the variable names from your Webhook will be.
Another common use case is to modify a field value or format. If you have a field that needs a modifier, and perhaps you need to print it often in your document, you can place the modifier on the field inside of Field Map. This eliminates the need to place the modifier on every instance of this merge field.
Converting strings into object-arrays is another use case. At times you'll have data structured as an object or array come through as a string. Read more about this process in this article.
Another common use case is using the Field Map tool for extracting specific properties from objects that are being sent across integrations, like Salesforce. For example, you have an invoice document and you want to print contact information for a lead in Salesforce. You could merge each individual property on the lead object; however, you could also create a new {$Lead} merge field in the mapping and reference the specific properties you wish to merge into the document by using dot notation. This method particularly comes in handy when using fillable PDF templates, which cannot handle dot notation like Word or Document Builder template types can.
Once saved, you will now see a new Lead merge field in your Salesforce mapping. From there, you can send the entire object across instead of specific properties: