Locating flaws in your process models can be a huge challenge when you have millions of process instances to sift through. Define filters in Optimize to narrow down your view to only a subset of process instances.
Camunda Optimize offers various ways of filtering your data, such as filter by:
- Instance state
- Flow Node Status Filter
- Start/End dates
- Executed Flow Nodes
- Assignee and Candidate Group
- Combined filters
There are two ways to filter the data in Optimize:
Here you can see how to select one of the instance filters in a Report:
Flow node data filters: These filters can be used if you not only want to filter instances but you additionally need to filter the content of instances e.g. Flow Nodes. Since not all filters can be applied on Flow Nodes, only compatible ones can be used as a Flow Node data filter.
Here you can see how to select one of the Flow Node filters in a Report:
There is no need to add the same filter as a Flow Node data filter and as an instance filter because Flow Node data filters will also filter instances. Therefore, adding a Flow Node data filter is enough.
Instance State Filters
Running/Completed Instances Only Filter
By default, a Report considers all process instances, regardless of whether they are still running or not. This behavior can be adjusted with the
Running Instances Only and
Completed Instances Only filters. Be aware that setting one of those filters (e.g.
Running Instances Only) while the other one is already set (e.g.
Completed Instances Only), will show a warning message since these two filters are incompatible with each other and will not show any data.
Canceled Instances Only Filter
Canceled Instances Only Filter is applied, the Report will only consider those instances which were terminated before completion, either
internally or externally. Be aware that adding this filter along with the
Running Instances Only will show a warning message since these filters are incompatible and will not show any data.
Non Canceled Instances Only Filter
As opposed to the
Canceled Instances Only Filter, applying the
Non Canceled Instances Only filter will make Optimize query only those instances which were not canceled during
their execution. This means that only active and completed instances are considered, externally or internally terminated instances are not included in the Report.
Suspended/Non Suspended Instances only Filter
By default, a Report considers all process instances, regardless of whether they are suspended or not. Adding this filter makes it possible to only evaluate process instances that are in the suspension state. Please note that if you have enabled history cleanup, this might affect the accuracy of this filer since the suspension state is imported from historic data. More information on the limitations that exist for the suspended instances filter can be found in the upgrade notes.
Flow Node Status Filter
Some Flow Nodes can take a relatively long time to complete, e.g. User Tasks or long-running service tasks. By default, a Report includes all Flow Nodes in the calculations, whether they are currently running, canceled or already completed. You can change this behavior by adding a Flow Node Status filter as a Flow Node data filter.
Adding one of the Flow Node status options will filter both instances and Flow Nodes according to the selected status:
- For instance Reports - The filter will only include instances that have at least one Flow Node matching the filter criteria. This behaviour can be seen if you are in variable, incident or raw data Reports.
- For Flow Node Reports - Flow Nodes that do not match the filter criteria will be excluded from the results. This behavior can be seen if you are in Flow Nodes or User Task Reports.
Here are the possible options for this filter:
- Running Flow Nodes Only - Your Report will only collect information from Flow Nodes that are currently running
- Completed Flow Nodes Only - Considers only successfully completed Flow Nodes
- Canceled Flow Nodes Only - Considers only canceled Flow Nodes
- Completed or Canceled Flow Nodes Only - Considers all completed Flow Nodes regardless of whether they were canceled or not
Please note that for incident Reports, Flow Node status filters always behave as instance filters and do not filter Flow Nodes.
In Optimize, there are two kinds of date filters: the start date filter and the end date filter. Applying the start date filter will result in a Report considering only process instances that started within the defined range of dates. The end date filter will work the same way for the end dates of the processes.
In order to have maximum flexibility, there are multiple options to define your start date filter:
One way is to set the filter to a current amount of time. e.g. today, this week, this month, etc… In such cases, the filter does not remain static but moves with time to deliver a subset of the process instances according to the selected time interval. In the above example, the filter will consider process instances started within this month until today.
Another way to define the filter is to set it to a previous amount of time. e.g. yesterday, last week, last month, etc. This filter also moves with time and is automatically adjusted to cover completed periods of time. To clarify, let’s take the following example: Today is Wednesday March 11th. If you set a date filter to ‘Last… + week’, you get all process instances that were started/ended from Monday March 2nd to Sunday March 8th. Now a Week passes and we have Wednesday March 18th. Applying the same filter now filters the process instances which were started/ended from Monday March 9th to Sunday March 15th.
If you want to cover previous time periods up the current moment of time, you can use the ‘Rolling’ option. To clarify this option, let’s take the following example: today is March 28th. If you set a date filter to the last three days, you get all process instances that were started/ended from March 26th to March 28th. Now a day passes and we have March 29th. Applying the same filter now filters the process instances which were started/ended from March 27th to March 29th.
If you do not want the filter to be dynamic, you can also select
Fixed Datewhich only considers process instances that were started or ended within a fixed date range, e.g. filter all process instances between 2018-01-01 and 2018-01-26. This range is fixed and does not change.
The start and the end date filters are independent and can be applied to a Report simultaneously. However, be aware that each of these filters can only exist once. If for example you define a new start date filter when another one already exists, the second one will replace the first one.
Also note that Reports with an end date filter applied will only consider completed process instances.
As an alternative way to create a start date filter, if your Report is visualized as bar or line chart, you can use your mouse to select the area you want to create the filter for.
Process Instance Duration Filter
Process Instance Duration Filter allows you to only regard process instances whose execution from start to end took a certain amount of time. For instance, you can filter process instances that took more than three days or less than five seconds. Note: This filter shows only completed process instances, since the total duration of running process instances is not yet known.
Flow Node Duration Filter
Flow Node Duration Filter is applied as an instance filter, it will only regard process instances where one or more Flow Nodes took a certain amount of time for their execution. For instance, you can filter process instances where a Flow Node took more than three days or less than five seconds.
If applied as a Flow Node filter, it will filter Flow Nodes and only show the Flow Nodes that were selected in the filter.
Please note that for incident Reports, Flow Node duration filters always behave as instance filters regardless of where they were defined.
Flow Node Filter
Retrieve only those process instances that executed certain Flow Nodes within your process by using the
Flow Node Filter. Selecting several values at once means that all the selected Flow Nodes need to have been executed at least once in the process instance lifetime. At the top of the Flow Node filter modal you can see a preview of the filter you are about to create. You can also filter process instances where certain Flow Nodes were not executed.
Variable Filter to retrieve only those process instances which hold the specified variable value for the selected variable.
Please note that variable filters can only filter for the final value of the variable. For instance, assume you want to analyze only those process instances which have the variable
department with the value
marketing. Say you also have some instances where this variable had the value
marketing at the start of the execution yet this was later reassigned to the value
sales.These instances will not be included in the filter.
The variable filter can only filter for variables of a primitive type. If you want to use complex types like object, you can use the Variable Import Customization feature to transform your object variables into primitive type variables.
Start creating a variable filter by searching for and selecting a variable from the suggested list of variable names.
There are four types of variables that you can filter for:
- Boolean variables: They can have the state
String variables: Two types of operators are available for variables of type String. You can either filter by an exact variable value (
is not) or filter by a substring (
does not contain).
For the operators
is not, the first 10 values are loaded and displayed. If the variable has more than 10 values a
Load Morebutton is shown to be able to extend the list as much as you need. You can also search through the whole list of values using the search input field. The list only contains variable values that already appeared in one of the instances of the process. If you want to filter by a variable value that is not in the list of available values, you can click the
+ Valuebutton and add a custom variable value.
In case the
isoption of the toggle button is selected, checking one or more values means that you want to see only those process instances where the variable value equals one of the checked values (this corresponds to the
oroperator in boolean logic). In case the
is notoption of the toggle button is selected, checking one or more values means that you want to see only those process instances where the variable value does not equal any of the checked values (this corresponds to the
andoperator in the boolean logic).
For the operators
does not contain, you can add one or multiple values that should match a substring of the variable value. For the
containsoperator, adding one or more values means that you want to see only those process instances where the variable value contains one of the entered values (this corresponds to the
oroperator in boolean logic). In case the
does not containoperator is selected, adding one or more values means that you want to see only those process instances where the variable value does not contain any of the entered values (this corresponds to the
andoperator in boolean logic).
There is an option to include the null or undefined values of the selected variable in the result. By using the same option, it is also possible to show all the values except the null or undefined by selecting the
is notoption of the toggle button.
Numeric variables: Here you have an input field to define whether the variable value in the process instance should be equal, not equal, less than or greater than a certain value. You can even add more input fields and apply the same operation several times at once. In case the
isoption of the toggle button is selected, adding one or more values means that you want to see only those process instances where the variable value equals one of the checked values (this corresponds to the
oroperator in boolean logic). In case the
is notoption of the toggle button is selected, adding one or more values means that you want to see only those process instances where the variable value does not equal any of the checked values (this corresponds to the
andoperator in boolean logic). In case the
is less thanor
is greater thanoption is selected, only one value can be entered.
Null or undefined options can be included or excluded from the results in a way similar to string variables.
- Date variables: This filters all instances where the selected date variable has a value within a specified date range. All the options that are available to configure Date filters are also available for date variables.
Similar to the other variables, there are two input switches that allow you to exclude or include process instances where a particular date variable is either
Assignee and Candidate Group filters
These filters allow you to include or exclude instances based on the assignee or the candidate group of at least one User Task of a particular process instance.
As shown in the example, it is possible to select one or more assignees or even filter for unassigned instances.
Please note that this filter has different behavior depending on where it was defined:
Flow Node data filterapplied on a User Task Report: this filter only includes User Task instances that satisfy all assignee/candidateGroup filters defined in the Report at once. Mutually exclusive filters like having both an inclusive and an exclusive filter on the same assignee do not yield any results in User Task Reports.
instance filter: this filter includes all process instances where at least one User Task satisfies one particular assignee/candidateGroup criterion. This means multiple mutually exclusive assignee/candidateGroup filter entries might still yield results for these Reports, e.g. if the process definition contains multiple User Tasks.
Please note that assignee/candidate filters will behave as instance filters for Flow Node Reports regardless of where they were defined.
This filter has different behavior depending on where it was defined:
instance filter: this filter will retrieve only those process instances that contain open, resolved, or no incidents (depending on your selection). Here are some examples where this filter can be useful:
Creating Reports that contain no incidents since the instances that have incidents have very long durations and are influencing your data.
To monitor all the instances from multiple engines that have open incidents.
On the other hand, this filter is not useful for counting the number of incidents because instances with an open or resolved instance filter might still contain instances from the other type.
Flow Node data filter: this filter will additionally filter the instance incident states to only include incidents of the same type (open or resolved). As an example, This filter can be used to count the number of open or resolved incidents since it considers the incidents of that type exclusively. This filter is currently only useful if you are in an incident view Report.
Please note that the incident filter does not currently filter Flow Nodes regardless of where it was defined.
All the previously mentioned filters can be combined. Only those process instances which match all of the configured filters are considered in the Report or analysis. The duration filter, Flow Node filter and variable filter can be defined several times. See the following screenshot for a possible very long combination of filters:
Everyone who has access to the Report can add their own filters, e.g. by creating a dashboard that contains that Report and using dashboard filters. Filters added in such a way are always combined with the filters set in the Report edit mode. That way, users can reduce the set of process instances that are considered when evaluating the Report, but not increase the number of instances evaluated above the set the Report author specified. Users can get access to a Report via the sharing functionality or if the Report is in a shared collection.