Customizing the BPMN Explorer

BPMN Explorer enables users to interact with deployed BPMN applications. It's a Jaggery-based, lightweight web application that you can deploy in a web server. 

Basic structure of UI components

Each page of the web app is constructed by a set of Jaggery scripts as shown below.

It sends AdminServices requests to the back-end and retrieves data to render data in the HTML page.

 The file structure of the BPMN Explorer is as follows:

Architecture components

The architecture of the BPMN Explorer consists of the following main Model View Controller (MVC) components.

Models

The <EI_HOME>/wso2/business-process/repository/deployment/server/jaggeryapps/bpmn-explorer/model directory contains the following model Jaggery scripts that use the BPMN REST API to retrieve data to display. The API sends AdminServices requests to the back-end and retrieves data to render the HTML page.

Views

Views specify how to render the HTML body of the information retrieved in the associated Model. Views are configured via Jaggery files located in the <EI_HOME>/wso2/business-process/repository/deployment/server/jaggeryapps/bpmn-explorer/template directory.

Controllers

Controller Jaggery files are located in the <EI_HOME>/wso2/business-process/repository/deployment/server/jaggeryapps/bpmn-explorer/controller directory. They are used to connect the Jaggery scripts that generate subparts of each page. When the server receives a request, it maps it to a particular controller via URL mappings as follows.

Loading the process diagram 

The <EI_HOME>/wso2/business-process/repository/deployment/server/jaggeryapps/bpmn-explorer/assets/ wsRequest.js file loads the BPMN process diagram for the corresponding process instance in the BPMN Explorer. This avoids the need to authenticate again when viewing the process diagram. It contains the following methods.

Deploying on an external server

You can deploy the BPMN Explorer on an external server separate from WSO2 EI. To do this, you need to configure the BPMN Explorer location in the <EI_HOME>/wso2/business-process/repository/deployment/server/jaggeryapps/bpmn-explorer/config/config.json file. Also, you need to configure the tenant domain in this file if you use the tenant mode of the server.

Adding internationalization and localization

The following steps show an example of how to localize the BPMN Explorer.

Changing the Web Browser settings

1. Set the language of your Web Browser to the preferred one. For example, in Google Chrome, click Settings -> Advanced -> Languages menu.
   
2. Click Language, and then click Add Language.
   
3. Search and select Bulgarian, and click ADD.
   
   You view the Bulgarian language added to the list of lanuguages. 
4. If you have the locale_en.json file also in the <EI_HOME>/wso2/business-process/repository/deployment/server/jaggeryapps/bpmn-explorer/config/locales directory, then click Bulgarian and then click Move to the top to give the highest priority to the Bulgarian language. 
   

5. Set the encoding type of your Web Browser to UTF-8.

   You might not want to do this based on your Web Browser and its version. For example, the Encoding menu has been removed from Google Chrome version 55 and above, and Chrome will do auto-encoding detection now.

Localizing strings in the resource files

The resource files in the <EI_HOME>/wso2/business-process/repository/deployment/server/jaggeryapps/bpmn-explorer/config/locales directory store the localization strings defined in .jag files according to the Web Browser locale (e.g., locale_en.json).

To localize the BPMN Explorer, you need to localize the strings defined in these resource files as follows.

1. Create a new file by the name locale_{lolcaleCode}.json inside the <EI_HOME>/wso2/business-process/repository/deployment/server/jaggeryapps/bpmn-explorer/config/locales directory. 

   For example, if the language you set as the highest priority in the Browser is Bulgarian, the locale code is 'bg' and the file name should be locale_bg.json.

2. Create the key-value pairs in the <EI_HOME>/wso2/business-process/repository/deployment/server/jaggeryapps/bpmn-explorer/config/locales/ locale_bg.json file, and change the values of the key-value pairs to match the language.

   You can copy the required key-value pairs from the <EI_HOME>/wso2/business-process/repository/deployment/server/jaggeryapps/bpmn-explorer/config/locales/ locale_en.json file, which is the defualt resource file for Jaggery, and change the values to match the Bulgarian language accordingly.

   For example, a section of a sample locale_bg.json file is shown below.

   locale_bg.json

   {
   ...
   "dashboard":"Табло",
   "my.tasks.title":"Моите задачи",
   "tasks":"Задачи",
   "welcome.msg":"Добре дошли в статистическия изглед на BPMN Explorer. Моля, инсталирайте процесите от администраторския изглед и създайте задачи, за да генерирате статистически данни.",
   "processes":"процеси",
   "monitoring":"мониторинг",
   "reports":"доклади",
   "search":"Търсене",
    "logout":"излез от профила си",
   ...
   }

3. Start the Business Process profile of WSO2 EI and open the BPMN Explorer web application in your Browser (https://<HOST-NAME>:9445/bpmn-explorer), and log in to it. You view the UI of the BPMN Explorer is now changed to Bulgarian.