View Article

Configure a Visible Rule Bookmark (Word Correspondence)

By Xelence Documentation posted 05-08-2024 03:21

  

Introduction

A visible rule bookmark determines the appropriate text to include in a correspondence based on the results of a mapped condition expression. In this example, a visible rule bookmark points to a visible rule that checks whether a field value is equal to “ORDR”. 

Prerequisites

  • The correspondence HTML file must already exist.
  • entOrder must have the desired expression.
  • Correspondence Service is running.
Quick Steps
1 Run the Correspondence Service, then open the Word template.
2 Update the template, then save the template.
3 Synchronize the bookmarks.
4 Map the non-rule bookmarks.
5 Open the Visible Rule tab and enter the Rule ID. 
6 Save the correspondence.

Detailed Steps

Step 1. Run the Correspondence Service, then open the Word template.

You must run the Correspondence Service in order to open the Word template. In this case, this is the existing correspondence file, corCustomerOrderSummary.


Step 2. Update the template, then save the template.

 In this example, visible rule bookmark displays one block of text if the value of OrderStatus is ORDR and another block of text if the value is not ORDR. 

Make sure the Order entity has the OrderStatus expression.
Add a new Visible Rule bookmark. The text does not indicate what result of OrderStatus will mean the condition is true, because that information is in the expression. (The rule evaluates to true when OrderStatus is ORDR). Select Visible Rule from the Bookmark Type drop down, enter the Bookmark Name, and click Add.
Add the blocks of text and bookmarks you want the correspondence to display based on the Visible Rule result. Save the template.


Step 3. Synchronize the bookmarks.

This imports the new template bookmarks you just added.


Step 4. Map the non-rule bookmarks.

Map any new bookmarks you added. This example added a new field bookmark.
 
In this example, the application will populate the value in the Orderstatus column whenever it sees the OrderStatus bookmark.


Step 5. Open the Visible Rule tab and enter the Rule Id.

You are going to map the visible rule bookmark to the Rule ID, so the application determines whether the condition is true or false by evaluating the rule to true or false.
 

Select the desired rule from the drop down list.


Step 6. Save the correspondence file.

When you are finished mapping bookmarks, save the file.

Then, run the Preview and generate the correspondence.

The user can generated correspondence should look something like this:​

The OrderStatus is ORDR, so the generated correspondence displays the text and bookmarks added in the 'if' section of the Visible Rule bookmark.


What are the improvements over S3 Version 6?

Previously, the expression was added to the Initial Load section of the entity. Now, the expression is directly added to the ‘Expressions’ tab in the entity. Also, multiple conditions with more than one attribute can be added. This is done as a part of process improvement.


Related Articles

Create a Correspondence (Word Correspondence)

Map Bookmarks and Link the Word Correspondence to the Maintenance Form

 

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


#Communications
#WordCorrespondence

#Xelence

0 comments
134 views