Introduction
The application populates a generated correspondence by retrieving the data values for the correspondence bookmarks. This process maps the bookmarks so the application populates them correctly.
When you are finished working with the correspondence, you can link it to the maintenance form so that users can generate it from that form (if your correspondence is online).
Prerequisites
-
The correspondence HTML file must already exist.
-
Any methods used to populate bookmarks must be added in the entity from which the user will generate correspondence.
-
The entity must have the necessary relationships: In this case, entOrder must have objCustomer as a one to one relationship and lstOrderDetails as a one to many relationship.
-
In the App Management option, Links option, Correspondence App Download, make sure that the system requirements and prerequisite are installed, and the Correspondence Application folder is downloaded.
-
Correspondence Service should be running.
|
Quick Steps |
| 1 |
Run the Correspondence Service, then open the Word template |
| 2 |
Enter the template, then save the template |
| 3 |
Synchronize the bookmarks |
| 4 |
Open the Data Fields tab, then map the Data Fields bookmarks |
| 5 |
Open the Tables tab, enter the Entity Field, and map the Tables bookmarks |
| 6 |
Open the User Fields tab, then add the fields |
| 7 |
Save the correspondence |
| 8 |
Open the maintenance form, then add a Correspondence button |
| 9 |
Save the form |
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. With the service running, open the correspondence you want to configure, open the More menu, and click the Open Word Template icon. Xelence automatically created this blank template when it created the correspondence HTML file.
Step 2. Enter the template, then save the template.
Enter the text you want the correspondence to have, including any bookmarks.
This example uses Data Field, Table, and User Field bookmarks.
To insert a bookmark into the template, select the Bookmark Type, enter the Bookmark Name, and click the Add button.
Step 3. Synchronize the bookmarks.
This pulls in all the bookmarks in the template so you can map them to their respective values.
Step 4. Open the Data Fields tab, then map the Data Fields bookmarks.
This example maps the columns to the data fields so that the application knows where to retrieve the values.
Enter the column in the Entity Field for each bookmark except PlanId. This is an automatic bookmark that always displays. If your correspondence doesn't use PlanId, you can skip it.
If the column comes from a parent entity instead of the correspondence entity, you need to call the object first. This example uses objCustomer for some bookmarks and the correspondence entity for others.
When the correspondence is generated, the application will insert whatever value is in the column mapped to Entity Field. In this example, it'll populate the value in the objCustomer Address column whenever it sees the Address bookmark.
If necessary, you can edit the other bookmarks properties, like Data Type.
To call an object, its entity must have a one-to-one relationship with the correspondence entity.
Step 5. Open the Tables tab, enter the Entity Field, and map the Tables Bookmarks.
This example maps the collection to the table, so the application knows where to retrieve the values.
Enter the Entity Field to map the collection to the bookmark.
For each table column, enter the entity column you want to use. This tells the application to populate that column's value in that table cell.
Step 6. Open the User Fields tab, then add the fields.
This example creates some fields for the user to fill in before they generate the correspondence.
Drag and drop the desired fields.
Step 7. Save the correspondence.
When you are finished mapping bookmarks, save the file.
Step 8. Open the maintenance form, then add a Correspondence button.
Open the correspondence's Active Form (or one of them). This was configured when the correspondence was created. This example uses the Order Maintenance form.
Drag and drop the Correspondence button from the toolbox to the top panel in the maintenance form. This button will enable users to generate the correspondence.
Step 9. Save the form.
Then, run the Preview. Xelence displays the form output. You can test your updated settings.
When you have previewed your form, it should look something like this:
The Correspondence button displays. The user can click the button to generate the correspondence.
If the user clicks the button, the application displays the Generate Correspondence window. The user can enter the user bookmarks information and generate the correspondence.
When the user has generated the correspondence, the application displays options to view or edit the correspondence (SagitecWinCorrEditor must be running if you want to test editing the correspondence).
If the user views the correspondence, the application displays the generated file with the configured bookmarks populated.
What are the improvements over S3 Version 6?
It is an identical process.
Related Articles
Create a Correspondence (Word Correspondence)
This post is part of the Word Correspondence topic. Click here to open the Word Correspondence Overview
#Communications
#WordCorrespondence
#Xelence