View Article

Introduction

There can be a business requirement to display certain value(s) from the entity data column on the generated correspondence. For this, you must use a Field Bookmark and map it with that entity field.

For this, you must ensure that the entity is correctly configured and has the necessary relationships. Also, the entity fields mapped to the bookmarks must be loaded before generating the HTML Correspondence.

Previously, a Microsoft Word document was required and the Business Tier had to be run before correspondence generation. But, now, the Business Tier is taken care by framework. Also, the process is made simple and a correspondence file, bookmarks, and their mapping to the associated entity field, rule or method is only required.

Prerequisites

• The HTML Correspondence file must already exist.
• The entity should be correctly configured.
• The entity must have the necessary relationships: in this case, entOrder must have objCustomer as one to one relationship.
• The entity fields mapped to the bookmarks must be loaded before generating the HTML Correspondence.

Detailed Steps

Step 1. Open the HTML Correspondence.

This is the existing Correspondence file hcrOrderSummary. The file is nearly blank. You are going to insert some field bookmarks and map them.

Step 2. Insert a Field Bookmark.

This is the bookmark you’ll be adding in the HTML Correspondence file. From the Bookmarks section, select the Field Bookmark. You can either double click on it or simply drag and drop it in the HTML Correspondence file.

Step 3. Enter the details, then click Add.

The important properties are:

• Bookmark Type: This drop-down enlists all the Bookmarks available to be inserted in the Correspondence file. In this example, Field Bookmark populates automatically.
• Bookmark Field: Name of the entity field associated with the bookmark.
• Rule ID: Programmatic ID of the rule that loads the data in the bookmark.
• Entity Method: Programmatic ID of the method that loads the data in the bookmark.

Before mapping the fields, make sure entOrder is correctly configured and it has one to one relationship with objCustomer.

Step 4. Repeat step 2 and 3 to add more field bookmarks, if desired.

Step 5. Save the HTML Correspondence file.

It will save the HTML Correspondence file.

The HTML Correspondence generates with the field bookmarks populated.

What are the improvements over S3 Version 6?

Previously, a Microsoft Word document was required and the Business Tier had to be run before generating the correspondence. Now, with Xelence, the process is made simple. The business tier is taken care by framework and the correspondence file, bookmarks and mapping them to the associated entity field, rule or method is only required.

Related Articles

Create a HTML Correspondence file

 

This post is part of the HTML Correspondence topic. Click here to open the HTML Correspondence Overview

#Xelence

#HTMLCorrespondence

#Communications