Mail Merge templates are Word documents with elements for dynamic content. Their purpose is to generate letter with dynamic content that gets populated from Rules or other sources. The dynamic elements in these templates are called Placeholders. The Word documents need to be in Windows 2007 or 2010 format. Read the the Designing a template for instructions on creating a new template.

Creating template folders

It's convenient to categorize your Mail Merge Templates using a folder structure.

  1. Open Environment's Setup of your solution's environment.
  2. From the left menu, select Letter Templates -> Mail Merge Templates
  3. Right-click on either the  AppBase node or an existing  folder node and select the New Folder menu item.
  4. A white text field appears, enter a meaningful name for it and press the Enter key.

Cloning folders

Cloning the folder copies all the sub folders and Mail Merge Templates into a new folder.

  1. Open Environment's Setup of your solution's environment.
  2. From the left menu, select Letter Templates -> Mail Merge Templates
  3. Right-click on either the  AppBase node or an existing  folder node and select the Clone Folder menu item. The Add Similar popup appears.

  4. Enter the properties as follows:

    PropertyDescription
    New NameEnter a meaningful names. This name can be displayed when you let your users select the template they want to use.
    API Permanent IDThis field is automatically prepopulated and needs to be unique across all Mail Merge Templates in your environment.
  5. Click Clone
Editing folder name
  1. Open Environment's Setup of your solution's environment.
  2. From the left menu, select Letter Templates -> Mail Merge Templates
  3. Left-click three times on the name of a folder node you want to edit. 
  4. A white text field appears, enter a meaningful name for it and press the Enter key.

Deleting a folder

Deleting a folder will delete all it's sub folders and all their containing Mail Merge Templates.

  1. Open Environment's Setup of your solution's environment.
  2. From the left menu, select Letter Templates -> Mail Merge Templates
  3. Right-click on either the  AppBase node or an existing  folder node and select the Delete menu item.
  4. A confirmation message will appear, click Yes.

New Mail Merge Templates

Mail Merge Templates are Microsoft Word documents. 

  1. Open Environment's Setup of your solution's environment.
  2. From the left menu, select Letter Templates -> Mail Merge Templates
  3. Right-click on either the  AppBase node or an existing  folder node and select the New Template menu item. The New Letter Template popup appears.

  4. Enter the letter template properties as follows:

    PropertyDescription
    Template NameEnter a meaningful names. This name can be displayed when you let your users select the template they want to use.
    API Permanent IDThis field is automatically prepopulated and needs to be unique across all Mail Merge Templates and Email Templates in your environment.
    Word UploadSelect a Microsoft Word document. The Designing a template page has instructions on creating Mail Merge compatible Word documents.
  5. Click Save
  6. The View Letter Template page displays. Go to the Placeholders tab.
  7. Double click a Placeholder's Bookmark cell and map it to an existing Bookmark. A Placeholder does not require a Bookmark, you can leave the cell empty and have the content be determined manually every time the document get generated. More about that is explained below.

Cloning a template

  1. Open Environment's Setup of your solution's environment.
  2. From the left menu, select Letter Templates -> Mail Merge Templates
  3. Select the folder where your template is.
  4. On the right side next to the Name of the template, click the Clone button.

  5. Enter the properties as follows:

    PropertyDescription
    New NameEnter a meaningful names. This name can be displayed when you let your users select the template they want to use.
    API Permanent IDThis field is automatically prepopulated and needs to be unique across all Mail Merge Templates in your environment.
  6. Click Clone

Editing an template's fields and body

  1. Open Environment's Setup of your solution's environment.
  2. From the left menu, select Letter Templates -> Mail Merge Templates
  3. Select the folder where your template is.
  4. Click on the  Edit button next to the template you want to modify. The Edit Letter Template pop up displays.
  5. Update the Modify Bookmark Edit Letter Template pop up.
  6. Click Save.

Editing a template's placeholders

  1. Open Environment's Setup of your solution's environment.
  2. From the left menu, select Letter Templates -> Mail Merge Templates
  3. Select the folder where your template is.
  4. Click on the template's name (blue link) whose placeholders you want to manage. The View Letter Template page displays.
  5. Go to the Placeholders tab and update them.
  6. Click Save.

Using this feature

The most common way to use this feature is from a page by making an AJAX request. You can also call this service from a rule using WCF. 

JavaScript Example

Text

CURL Example

Text

WCF Example

Text