This documentation is for WSO2 Enterprise Integrator version 6.3.0 . View documentation for the latest release in the 6.x.x family and the latest release in the 7.x.x family.
Using the BPMN Explorer - Enterprise Integrator Documentation - WSO2 Documentation

All docs This doc
||
Skip to end of metadata
Go to start of metadata

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

You access the BPMN Explorer at: https:/<HOST_IP>:9445/bpmn-explorer/login. If you configured the BPMN Explorer for a tenant account, you access it at: https://<HOST_IP>/t/<TENANT_DOMAIN>/jaggeryapps/bpmn-explorer/

If you want to log in to the BPMN Explorer as a user residing in a secondary user store, provide the username in the following format: <DOMAIN>/<USER>. E.g., foo/user1

The BPMN Explorer has the following features and functionalities.

  • DashboardView statistics for the deployed processes
  • Tasks - View and take action on tasks
  • Processes - View and start processes
  • Monitoring - Monitor process activity
  • Reports - Generate reports for processes

Dashboard

Use the DASHBOARD tab to view statistics, such as the process instance count, and the status of process and task instances.

view dashboard

Tasks

Use the TASKS tab to view and take action on your BPMN tasks and to claim tasks you want to work on.

My tasks

This tab displays the task instances that are assigned to the user who is logged in. Click on a task to select it.

list of tasks

 Click the Start button and complete, reject, transfer or reassign it accordingly. 
add process details
Claimable tasks
This tab displays the list of tasks that can be claimed by the user who is logged in.

list of claimable tasks

Select a task and click Claim Task to claim it if it is not assigned to a user.

claim a task

Completed tasks

This tab displays the list of the completed BPMN task instances.

completed tasks list

Click on a task to view more information such as task description, assignee, status etc. about it.

view details of a completed task

Processes

Use the PROCESSES tab to start the deployed BPMN processes and view their process diagrams.

list of deployed BPMN processes

Click the Process Definition ID of a process to view the process diagram of it.

view process diagram

Click the Start button, fill in the required details, and click Start to start it. For example, you can start the process named VacationRequestProcess shown above:

fill details to start a process

The process will stop after the specified number of days. 

Monitoring

Use the MONITORING tab to view the activity of specific process instances using the Process Instance ID.

By default there is no any information available in this view. To view the information of the process instance that you want to monitor, you need to provide the process instance ID.

  • If you already know the instance ID, type it in the Process Instance IDfield and click on the View Detailsbutton.

  • If you do not know the instance ID, click on the Filter the instances link. This will redirect you to the Advanced Filtering page where you can use filters to find the process instance you are looking for. 


Also, you can perform an advanced filtering search for a Process Instance ID. Else, enter the desired filters to search for the process instance you wish to find and click on the Search button. 

advanced filtering

Click on the desired process instance under the Search Results section and you will be redirected back to the Process Monitoring page with the historic information of the process instance you selected.

The process diagram of the selected process instance will be shown at the top. The table at the bottom shows the audit log of each activity in the process instance.

  • Click on the Variables tab to view the information on instance variables of the instance.

  • Click on the User Tasks tab to view the user task information of the instance.

  • If the selected instance in invoked by another process instance, click on the Caller Instance tab to view the parent instance's information. This caller instance information is available only for completed process instances.

Reports

Click Generate Report in the REPORTS tab to generate statistical reports of the actions you performed on BPMN processes.

generate report

You can generate the following reports for a single process or for all processes.

  • Process Instance Count
  • Average Time Duration Of Completed Processes
  • Task Durations Of Completed Process
  • User Vs Number Of Tasks Completed
  • User Vs Average Time Taken to Complete Tasks
  • Task Instance Count Variation Over Time
  • Process Instance Count Variation Over Time
  • User Performance Of Tasks Instances Over Time

view generated report

Configuring BPMN Explorer for a tenant account

If you are running WSO2 Enterprise Integrator in a multi-tenanted environment, follow these steps to configure the BPMN explorer for a tenant account.

  1. Make a copy of the <EI_HOME>/wso2/business-process/repository/deployment/server/jaggeryapps/bpmn-explorer/ directory anywhere on your computer. You will make your configuration changes in this new directory.

    The rest of these instructions refer to the new directory as <EXPLORER_CONFIG_TEMP>.

  2. Update the <EXPLORER_CONFIG_TEMP>/config/config.json configuration file as follows: 
    • Add your tenant domain as the value of the bpsTenantDomain parameter. (E.g., "bpsTenantDomain": "wso2.bps.com")
    • Add your tenant ID as the value of the bpsTenantId parameter. (E.g., "bpsTenantId" : "1")

       Follow the steps below to find your tenant ID.
        1. Log in to the Management Console of the Business Process profile using the following URL and admin/admin credentials: https://<HOST_IP>:9445/carbon/
        2. Click Configure, and then click View Tenants in the Multitenancy menu.
        3. Click the corresponding Edit link of the tenant.
          view the tenant list
        4. View the ID of your tenant.
          view your tenant ID
  3. Compress the <EXPLORER_CONFIG_TEMP> directory into a ZIP file, and then copy that ZIP file to the <EI_HOME>/wso2/business-process/repository/deployment/server/jaggeryapps/ directory. You may now delete the <EXPLORER_CONFIG_TEMP> directory.
  4. Copy the <EI_HOME>/wso2/business-process/repository/deployment/server/webapps/bpmn.war file to the <EI_HOME>/wso2/business-process/repository/tenants/<TENANT_ID>/webapps/ directory.
  5. Log in to the BPMN Explorer via the following URL and tenant's credentials: https://<HOST_IP>/t/<TENANT_DOMAIN>/jaggeryapps/bpmn-explorer/ 
  • No labels