Internationalization of XML Configuration 

Use

This section describes the various possibilities in which the UWL configuration can be internationalized.

UWL configuration contains several display texts like labels for buttons, names for Views etc... These text have to internationalized.

Procedure

There are two alternatives for uploading the configuration to UWL.

...

       1.      XML File

In this approach configuration XML file itself should contain all the description bundles through the definitions of <DescriptionBundles> and <Descriptions> tags for all the supported languages. (More information on the tags can be found in DTD Documentation).

       2.      ZIP File

In this approach, configuration zip is uploaded to UWL either thro the administration or through the Business package deployment. Following requirements are to be met by the zip file.

                            a.      zip file name should be of the format  uwl_myconfigName.zip where myconfigName  is the configuration name

                            b.      zip file name is lowercase

                            c.      zip file should not contain any directories

                            d.      zip file should contain the xml file preferably by the name myconfigName.xml  inside with no folder.

                            e.      zip file should contain resource bundles, that is, properties file which are translated. These resourceBundle name should be myconfigName,  unless myconfigName contains "_".  This character is reserved for language, country and variant resolution.

                              f.      ResourceBundle should contain keys with Long suffixed for tooltips.

myconfigName is just a place holder. For example, for Manager Self Service (MSS) business package, use uwl_mss.zip with mss.xml, mss.properties, mss_de.properties etc. inside the file uwl_mss.zip.

Zip mechanism works through the Deployment hook also.

Following picture shows a sample zip file structure. Do note how all the points mentioned above are met.

 

Downloading the ZIP File

If zip file is used, they can be downloaded in the UWL administration UI:

       1.      Choose System Administration  →  System Configuration → Universal Worklist & Workflow → Universal Worklist – Administration.

       2.      Under Universal Worklist Content Configuration select the link Click here to …

This link leads you to the XML files.  

       3.      Go to the Upload New Configuration tab. Here you can also download zip files.

If zip file is loaded adapting to a system, then name of zip file as well as the XML file content inside are transformed as necessary.

 

How to Refer to the Resource Keys From Inside the XML

This concept is well understood by looking at the example.

Following figure shows the View defintion of minialerts.xml. View has referenceBundle as miniAlerts.

Following are the resource bundles present in this ZIP file:

...

...

●      Default properties

●      Properties file for German language