Customizing the BPMN Explorer
- Former user (Deleted)
The 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:
| File/Directory | Usage |
|---|---|
assets/ | Contains resource files that are used for general purposes such as form generation and encoding. |
config/ | Contains files to support internationalization of the web app. |
controller/ | Contains the controllers of the web app. |
css/ | Contains CSS files of the web app. It includes the bootstrap-theme.min.css and bootstrap.min.css files by default. Also, includes the style.css file for customizations. |
error404.html | The HTML file that is displayed when an HTTP 404 error occurs. |
error500.html | The HTML file that is displayed when an HTTP 500 error occurs. |
fonts/ | Contains fonts and bootstrap-related resources. |
images/ | Stores images of the web app. |
js/ | Contains JavaScript library files that are used for various purposes. |
model/ | Contains all the models of the web app. |
template/ | Contains Jaggery scripts that construct the HTML main body content. Also, this contains a subdirectory named |
jaggery.conf | Includes all Jaggery configurations. |
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.
| Model | Purpose |
|---|---|
common.jag
| Relates to all the models. It retrieves and updates data that is common to all the pages and all the actions performed by the back-end implementation of the BPMN Explorer. |
loginModel.jag | Creates a login failure message if previous logging activity failed. |
myTasksModel.jag | Retrieves all the tasks assigned to the logged-in user. |
taskModel.jag | Retrieves details of a specific task using the task ID. |
claimModel.jag | Generates the UI form for viewing claimable tasks. |
claimableTaskModel.jag | Retrieves the list of tasks that the logged-in user can claim. |
completedTaskModel.jag | Retrieves information (including attachments) of a selected completed task instance. |
historicTasksModel.jag | Lists the completed tasks in the Completed Tasks tab. |
processModel.jag | Retrieves all deployed BPMN processes. |
reportModel.jag | Retrieves necessary information (i.e., tasks list, users list, etc.) to generate reports. |
searchModel.jag | Retrieves instances based on search queries. |
taskModel.jag | Retrieves information on deployed BPMN tasks (e.g., attachments, metadata, etc.) |
statsModel.jag | Generates statistical charts for reports. |
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.
The following controllers are special purpose controllers that do not provide HTML pages. Instead, they perform actions on behalf of the user.
taskController- performs control actions related to tasks.authenticator- performs authentication of the user by logging in to the server through the AuthenticationAdmin service.logout- performs logging out from the back-end server on behalf of the user.communication- performs control actions related to communication among components.startProcessController- performs control actions related to the starting process of tasks.statsController- performs control actions related to statistics.
| URL | Mapping | Corresponding HTML Page |
|---|---|---|
/login/* | loginController.jag | Login page |
/myTasks/* | myTasksController.jag | My tasks |
/task/* | taskController.jag | - |
/auth/* | authenticator.jag | - |
/logout/* | logout.jag | - |
/send/* | communication.jag | - |
/process/* | processController.jag | Processes |
/claimableTask/* | claimableTaskController.jag | Claimable task view |
/claimTask/* | claimTaskController.jag | Claim tasks |
/startProcess/* | startProcessController.jag | - |
/historicTasks/* | historicTasksController.jag | Completed tasks |
/stats/* | statsController.jag | - |
/completedTask/* | completedTaskController.jag | Completed task view |
/search/* | searchController.jag | Search |
/reports/* | reportController.jag | Reports |
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.
| Method | Purpose |
|---|---|
requestBPS | Creates a SOAP request to the backend server. |
getBPMNProcessDiagram | Creates the SOAP payload to retrieve the process diagram. |
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
- Set the language of your Web Browser to the preferred one. For example, in Google Chrome, click Settings -> Advanced -> Languages menu.
- Click Language, and then click Add Language.
- Search and select Bulgarian, and click ADD.
You view the Bulgarian language added to the list of lanuguages. - If you have the
locale_en.jsonfile also in the<EI_HOME>/wso2/business-process/repository/deployment/server/jaggeryapps/bpmn-explorer/config/localesdirectory, then click Bulgarian and then click Move to the top to give the highest priority to the Bulgarian language.
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.
Create a new file by the name
locale_{lolcaleCode}.jsoninside the<EI_HOME>/wso2/business-process/repository/deployment/server/jaggeryapps/bpmn-explorer/config/localesdirectory.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 belocale_bg.json.Create the key-value pairs in the
<EI_HOME>/wso2/business-process/repository/deployment/server/jaggeryapps/bpmn-explorer/config/locales/locale_bg.jsonfile, 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.jsonfile, 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.jsonfile is shown below.locale_bg.json{ ... "dashboard":"Табло", "my.tasks.title":"Моите задачи", "tasks":"Задачи", "welcome.msg":"Добре дошли в статистическия изглед на BPMN Explorer. Моля, инсталирайте процесите от администраторския изглед и създайте задачи, за да генерирате статистически данни.", "processes":"процеси", "monitoring":"мониторинг", "reports":"доклади", "search":"Търсене", "logout":"излез от профила си", ... }- 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.