Skip to end of metadata
Go to start of metadata

BPMN Explorer is a Jaggery-based lightweight web application, which provides the user interface for the end users to interact with deployed BPMN applications. You can customize and deploy it in a web server. You can access the BPMN Explorer using the following URL: https:/<HOST_IP>:9443/bpmn-explorer/login

Logging in to the BPMN explorer via a tenant account

Follow the steps below to log in to the BPMN explorer via a tenant account.

  1. Make a copy of the <BPS_HOME>/repository/deployment/server/jaggeryapps/bpmn-explorer/ directory.

    This doc refers to this directory you copied as <BPMN_EXPLORER_HOME>.

  2. Update the <BPMN_EXPLORER_HOME>/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>:9443/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 <BPMN_EXPLORER_HOME>/ directory and add the ZIP file to the <BPS_HOME>/repository/deployment/server/jaggeryapps/ directory.
  4. Copy the <BPS_HOME>/repository/deployment/server/webapps/bpmn.war file to the  <BPS_HOME>/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/ 

The BPMN Explorer has the following features and functionalities.


Dashboard provides a statistical view (including process instance count, process and task instance status) of the deployed BPMN instances.

view dashboard


This displays the list of the deployed BPMN processes.

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 as follows:

fill details to start a process



The TASKS tab provides the functionalities to manage BPMN tasks.

My tasks

This displays the task instances that are assigned to the user who is logged in. 

list of tasks

You can click on the listed tasks and complete, reject, transfer or reassign them appropriately. 
add process details

Claimable tasks

This 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 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


This enables monitoring deployed BPMN process instances using the Process Instance ID.

monitoring a process instance

Also, you can perform an advanced filtering search for a Process Instance ID.

advanced filtering


Click Generate Report in the REPORTS tab to generate different statistical reports of the actions you performed on different BPMN processes. 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

  • No labels