Customizing Human Task Explorer

HumanTask-Explorer: jaggery based web-app provides user interface for end users to integrate them to service oriented applications. This is a lightweight web application that can be customized and deployed in a web server.

Basic Structure of UI construction

Each page of the web-app is constructed by set of jaggery scripts as shown in the below diagram.

Controllers

Controller is the main jaggery script which combines jaggery scripts which generating sub parts of each web page. <page>Controller.jag is located in /humantask-explorer/controller/ directory.  When the server receives a request, it is mapped to particular controller, by url mappings as follows:

NOTE :

Controllers specified in blue text in the above table are special purpose controllers that do not provide an html. Instead they perform actions on behalf of the user as follows:

• authenticator - Perform authentication of the user by logging-in to the server through AuthenticationAdmin service

• actionController - Performs actions (such as claim task, start task, add comment, assign task, …. etc.) related to tasks. It handles ajax requests from the browser side for tasks state transitions, commenting, etc..

• updateController - Performs providing updated content of comments, history and attachments for ajax requests made from browser side.

• logout - Performs logging out from the back-end server on behalf of the user.

Models

Model scripts retrieve data to be displayed to the user. It make AdminServices (in this case retrieve data from HumanTaskClientAPIAdmin service) requests to the back-end and retrieve and prepare data to render data in the html page.

Header

Header jaggery script (located in humantask-explorer/template/partials/) construct html header which is common to all the web pages.

Modals

Contains modals used in the webpage.

Views

<page>View.jag scripts (located in humantask-explorer/template/) contains html body rendering the information retrieved in associate Model.

File Structure

The file structure of the ws-humantask-explorer UI is shown below:

WSHTRequest module

WSHTRequest.js can be used as a jaggery module that provide support to make HumanTaskClientAPIAdmin core requests from the UI back-end to EI Business Process when customising the ws-humantask-explorer UI.

Following operations are supported by the WSHTRequest module:

WSHTRequest usage

Before making service requests the module, user must be initialized by initHTServerInfo().

Adding internationalization and localization

The following steps show an example of how to localize the Human Task 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/humantask-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 file

The resource files in the  <EI_HOME>/wso2/business-process/repository/deployment/server/jaggeryapps/humantask-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 Human Task 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/humantask-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/humantask-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/humantask-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":"моите задачи",
   "claimable.tasks":"изпълними задачи",
   "notifications.caps":"известия",
   "search":"Търсене",
   "logout":"излез от профила си",
   "reserved":"резервиран",
   "id":"документ за самоличност",
   "type":"Тип",
   "name":"Име на задачата",
   "subject":"Предмет",
   "status":"Статус",
   "priority":"приоритет",
   "in.progress":"Напред",
   "suspended":"окачен",
   "completed":"завършен",
   "failed":"Се провали",
   "obsolete":"остарял",
   }
   ...
   }

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