Apex Designer Documentation
What's New
Getting Started
Projects
Business Objects
Processes
User Interfaces
App Behaviors
Files
Dependencies
Project Settings
Libraries
Patterns and Best Practices
App Showcase

Apex Camunda Explorer

See Camunda 8 in action

Blank Profile Image
Written by David Knapp
Updated a month ago
3 min read

Apex Camunda Explorer provides administrative tools to manage Camunda 8. It is a great way to explore and learn about Camunda 8. Apex Camunda Explorer is an app template in Apex Designer, so you can use it as a starting point to build your own Camunda administrative tools. You can watch this overview video or read about the capabilities below.

Process Definitions Page

The process definitions page lets you search for process definitions as well as import new process definitions.

Screen Shot of the Process Definitions Page

Clicking on a process definition opens the process definition page.

Process Definition Page

The process definition page shows the details for a process definition as well as the diagram and process instances.

Screen Shot of the Process Definition Page

Clicking a process instance opens it. Clicking the play_arrow  icon button on the top right lets you enter process variables and start a process instance.

Screen shot of the start process instance dialog

The variables are entered in JSON5 with automatic formatting and syntax checking.

Process Instance Page

The process instance page displays the variables, tasks (jobs), child process instances and any incidents.

Screen Shot of the Process Instance Page

The variables section shows all the process variables for the instance. The Scope Key shows whether a variable is related to the process instance or one of the activities. Clicking a process variable lets you edit the process instance variables.

Screen shot of the edit process variables dialog

The incidents section shows you any problems with the process instance. In this example, there was a problem with an expression because a process variable was missing.

Screen Shot of the Incidents Section

After clicking the process variables to add the missing one, a click on the incident will resolve it.

Clicking a row in the child process instances table opens the child instance.

Clicking the clear icon button on the top right will cancel the process instance.

Clicking a task opens the task page.

Task Page

The task page shows the details about the task including both the process instance variables (the global ones) and the task variables (the ones local to this scope).

Screen Shot of the Task Page

Click process instance variables or task variables to edit them.

The done icon button on the top right lets you complete the task.

Sidenav

Clicking the menu icon button in the toolbar opens the sidenav.

Screen Shot of the Sidenav

Query Elasticsearch

The query Elasticsearch page gives a simple way to query the information exported by the Camunda Elasticsearch Exporter using Elasticsearch SQL.

Screen Shot of the Query Elasticsearch Page

The indexes are shown across the top. Clicking an index name sets the SQL to show the most interesting fields.

You can edit the SQL and click Submit to execute a new query.

Users Page

The users page lets you define who is an Administrator (can add other users) and who is a Camunda Administrator (can use the rest of the app).

About Page

The about page shows the change log for Apex Camunda Explorer.

Information Flow

Diagram of the Information Flow

  1. Apex Camunda Explorer interacts with Zeebe through the Node Zeebe Client including:
    • Deploying process definitions
    • Starting process instances
    • Updating process variables
    • Completing tasks
    • Resolving incidents
  2. The Elasticsearch Exporter exports a stream of events to Elasticsearch
  3. Apex Camunda Explorer reads the events from Elasticsearch and creates or updates Apex Designer business objects including:
    • Process Definitions
    • Process Instances
    • Process Variables
    • Tasks
    • Process Incidents
  4. Apex Camunda Explorer saves the business objects to Postgres and queries them to feed the user interface

Installation

Check on the installation instructions on the Installing Apex Camunda Explorer page.

Powered by Apex Designer
Terms of ServicePrivacy Policy
© 2017-2022 Apex Process Consultants