How are the HTMPL files and XML files in the NX_ROOT\BOPCFG\WWW\HTMPL 'tagged' folder used?

book

Article ID: 50476

calendar_today

Updated On:

Products

CA Service Management - Service Desk Manager CA Service Desk Manager

Issue/Introduction

This document explains how are the HTMPL files and XML files in the NX_ROOT\BOPCFG\WWW\HTMPL 'tagged' folder used.

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

Environment

Service Desk Manager 12.x, 14.x and 17.x
All Supported Operating Systems

Resolution

These files are used for localization by the Service Desk Manager 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, the image below shows the detail_in.xml and detail_in.htmpl files. The pdm_configure program 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 NX_ROOT\bopcfg\www\htmpl\web\analyst folder.



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 pdm_configure is executed.

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 executed, 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 NX_ROOT\site directory. If this parameter is not set, the HTMPL re-generation process will be skipped.

Attachments