Configuring Application Translations

Introduction

Text that appears in various Application Packages within the Enactor application can be changed and customised according to a business's requirements. Enactor POS Prompts, Enactor Web Maintenance and Web Reports are a few examples of such Application Packages.

It should be noted however, that only the messages defined in Application Translations can be edited through this option and not all messages and text that appear on an Application Package UI can be edited.

Overview

This guide will cover the configuration for the following:

• User Role Maintenance - Configuring User Role privileges that are required to perform functions related to Application Translations.

• JAR Deployer - A Maintenance application that enables the User to deploy the related Message Resource JARs.

• Application Translation Tool - A Maintenance application that enables the User to define, view, or edit Application Translations that are used in various messages throughout the Enactor application.

• Interactive POS Translation Tool - A tool that enables a POS User to interactively translate messages on the React POS without using the existing Applications Translations Maintenance.

• Broadcasts - deploying message changes to other devices.

User Role Maintenance

Authorisation to run the specific functionality documented here is controlled with privileges maintained in Roles. Configuring User Roles is covered in a separate How-to Guide. Role privileges required to carry out Application Translation related functionality is discussed here.

The User Roles Maintenance application can be accessed through:

Configurations > HR > User Roles

Select the appropriate Role to be edited. The User Role 'Administrator' is used in the example:

In the Authorised Functions tab, select the Enactor Web Maintenance Application Package and configure the privileges listed below against each Process.

Process - JAR Deployer

Application Package	Function ID	Description
Enactor Web Maintenance	enactor.jarDeployer.Run	Allows the EM User to run the Jar Deployer application.

Process - File Importer

Application Package	Function ID	Description
Enactor Web Maintenance	enactor.fileImporter.Run	Allows the EM User to run the File Import application.

Process - Message Resource Load Resources To Sync

Application Package	Function ID	Description
Enactor Web Maintenance	enactor.messageResourceMaintenance.Run	Allows the EM User to run the Application Translation Maintenance application.
Enactor Web Maintenance	enactor.messageResourceMaintenance.List	Allows the EM User to view entries in the Application Translation Maintenance application.

Process - Application Translation Maintenance

Application Package	Function ID	Description
Enactor Web Maintenance	enactor.messageResourceMaintenance.Edit	Allows the EM User to edit entries in the Application Translation Maintenance application.
Enactor Web Maintenance	enactor.messageResourceMaintenance.List	Allows the EM User to view entries in the Application Translation Maintenance application.
Enactor Web Maintenance	enactor.messageResourceMaintenance.New	Allows the EM User to create new entries in the Application Translation Maintenance application.
Enactor Web Maintenance	enactor.messageResourceMaintenance.Remove	Allows the EM User to remove entries in the Application Translation Maintenance application.
Enactor Web Maintenance	enactor.messageResourceMaintenance.Run	Allows the EM User to run the Application Update Maintenance application.
Enactor Web Maintenance	enactor.messageResourceMaintenance.Upload	Allows the EM User to upload message resource files in the Application Translation Maintenance application.
Enactor Web Maintenance	enactor.messageResourceMaintenance.View	Allows the EM User to view entries in the Application Translation Maintenance application.

**
**

JAR Deployer

The Jar File Deployment interface of the Estate Manager provides a means to make Application elements and resources from other Applications (POS for example) available to the Estate Manager. JAR files relating to any missing Application Messages from the Estate Manager can be deployed to the Estate Manager through the JAR deployer function.

The JAR Deployer Maintenance function is accessed using the search or path:

Administration > Data Management > JAR Deployer

Click on Choose File button and browse to the File System folder containing the .xml files, select the file and click on Upload. These files need to be accessible in the local file system of the machine from which the Estate Manager is accessed. If the POS is deployed on a different machine, local copies of the files must be made.

The Jar files that need to be imported can be obtained from the enactor-lib folder of the POS Installation. Numerous Jar files can be deployed in this way (for example, the Enactor Cash Management Jar contains messages related to Cash Management functions; the Customer Orders Jar contains messages related to Order at POS functions).

The Jar files that require deployment will vary depending on both the POS functionality being used, and the translation requirements.

Do not select the Import Default Data tick-box when deploying Jar files

• this is not necessary for the deployment of message files.

The file will be uploaded and deployed. If successful a message will be displayed.

Application Translation Tool

The Application Translation Maintenance function is accessed using the search or path:

Configuration > Organisation > Application Translations

The Application Translation entities listed may be filtered by entering values to the fields described in the table below and selecting Apply Filters:

Configuration	Description
Description	Dropdown list selection from a list of all Application Packages.
Locale	Dropdown list selection from a list of all configured Locales.

Upon selection of the relevant Application Package and Locale, Message Resources that are applicable to the selection will be listed:

Each entry in the displayed list will have the option to Add and/or Download the Message Resource. The Add button will enable the user to add the contents of the selected Message Resource file which will be used as the default file.

The added record will be displayed as follows:

Once the user adds the Message Resource to the database, the user can View, Edit, Delete, or Download the message resource as required.

Once a Message Set is added, its contents will not be saved to the database until the Message Set is saved. The Message records are highlighted in Yellow with alert message to User, 'There are new messages, highlighted in yellow, not currently in the version stored in the database. Saving this message resource will add these messages to the stored version.'

To edit messages, the User can simply enter the required text as highlighted above. Text entered in this blank field will override the Default Text. Once the changes are made, the User can save and upload the changes to the Database by using the Upload to Database button.

Additionally, following convenience options are available at the bottom of the Maintenance Page:

Property	Description
Identify Outdated Message Resources	This initiates a check of all entries in the database, generating a list of Message Resources that are out of date.
Upload Message Set JAR	This is a link to the JAR Deployer application to enable the User to deploy the related Message Resource JARs.
Upload Message Set Archive	This will upload an archive file (jar, zip, war, par) which will add the Message Resources to the database.
Download Message Resources Bundle	This will be used to export the Message Resources bundle which the Application Package uses.
Upload to Database	This will be used to upload a new Message Resource set to the Database. The user needs to upload the Message Resources in the zip archive file format.
Download Translation Tool	This will be used to download the "Translation Tool" from the Estate Manager, which will be used in the translation of the Messages into different Locales.

Identify Outdated Message Resources

This initiates a check of all entries in the database, generating a list of Message Resources that are out of date. A popup message indicating "Checking for Message Resources that need updating. Please wait..." will be displayed along with a Cancel button. Once the check completes the user can view a list of outdated resources from the Database.

Upload Message Set JAR

When a User clicks on the Upload Message Set JAR button the following screen is displayed:

The Jar Deployer screen will include the following options enabling the user to upload the related jar file:

By clicking on 'Choose File', the User may choose the desired JAR file and select Upload to proceed. The selected file will then be uploaded and deployed, and a message will be displayed if the upload is successful.

Selecting the Back button will navigate the user back to the Application Translation Maintenance.

Upload Message Set Archive

When a User clicks on the Upload Message Set Archive button following screen is displayed:

This page will enable the User to upload an archive file (jar, zip, war, par) which will add the Message Resources to the database. A message will be displayed once the file is successfully uploaded and deployed.

Download All Message Resources Bundles

When a User clicks on the Download All Message Resources Bundles button following screen is displayed:

The application package to be exported may be filtered by entering values to the fields described in the table below and selecting the following filter criteria:

Property	Description
Application Package	Selected from a drop-down list of all Application Packages in the database.
Locale	Selected from a drop-down list of all Locales configured.
Only Include resources that have been translated in the following locale. Select '-' to export all	If a Locale is selected the User will be able to export and translate the Message Resource default to the Locale for the purpose of providing it to the selected Locale from the dropdown.
Include resources from the default locale if resource is not present in selected locale	If marked true, the export will include Message Resources from the default Locale, if the Message Resources are not found in the Locale selected for the previous field.

Selection of the Export button will enable the User to download the Message Resource XML file according to the filters applied. Selection of the Cancel button will redirect the User to the Application Translation Maintenance.

Interactive POS Translation Tool

The Enactor solution provides the ability to interactively translate messages on the React POS.

The option can be enabled by adding the following parameter to the enactor.xml file (<Enactor home>\pos\configuration), then restarting the POS application.

<core:coreProperty name="ReactPos.AllowAdvancedConfiguration" value="true"/>

This function can slow POS performance, so should not be enabled on a production POS.

The On-Screen translation tool can only be used to amend Application Translations; it is not possible to translate, for example, Product descriptions or Menu labels.

Once the above parameter is set, the Translation Tool can be enabled by clicking on the Enactor logo on the Sign-on Page.

Translation mode for the POS can be enabled as below:

The user can then sign-on to the POS and using a combination of keystrokes and mouse clicks, can select a message on the POS and translate / amend it.

Editing a message can be done where a single message element will be displayed in the pop-up screen to edit or where the entire Prompt Page is selected, allowing for the translation of all message resources used on the current page. The keystroke combination used in the two instances are different.

Single Element Selection

Hold Down Shift + Left Mouse Click on the message

The user can update the New Message field and the text entered here will override the existing message. The Save button will save the changes, Reset will clear any text input and reset the field, and Cancel will terminate the action and return the User to the POS application.

A change to a message, once saved will be updated on the POS in real time.

The above change, once saved, is reflected in the POS prompt.

Prompt Page selection

Hold Down Ctrl + Left Mouse Click
All Message Resources used on the current page are listed for translation.

Multiple messages can be edited at the same time, then the changes saved.

Changes made to the messages are saved in "<Enactor home>\pos\Data\Enactor Pos\MessageResource" where an XML file is created for the Message Set.

While both methods described above reflect translation changes in the POS UI in real-time - the changes will only be applied to that one device.

To propagate the changes to other devices, it is necessary to capture them, import them into the Estate Manager and then broadcast them.

NOTE: It must be ascertained that the Home Directory of the target device receiving the Message Resources does not contain the MessageResource folder in location "<Enactor home>\pos\Data\Enactor Pos\MessageResource", and that the database is cleaned of message resources.

The XML files to be imported to the Estate Manager are produced automatically whenever a change on a translation is saved. The files are saved in the folder "<Enactor home>\pos\Data\Enactor Pos\MessageResource".

The XML file can be zipped and imported to the Estate Manager through File Import Maintenance, which will update the Message details in the Estate Manager. These changes must be saved to the database and subsequently broadcasting the Message Resources entity to target devices will update the POS UI of those devices.

File Import

The Estate Manager provides the functionality to manually import a configuration file or a configuration bundle(zip).

The File Import Maintenance function is accessed using the search or path:

Administration > Data Management > Imports > File Import

The file for Import must be XML formatted.

Click on Choose File button and browse to the File System folder containing the .xml files, select the file and click on Upload. User can defer the time at which import is to be run. This defaults to current date and time.

Once a file is uploaded, a scheduled job will be crated. Clicking on the 'View' button on the message that prompts after file upload will open the Scheduled Job Maintenance where he status of the job may be viewed in detail, including to examine error reports if the job fails.

Broadcasting Message Changes

When POS messages have been changed, either via the Application Translations app on the Estate Manager, or via a File Import; these changes should be broadcast to the estate, so they are applied to all the relevant POS devices.

The entity to be broadcast is Message Resource.

Broadcasts are covered in more detail in the Broadcasting How-To Guide.