Merge Maps

PDF Template Merge Maps are individual components used to include dynamic or programmatic data into your PDF - they are generally child records of your Label Template.

Merge Maps are referenced in the parent Label Template by placing the 'Merge map' value in ${handlebar} brackets.

For example, if you have a Merge Map with a 'Merge map' value of 'FIRST_NAME', you can insert it into your PDF Template by adding ${FIRST_NAME} to the 'HTML template' field of your PDF Template.

In most cases, you will create new PDF Template Merge Map records from the Related List on the Label Template form. This ensures they are properly linked to the parent Template.

Depending on the type of PDF Template Merge Map you create, you will find different options on the form.

Source Record Attribute

Source table: Table from which to derive the record attribute. (Note: This is pre-set to the 'Source table' on your parent Template and cannot be changed. If you need to reference a different table, use a 'Scripted' Merge Map.)
Source field: The field from which to derive the record attribute. Depending on the field type, you may choose a Value type specific to that field, such as Value, Display Value, Currency String, etc.

Static

Static text: Static text to display. This type of Merge Map can be useful when reusing a static piece of text in multiple PDF locations, but you wish to edit it in a single location.

HTML

HTML text: Similar to 'Static', but with rich-text capabilities.

QR/Barcode

Barcode generator: Embed a Barcode Generator into your PDF.

When using a barcode label within a label Template, you can either:

Design the entire label & all content as a Barcode Generator and then embed the entire Generator in the label. This is generally best for simple labels.

Create a Barcode Generator with a single Barcode Part that is the barcode or QR code component, and then use the label Template to add additional content. This is generally best for more complex label layouts.

Pre-Defined

Pre Defined Map: Merge Map records can be predefined via the Yansa PDF Generator -> Merge Maps -> Pre-Defined Merge Maps module in the left nav. This can be useful to create a Merge Map once and then reuse it in multiple PDF Templates. Pre-Defined Maps can be of any type: Source Record Attribute, Static, HTML, QR/Barcode, or Scripted.

Scripted

Script: Server-side script allowing you to return any custom content you desire. The source table record ('current') is available. This can be useful to reference dynamic data that is related to the source table record, but unavailable on the source table record itself. This can also be useful to include dynamic data such as date/time content that needs to be generated at the time the PDF is created.

PreviousPrinting Labels NextData Sources

Last updated 19 days ago