Administering business processes in Camunda Cockpit

Registry regulations administrator uses Camunda Cockpit service to administer business processes.

With this service, the administrator can monitor working business processes and business rules to find, analyze and solve technical problems.

You can find the general description of the service on its official resource via the following link:

1. Service access rights

To grant a user access to Camunda Cockpit service, take the following steps:

  1. Open to Keycloak service, for example, via OpenShift link.

    cockpit 21

  1. Select the corresponfing -admin realm. Navigate to Users menu, click View all users and select the user that you need to grant the access to.

    cockpit 22

  1. Navigate to Groups, select camunda-admin role and click Join.

    cockpit 23

    After successfully granting the role, you will be notified: "Success! Added group membership".

You can find more information on the access rights assignment via the following link:

2. Authorization in the system

You can find the link to Camunda Cockpit in the OpenShift console, or Control Plane.

  • To authorize with OpenShift:

  1. Navigate to Networking → Routes.

  2. Select the required project.

  3. Find the corresponding route business-process-administration-portal and click the link in the Location column.

    cockpit 25

  • To authorize with Control Plane:

    1. Enter the registry administration panel in Control Plane, using the login and password that you have.

      update cluster mgmt 01

  1. Navigate to Registries section and select the corresponding registry.

    change key 01

  1. At the bottom of the page, click the admin-portal link.

    cockpit 20

3. Main Page

After authorization in the web-interface of Camunda Cockpit service, you’ll see Camunda Welcome, the main page with a dashboard that contains three sections: Cockpit, Tasklist та Admin.

Navigate to Cockpit section.

cockpit 1

You will see a board that contains charts with the general information on business processes and their current status.

4. Managing business processes in Camunda Cockpit

4.1. Camunda Cockpit dashboard

cockpit 2

The Right Now section shows business processes being executed at the moment:

  • Running Process Instances — the number of business processes started by one or several users and still running, is shown in the center of the left circle.

  • Open Incidents — the number of incidents that occurred during business process execution is shown in the center of the middle circle.

  • Open Human Tasks — the number of open user tasks waiting to be resolved are shown in the center of the right circle. These tasks were modelled in Camunda Modeler and published by the business process execution service. They are available to users in citizen and officer portals (citizen-portal and officer-portal).

The Deployed section shows business processes that are deployed at the moment:

  • Process Definitions field — shows the general amount of deployed business processes in Camunda.

  • Поле Deployments — shows the number of deployments and version updates of the regulations.

cockpit 3

4.2. Running business processes

Click the Running Process Instances chart to navigate to Processes page, where all the currently deployed business processes are listed.

cockpit 6.0

Columns description

State

Incidents

Running Instances

Name

Tenant ID

Business process execution current status

Number of incidents with errors

Number of times the business process has been started

Name of the business process and link to it

Tenant ID

4.2.1. Viewing business process instance details

Follow the business process link in the Name column to open a table with all the instances of this business process.

cockpit 7.0

You can find detailed information on this business process in the field to the left. Definition Version line shows business process version. If there are several versions, you’ll be able to switch between them using a dropdown menu to view Process Instances for every version of the business process and monitor changes.

cockpit 16

4.2.2. Working with error incidents

In case there was an error in business process execution, the incident will be shown in the general business process list, marked with a "cross" — ❌.

  • If the error is caused by business process configuration, or failed script, then restarting the process won’t help, and changes must be made.

  • If the error is caused by failures in other systems, or connectivity problems, restart the business process.

To resolve the error by restarting the business process, take the following steps:

The process will restart from the moment of failure, plus the wait state time.

  1. Follow the business process link in the Name column.

    cockpit 26

  2. Navigate to Incidents section.

    cockpit 27

  3. Click the notification in the Message field to view error contents. It will be shown in a new window.

    cockpit 28

  4. Click ↻ pictogram (Increment Number of Retriers of Failed Jobs) in the top right of the screen, or to the right of the process instance to restart the process.

    cockpit 29

After being restarted, it takes some time for the business process to show on the main dashboard.

4.2.3. Suspending business processes and their instances

You can suspend an instance by clicking Suspend Process Instance icon, causing the instance to pause. Suspended instances can’t be completed by users or system. To confirm instance suspension, click Suspend in the prompt window.

cockpit 12.0

The entire business process can be suspended the same way, by clicking Suspend Process Definition. Users cannot complete suspended business processes, any of their elements, or start additional elements within them. A suspended process can be reactivated later.

You need at least one running process instance to suspend a process instance.

4.2.4. Activating business processes and instances execution

You can activate a process instance by clicking Activate Process Instance.

cockpit 13

You can activate a business process by clicking Activate Process Definition.

4.2.5. Deleting business process instances

To delete a process instance, click x (cross) in the top right corner and confirm by clicking Delete Process Instance in the prompt window.

cockpit 9.0

4.2.6. Editing parameters

All the variables of a business process are listed in the Variables tab. You can find the tab if you open a business process via its link.

cockpit 8.0

You can edit the variables listed in the Value column by clicking the corresponding parameter, or clicking the editing icon in the Actions column.

cockpit 8.1

4.2.7. Filtering search parameters

For fast business process search, you can set additional filters.

cockpit 14

4.3. Reference rules (Decisions)

The Decisions tab shows a table of reference rules for each business process.

cockpit 17

4.4. Assigned tasks (Human Tasks)

The Human Tasks tab shows the number of tasks in progress, which are assigned to corresponding users.

cockpit 18

4.5. Viewing deployed business processes (Deployments)

Click Deployments icon to open a tab with the following fields:

  • the Deployment Time column shows date and time for every deployed file;

  • the middle column lists all deployed files in the current deployment process;

  • left-clicking a file name will open the business process scheme (model) on the right.

Left-clicking the Download icon will download the business process, created in the modeller.

cockpit 4

Detailed information about the business process can be found in the Definitions field. To see the currently running instance, follow the business process link and check the Process Instances tab. The number of running instances is shown in the info panel (26 in example case).

cockpit 5