How are the htmpl files and xml files in the 'tagged' folder used?

Document ID : KB000050476
Last Modified Date : 14/02/2018
Show Technical Document Details

Description:

This document explains how the htmpl files and xml files that are in the following folders are used:

$NX_ROOT\bopcfg\www\htmpl\web\analyst\xml\*.xml
$NX_ROOT\bopcfg\www\htmpl\web\analyst\tagged\*.htmpl

Solution:

These files are used for localization by the Configure tool, pdm_configure.

When run, pdm_configure checks the tagged folder and the xml folder. Based on the content of these folders, it may regenerate the htmpl files that exist in the subfolders under the $NX_ROOT\bopcfg\www\htmpl\web folder, such as the analyst, customer and employee folders.

For example, Figure 1 below shows the detail_in.xml and detail_in.htmpl files in an installation. pdm_configure uses detail_in.xml in the xml folder to determine how it should translate values in the htmpl file in the tagged folder. The result is an htmpl file that includes the translated values.

In the example, line #13 in the detail_in.xml file contains the string: "$args.ref_num Incident Detail" and line #25 in the detail_in.htmpl contains the strings: "$args.ref_num Incident Detail" and "<PDM_I18N>". When run, pdm_configure gets the value from the xml file and uses it with the corresponding tagged htmpl file to generate the resulting htmpl file in the bopcfg\www\htmpl\web\analyst folder.

Figure 1. detail_in.xml and detail_in.htmpl files

Figure 1

The generated htmpl file is given the same timestamp as the newer of the two source files: detail_in.htmpl in the tagged folder or detail_in.xml in the xml folder. The timestamp does not get set to the date and time that you run pdm_configure.

If you have customized any of the xml files or tagged htmpl files, be sure to take a backup of your customizations before applying any patches because some patches may replace these files and when pdm_configure is subsequently run, the htmpl in the resulting directories is then also replaced.

NOTE: It is necessary to modify the config.properties file on the environment to set resources.created=0. This file is located under the CA Service Desk Manager installation directory in the site subdirectory. If this parameter is not set, the htmpl re-generation process will be skipped.