# Workflow

## Workflow enhancements for using a new language

| In order to use a new language in the Workflow, the following changes have to be made:
| ### 1. Add language shortcut to the workflow repository
| Changes in the <ep_root>\build\tpl_app\tpl_ABS_env.ini (general) respectively <ep_root>\build\applicationServer\<app_server_name>\deploy\<application_name>\xml\war\ABS_<application_name>.ini (for every existing environment)
| Make sure the language you want to add is defined in the module [Repository\Languages]. The listed languages have to be separated by a comma!
| [Repository\Languages] languages=GER,ENG,FRA
| ### 2a. Mails generated by Templates
| Please note that the following changes are optional! If you want to receive messages other than English (default), e.g. French, the following changes are necessary!
| #### 1. Changes concerning the layout definition
| Below the module "[Messenger\Layoutdefinitions]" there are the pathes to the components the single workflow mails consist of. For every kind of mail there's a general part (presently it only contains the subject entry of the mail) and several language specific parts. As an example for the French language settings, the part Reminder1 should look as follows: [Messenger\Layoutdefinitions\Reminder1] Subject=urgent workflow message [Messenger\Layoutdefinitions\Reminder1\ENG] LayoutHeaderFilePath=lay/notifier/Reminder1_Header_eng.html LayoutFooterFilePath=lay/notifier/Reminder1_Footer_eng.html LayoutTextFilePath=lay/notifier/Text_Workitem_Link_eng.html [Messenger\Layoutdefinitions\Reminder1\FRA] LayoutHeaderFilePath=lay/notifier/Reminder1_Header_fra.html LayoutFooterFilePath=lay/notifier/Reminder1_Footer_fra.html LayoutTextFilePath=lay/notifier/Text_Workitem_Link_fra.html [Messenger\Layoutdefinitions\Reminder1\GER] LayoutHeaderFilePath=lay/notifier/Reminder1_Header_ger.html LayoutFooterFilePath=lay/notifier/Reminder1_Footer_ger.html LayoutTextFilePath=lay/notifier/Text_Workitem_Link_ger.html
| The language settings for German and English in the Reminder1 part are part of the installation!
| #### 2. Changes concerning the mail templates
| Please note that the following changes are optional! If you want to receive messages other than English (default), e.g. French, the following changes are necessary!
| In the indicated directories (ep_root\axalant\lay\notifier (general) or ep_root\<name of environment>lay\notifier (for every existing environment)) there are files with different endings according to the languages (e.g. _ger or _eng). The files of one language have to be copied and the endings have to be changed according to the language (e.g. _fra (for French) instead of _eng). It is important to change all files of a language! Finally, the content output has to be translated.
| Please note that the format information mustn't be changed! As a bacis rule, don't change the information between the tags <AXA> and </AXA>!
| The following parts of the Reminder1 ... have to be translated: a. Header: e.g. "Reminder1_Header_fra.html" - "axalant workflow reminder (due work item)" - "Hello" - "the following work items are due:" b. Footer: e.g. "Reminder1_Footer_fra.html" - "Best Regards" and "Link to Inbox" c. Text part: e.g. "Text_Workitem_Link_fra.html" - "Link to the work item" All other entries are for formatting the message and mustn't be changed. The other copied templates have to be changed in a similar manner.
| ### 2b. Mails generated by XML
| In the indicated directories (ep_root\axalant\lay\notifier (general) or ep_root\<name of environment>lay\notifier (for every existing environment)) there are property files with the language specific entries for the mails generated by XML. The files of one language have to be copied and the endings have to be changed according to the language (e.g. _fr (for French) instead of _en). Finally, the content output has to be translated.
| After the installation the following files exist:
| MessageEntries.properties MessageEntries_de.properties MessageEntries_en.properties
| The default language is English therefor the *_en.properties file is empty. The English messages are placed in the properties file without locale. To addapt them for a new language perform the following steps:
| Please note that the following changes are optional! In case you generate your mails by a template, please continue with the next step (Prepare property files)! If you want to receive messages generated by XML in a language different than English (default), e.g. French, the following changes are necessary!
| Distinguish the locale (2 letter code for the country!) for your additional language (e.g. "fr" for French), for other languages search in the table EDB-COUNTRY or search the web).
| To search EDB-COUNTRY:
| Click to choose the repository object to browse. Search EDB-COUNTRY and browse it (for several countries the locales are present here) If the locale for your country is not set, search the web.
| Copy and rename the default property file (MessageEntries.properties) by adding an underline and your locale to the name (e.g. _fr for French).
| In our example the file name is: MessageEntries_fr.properties
| Edit the property file and translate the messages, do NOT change the identifiers at the beginning of each line.
| To activate your changes re-deploy your business service.
| ### 3. Prepare property files (hints and error messages) for additional languages
| Please note that the following changes are optional! If you want to receive messages other than English (default), the following changes are necessary!
| The Workflow messages are collected in property files inside the jar files.
| Please note that for hints and error messages a French translation is already included with the installation!
| For the Workflow the following jar files include property files with messages:
| 1. abs-notifier.jar
| MessengerMsgResources.properties MessengerMsgResources_de.properties MessengerMsgResources_en.properties MessengerMsgResources_fr.properties
| 2. abs-notifier-tools.jar
| WflNotifierMsgResources.properties WflNotifierMsgResources_de.properties WflNotifierMsgResources_en.properties WflNotifierMsgResources_fr.properties
| 3. abs-workflow-tools.jar
| WflExecutorMsgResources.properties WflExecutorMsgResources_de.properties WflExecutorMsgResources_en.properties WflExecutorMsgResources_fr.properties
| The default language is English therefor the *_en.property file is empty. The English messages are placed in the property file without locale. To addapt them for a new language perform the following steps:
| Distinguish the locale (2 letter code for the country!) for your additional language (search EDB-COUNTRY or search the web).
| To search EDB-COUNTRY:
| Click to choose the repository object to browse. Search EDB-COUNTRY and browse it (for several countries the locales are present here) If the locale for your country is not set, search the web.
| Extract the default property file.
| Rename the default property file by adding an underline and your locale to the name (e.g. _ru for Russia).
| Edit the property file and translate the messages, do NOT change the identifiers at the beginning of each line.
| Place the place holder(s) so they make sense (e.g. {0}...{1})
| Example: DefaultVarNotFound = Notifier::Default variable {0} not found. Everything after the '=' sign has to be translated. The place holder {0} is in this case the name of the default variable.
| Add the new created property file to the jar file.
| Repeat this with all 3 above mentioned property files.