Filtering Studio Views
When creating and editing a Studio View, you can add PQL based predefined filters to the View and enable temporary filters for your App user. These filters allow you or an app user to display only the data that meets specified conditions, such as filtering data based on a data range or show information specific to an object or category.
Predefined filters: These are filters that are applied to the data when the View is being created or edited, with the published version of the View then showing already filtered data. You can set predefined filters on a Knowledge Model level, for the whole View, a tab within a View, and on individual components.
To learn how to configure predefined View filters, see: Setting predefined filters.
Temporary filtering options for App users: You can also enable or disable the ability for App users to apply temporary filters to published versions of your View and the individual components within the View. These temporary filters can be set per user, with any filters applied by the user being persisted and applied the next time they load the View.
To understand how to configure temporary filtering options for App users, see: Temporary filters for Apps.
Setting predefined filters
When creating or editing Studio Views, you can configure the following predefined filters for your View. These filters are added to the existing View draft and will only be available in your Apps once that version of the View has been published.
By creating Knowledge Model (KM) filters, you can write a Filter Statement in PQL that is applied to either the component it is being used in or across all objects within the KM (known as a Global Filter). KM filters aren't visible to the user when viewing the published version of the View as an App.
In this example, a global filter has been created to indicate if the invoice for an order has been billed. The Filter Statement (PQL) for this KM filter is:
FILTER o_celonis_DeliveryItem.IsBilled = 1;
As this is a global filter, the filter is already applied to Studio Views where it is referenced. For KM filters that aren't global filters, they can be used when configuring your Views or components within Studio.
For more information about KM filters, see: Filters.
When editing your Studio View, you can configure predefined filters for all users when the View is published and viewed as an App. These filters can be configured by adding existing KM filters to the View and / or by creating a custom View filter. You can add multiple filters to your View, including multiple KM filters and custom filters.
Adding KM filters to a View
In View edit mode, click Filters - Saved filters:
Then search for an select the KM filter you want to apply to this View. In this example, we've searched for 'Last' as our search term and selected to filter on the Last 7 days:
Creating a custom View filter
You can also create a PQL based custom View filter for your View using the Filter Editor.
To create a custom filter, click Filters - Custom filter.
This opens the Filter Editor, allowing you to create your PQL based filter statement. See: Using the Filter Editor.
Predefined View filter settings
After adding a KM filter or a custom filter to your View, it appears on the toolbar.
You can then click the Filter settings icon where you have the following settings:
Display name: A name label for the filter when viewed in edit mode.
Hide from user: When enabled, this hides the applied filters in the published version of this View. The filter is still applied to the data, the user just doesn't see that the data is being filtered. By default, the filter will be visible for the App user.
Read-only for user: When enabled, the user can see that a filter has been applied to the View but they aren't edit or disable it.
Remove filter: This removes the filter from the View. If you're removing a KM filter, the filter is still saved to the KM. If you're removing a custom filter that hasn't been saved to the KM, you must create it again to re-apply it to the view.
View or hide case count indicator
In View edit mode, you can show or hide the case count indicator for your published Apps. This indicator shows you the percentage and total numbers of cases available in the current View, which updates based on the filters applied to the data.
This case count data comes from the following sources:
Case-centric: The case count is based on the case table defined in the Data Model.
Object-centric: The case count is based on the lead object in the default event log for the perspective.
Example with no filters applied: 100% of the cases are visible, which is over 775k.
Example with filters applied: 18% of the cases are visible, which is 139k from the total of 775k available.
You can also add Knowledge Model filters to individual tabs within a View, available in Views with two or more tabs. These filters are not visible to the App users in a published App.
To add a KM filter to a tab, click Tab settings - Set filter:
You can then edit or delete the tab filter by clicking either the Edit Filter button on the tab or returning to Tab settings:
You can configure predefined filters for individual components within your View, allowing you to either select from an existing Knowledge Model filter or write a PQL statement for the component.
To configure a predefined filter for a component, open the component settings menu and click the Filter icon:
This takes you into the PQL Editor, allowing you to write a PQL statement for the component. For more about the PQL Editor, see: PQL editor.
Using the Filter Editor
You can use the Filter Editor to write custom PQL filter statements for your Views and tabs based on the tables provided in your Data Model and your Knowledge Model.
When creating your custom filter, you have the following options:
Add data with and without transformations
By clicking the table itself, you can add this to your PQL reference without any transformations.
Alternatively, click + and you select an aggregation function to apply to your filter statement.
Add Knowledge Model filters and variables
You can also use the Filter Editor to add existing KM filters or variables to your filter statement:
Configure filter settings
When creating your custom filter, you have the following options:
Save to KM: This allows you to save your custom filter to your Knowledge Model, allowing you to reuse it across all package assets using that KM.
Display name: A name label for the filter when viewed in edit mode.
Hide from user: When enabled, this hides the applied filters in the published version of this View. The filter is still applied to the data, the user just doesn't see that the data is being filtered.
Read-only for user: When enabled, the user can see that a filter has been applied to the View but they aren't edit or disable it.
View PQL references
The Filter Editor also includes a library of PQL references, giving you further information and syntax references for all available PQL functions.
You can configure advanced filters for your View when in Edit Mode by clicking View Settings, allowing you to enable and configure attribute and process filters:
Attribute filter: This filter allows users to select objects based on specified attributes, like country "Belgium" or start date "February 2, 2015". See: Enabling and using attribute filters
Process filters: By enabling process filters, users can filter based on:
Process flow filter: Select objects where an event is or isn't followed by another, e.g., "Invoice sent" followed by "Invoice canceled".
Event filter: Select objects based on their flow through specified events, such as objects starting with or including "Create Order".
Throughput time filter: Select objects where the duration between two events is faster/slower than specified, e.g., "Item sent" to "Item received" in under 3 days.
For more about process filters, see: ???
When an attribute filter is enabled, the user can click Filters - Attribute filter and select from the available Data Model tables and columns to apply a filter.
For example, filtering on customers based in Belgium:
When attribute filters aren't enabled (or are disabled), the app user can still apply filters (such as component filters as shown in the example), however the attribute filter option is not available:
Search based filters
Users can also configure more advanced filters for their View by using the Search feature. This gives users the ability to apply filters based on terms to include, exclude, and apply AND / OR conditions that are independent of the events listed.
In this example, the search feature is used to filter the view to show where 'engine' as listed as a material type:
Search filters can also be combined with selecting from the event list, creating an OR filter. In this example, the filter will return data where either 'engine' or the selected 'ethylene' material type are used:
By enabling process filters, users can filter based on:
Process flow filter: Select objects where an event is or isn't followed by another, e.g., "Invoice sent" followed by "Invoice canceled". See: Using process flow filters.
Event filter: Select objects based on their flow through specified events, such as objects starting with or including "Create Order". See: Using event filters.
Throughput time filter: Select objects where the duration between two events is faster/slower than specified, e.g., "Item sent" to "Item received" in under 3 days. See: Using throughput time filters.
Process filters require at least one event log to be selected, with the option to select from existing event logs in the same Knowledge Model as this View or create a new event log using the PQL editor. For more information about event logs, see: Event logs.
By default, only the default event log as defined in the Data Model will be selected. You can change the default and add more event logs by clicking Settings:
You then have the following options:
View and select existing event log: View and select from existing event logs in the same Knowledge Model as the view.
Set as default: If multiple event-logs are selected, the default one will be used first when filtering a process.
Edit event log: This edits the existing event log in the Knowledge Model. By editing existing event logs, you may impact other content where this event log is being used.
Duplicate event log: This creates a copy of the event log within the Knowledge Model.
Create Event log: This opens the in-line event log creator, with any event logs created saved to the Knowledge Model.
When process filters enabled, users can apply process flow filters by clicking Filters - Process flow and then selecting the event log to use, the From and To events, and the connection between the two events:
The following connection types can be selected:
Directly followed by
Followed anytime by
Not directly followed by
Never followed by
In this example, a process flow filter is being used to show only data where an order is received, the item is ready, but the customer hasn't paid:
When process filters are enabled, users can apply event filters by clicking Filters - Event filter and then selecting at least one event to filter the view by.
In this example, the view will be filtered to only show sales order item results that include a create customer invoice event (which in this case is 67% of the cases in the current view):
When process filters are enabled, users can apply throughput time filters by clicking Filters - Throughput time filter and then configuring the following:
Lead object (object-centric): For object-centric Data Models, the throughput time for between the selected events will be calculated from the perspective of the selected lead object. In the example below, the 'Sales Order Activity' object has been selected.
Event log (case-centric): For case-centric Data Models, the throughput time between the selected events will be calculated from the perspective of the selected event log.
From event: Select the event you want to start the filter from. In the example below, the 'Confirm Order' event has been selected.
To event: Select the event you want to end the filter based on. In the example below, the 'Change price' event has been selected.
Time period: Choose the time period you want to base the filter on. In the example below, the time period is from 0 to 30 days.
By enabling process filters, users can filter based on:
Process flow filter: Select objects where an event is or isn't followed by another, e.g., "Invoice sent" followed by "Invoice canceled". See: Using process flow filters.
Event filter: Select objects based on their flow through specified events, such as objects starting with or including "Create Order". See: Using event filters.
Throughput time filter: Select objects where the duration between two events is faster/slower than specified, e.g., "Item sent" to "Item received" in under 3 days. See: Using throughput time filters.
Process filters require at least one event log to be selected, with the option to select from existing event logs in the same Knowledge Model as this View or create a new event log using the PQL editor. For more information about event logs, see: Event logs.
By default, only the default event log as defined in the Data Model will be selected. You can change the default and add more event logs by clicking Settings:
You then have the following options:
View and select existing event log: View and select from existing event logs in the same Knowledge Model as the view.
Set as default: If multiple event-logs are selected, the default one will be used first when filtering a process.
Edit event log: This edits the existing event log in the Knowledge Model. By editing existing event logs, you may impact other content where this event log is being used.
Duplicate event log: This creates a copy of the event log within the Knowledge Model.
Create Event log: This opens the in-line event log creator, with any event logs created saved to the Knowledge Model.
When process filters enabled, users can apply process flow filters by clicking Filters - Process flow and then selecting the event log to use, the From and To events, and the connection between the two events:
The following connection types can be selected:
Directly followed by
Followed anytime by
Not directly followed by
Never followed by
In this example, a process flow filter is being used to show only data where an order is received, the item is ready, but the customer hasn't paid:
When process filters are enabled, users can apply event filters by clicking Filters - Event filter and then selecting at least one event to filter the view by.
In this example, the view will be filtered to only show sales order item results that include a create customer invoice event (which in this case is 67% of the cases in the current view):
When process filters are enabled, users can apply throughput time filters by clicking Filters - Throughput time filter and then configuring the following:
Lead object (object-centric): For object-centric Data Models, the throughput time for between the selected events will be calculated from the perspective of the selected lead object. In the example below, the 'Sales Order Activity' object has been selected.
Event log (case-centric): For case-centric Data Models, the throughput time between the selected events will be calculated from the perspective of the selected event log.
From event: Select the event you want to start the filter from. In the example below, the 'Confirm Order' event has been selected.
To event: Select the event you want to end the filter based on. In the example below, the 'Change price' event has been selected.
Time period: Choose the time period you want to base the filter on. In the example below, the time period is from 0 to 30 days.