Customize Watchdoc WML keys and labels

June 2022

Prerequisites

Feature available in versions 5.4.1 and 5.5

Principle

It can happen that a customer wishes to modify the labels of the Watchdoc interfaces. These labels are saved as "keys" in WML files specific to each language (FR for French, GB for British English, IT for Italian, etc.).

For example, in the lang_webclient.en-EN.wml file, the key ACCOUNTSCREEN/ALLJOBS corresponds to the label "See the complete list..." and corresponds to the label "See the all list" in the lang_webclient.en-EN.wml file.

 

These files, saved in the "Data" folder of Watchdoc, are of 4 types:

  • Service : labels used by the Watchdoc service ;

  • Webclient : labels used by the Watchdoc administration interfaces ;

  • WES and WES V3 : labels used in the WES;

  • WESPhone : labels used in the WESphone.

Updating these files previously required a restart of Watchdoc.

Now, the update can be done by "overlaying" the most recent file. As soon as the file is modified, it is reloaded automatically, which saves time.

Procedure

The procedure varies depending on the situation.

This procedure must be applied on both master and other Watchdoc servers.

 

New client

 

  1. As an administrator, access the server where Watchdoc is hosted;

  2. Go to the Watchdoc label file storage folder (C:\Program Files\Doxense\Watchdoc\Data by default);



  3. locate the name of the .wml file in which you wish to modify labels (for example, "lang_webclient.fr-EN.wml");

  4. using a text editor, create an empty .wml file that you rename like the .wml file you want to modify but by adding "override" before the language code, ("lang_[...].override.[language code].wml") as in the following example: "lang_webclient.override.en-FR.wml";

  5. in this "override" file, enter the keys you want to customize and their new labels: for example ACCOUNT/ACCOUNTSTATUS = Status (instead of "Status" in the original file);

  6. save the changes made to this file and then apply the changes (see Apply changes).

 

Client whose original .wml files have already been modified

 

For an existing client, it is possible that the original files have been modified. It is therefore necessary to identify in the file the keys already customized in order not to overwrite them.

 

  1. As an administrator, access the server where Watchdoc is hosted;

  2. Go to the folder where the Watchdoc label files are stored (C:\Program Files\Doxense\Watchdoc\Data by default);

  3. locate the name of the .wml file in which you wish to modify labels (for example, "lang_webclient.fr-EN.wml");

  4. open this file and identify the labels already customized:

    • If you have access to the original .wml files from the production version, you can compare these .wml's to the client's in WINMERGE where each different line is a custom key. All that remains is to transfer these custom keys to the corresponding lang_[application].override.[code_LANGUE].wml file. To find the original files in the production version, it is possible to regenerate a build in the old version of the client, install and recover the .wml files.

    • If you do not have access to the original .wml files of the production version, but still have access to the original .wml files of the version you want to update, it is possible to compare the production files with these files in WinMerge, but all the differences will not necessarily be custom keys: they may indeed be updated keys. It is therefore necessary to do some memory work to identify the real custom keys.

  5. using a text editor, create an empty .wml file that you rename like the .wml file you want to modify but adding "override" before the language code, ("lang_[...].override.[language code].wml) as in the following example: "lang_webclient.override.en-FR.wml";

  6. in this file "override",

  7. transfer the keys and their labels previously customized ;

  8. enter the keys you want to customize and their new labels: for example ACCOUNT/ACCOUNTSTATUS = Status (instead of "Status" in the original file);

  9. save the changes made to this file and then apply the changes (see Apply changes).

 

Apply changes

To apply the changes in this "override" file, you can proceed in 3 ways:

  • either by restarting Watchdoc ;

  • or by using the WCLI command "REFRESHWMLS

  • or from the Watchdoc administration interface:

    1. go to Main Menu > Advanced Configuration (in the Configuration section) > System Configuration >

    2. in the General Configuration section, under the Regional Options parameter, click on the "Reload localization files" button.