Skip to main content
Version: 3.10.0

Define reports

In this section of the report builder, you are characterizing the output of the report. Basically, you are defining "I want to view ... grouped by ... visualized as ...". To understand better what "View" and "Group by" mean, you can use the analogy of a graph, where "View" is the y-axis and "Group by" is the x-axis.

First, you need to select which part of the data you want to view. Optimize differentiates between the view (e.g. process instance or flow node) and the measure (e.g. count or duration):

  1. Raw Data: View just a table with the actual data listed as rows. This can come in handy if you found interesting insights in certain process instances and need detailed information about those instances, or you are exploring a process definition with a limited number of instances. This report type also allows you to inspect raw object variable values.

  2. Process instance

  • Count: View how many process instances were executed.
  • Duration: View how long the process instances took to complete.
  1. Incident
  • Count: View how many incidents occurred on the process.
  • Resolution duration: View how long the incident took to get resolved.
  1. Flow node
  • Count: View how often the flow nodes (e.g. tasks) have been executed.
  • Duration: View how long each flow node took to complete.
  1. User task
  • Count: View how often each user task has been executed.
  • Duration: View how long each user task took to complete.
  1. Variable: View an aggregation of values for a specific numeric variable of the process definition.

It is possible to display both count and duration measures for a single view in the same report.

Subsequently, you need to define how to group the data. Think of it as applying a metric to your input, where you break up the data by date, flow nodes, variable values, or other properties. For that, you have different options:

  • None: Do not split up the data.
  • Flow nodes: Cluster the data by flow nodes.
  • User tasks: Cluster the data by user tasks.
  • Duration: Cluster the data by duration. Depending on the selected view, this can be the duration of process instances, flow nodes, or user tasks.
  • Start date: Group instances together that were started during the same date period or time, e.g. hour, day or month. Depending on the selected view, this can be the start date of process instances, flow nodes, or user tasks.
  • End date: Group instances together that were finished during the same date period or time, e.g. hour, day or month. Depending on the selected view, this can be the start date of process instances, flow nodes, or user tasks.
  • Running date of the process instance: Group process instances together that were running during the same date period or time, e.g. hour, day, or month.
  • Variable: Process instances with the same value for the selected variable are grouped together.
  • Assignee: Only available for user task views. Tasks are grouped together according to their current assignee.
  • Candidate group: Only available for user task views. Tasks with the same candidate group are grouped together.
  • Process: Only available for process instance reports with multiple definitions. Data from the same process is grouped together.

Finally, define how you want the data to be visualized. Examples are heatmap, table, bar, or line chart.

Not all the above view, group by, and visualization options can be combined. For instance, if you choose Flow Node: Count as view, the data is automatically grouped by flow nodes as no other combination would be valid.

All possible combinations can also be found in the following table:

ViewGroup byVisualize as
Raw DataNoneTable
Process instance: Count, Process instance: DurationNoneNumber
Process instance: CountStart Date, End Date, Running Date, Variable, Duration, ProcessTable, Chart
Process instance: DurationStart Date, End Date, Variable, ProcessTable, Chart
Incident: Count, Incident DurationNoneNumber
Incident: Count, Incident DurationFlow NodesTable, Chart, Heatmap
Flow Node: Count, Flow Node: DurationFlow NodesTable, Chart, Heatmap
Flow Node: CountStart Date, End Date, Duration, VariableTable, Chart
Flow Node: DurationStart Date, End Date, VariableTable, Chart
User Task: Count, User Task: DurationUser TasksTable, Chart, Heatmap
User Task: Count, User Task: DurationStart Date, End Date, Assignee, Candidate GroupTable, Chart
User Task: CountDurationTable, Chart
VariableNoneNumber
note

You might sometimes see a warning message indicating that the data is limited to a certain number of points. This happens because the available stored data, in this case is very large, and it is not possible to display all the data in the selected visualization.

Reports with a second "Group by" option

Using the second "Group by" option, it is possible to apply another grouping to your data to display extra details such as dates, variable values, or assignees. This option will be shown below the first "Group by" option if the current report combination supports it. Here is an overview of the reports that supports a second "Group by":

Flow node reports

Flow node names can be applied as a second "Group by". If the report contains multiple process definitions, the data can also be grouped by process as a second "Group by".

User task reports

User task names, assignees, and candidate groups can be applied as a second "Group by".

For example, if your report is grouped by assignee/candidate group, it is possible to add another grouping by user task to see which user task your users/group are working on or have completed in the past. If the report contains multiple process definitions, the data can also be grouped by process as a second "Group by".

note

Reports using assignee/candidate groups are only available in Camunda 7.

Distributed User Task report

Refer to the table below for an overview of all report combinations that support a second "Group by":

ViewGroup bySecond group by
User Task Count, DurationUser TasksAssignee, Candidate Group, Process (only for multi-definition reports)
User Task Count, DurationStart Date, End DateAssignee, Candidate Group, User Tasks, Process (only for multi-definition reports)
User Task Count, DurationAssignee, Candidate GroupUser Tasks, Process (only for multi-definition reports)
User Task CountDurationUser Tasks, Process (only for multi-definition reports)

Process instance reports

Refer to the table below for the process instance count and duration reports that support a second "Group by":

ViewGroup bySecond group by
Process Instance Count, DurationStart Date, End DateVariable, Process (only for multi-definition reports)
Process Instance Count, DurationVariableStart Date, End Date, Process (only for multi-definition reports)
Process Instance CountRunning Date, DurationProcess (only for multi-definition reports)

The diagram below shows a report grouped by Start Date and a boolean variable:

Distributed process instance report