Filtering in QPR ProcessAnalyzer: Difference between revisions

From QPR ProcessAnalyzer Wiki
Jump to navigation Jump to search
(33 intermediate revisions by 2 users not shown)
Line 1: Line 1:
'''Filters''' define a subset of cases and events in the process analysis model. This subset of data is used for all analysis. Filters consist of a list '''filter rules''', which are applied in the defined order. Cases/events are excluded if there is a single filter rule, that excludes the cases/events (AND type of logic, instead of OR logic).
'''Filters''' define a subset of cases and events in the model, e.g., certain region or time period. Filter consists of a list of filter rules, that are criteria defining which cases/events are included and which are excluded from the resulting dataset. Filters are very powerful feature in QPR ProcessAnalyzer, because any filter can be applied to any analysis and chart.


There are two types of filtering available in QPR ProcessAnalyzer Excel Client: Runtime Selection and Include/Exclude Filters (more information below).
Filter consists of one or several '''filter rules''', which are applied in the defined order starting from the leftmost. The evaluation order matters in some rules, because the rule is evaluated to the eventlog that is the result of the previous rule evaluation. For example, if excluding event types, number of events in cases change, and thus subsequent filter rules may match do different cases.
== Manage Filters ==
The Manage Filters dialog is used for selecting and managing filters in the current model. The following information for the filters is provided:
* '''Name''': shows the name of the filter.
* '''Publish Mode''': shows whether the filter is available only for you (Private), everyone (Public), or if the filter is the default filter for the model (Model Default). The default filter is also a public filter. If you have Administrator rights to the model, you can set any configured Public filter to be the Model Default. This change will then affect all users of the model and the filter previously set as Model Default will become Public.
* '''Created On''': the date and time on which the filter in question was applied.
* '''Created By''': the ID of the user who created the filter.
* '''Filter Rules''': the number of filter rules the filter has.
* '''Opens''': the number of times the filter has been opened.
* '''Last Modified On''': the date and time on which the last modification to the filter was made.
* '''Last Modified By''': the user who made the last modification to the filter.


== Case Sample Size ==
Filter excludes a case/event, if there is a single filter rule that excludes the case/event (i.e., there is an AND type of logic between the filter rules). Filtering functionality is described in more detail in the [[Process_Mining_Concepts|concepts section]].
'''Sampling''' is used limit the number of cases in a filtered dataset. '''Sample Size''' is defined for a filter. If there are more cases in the filtered dataset than the defined sample size, part of the cases are randomly dropped out so that there are exactly the sample size number of cases in the filtered data. To disable sampling, select the '''All''' radio button. To change the sample size, enter a number into the '''Limit To''' box or use the arrows to decrease or increase the number of cases. Note that the sample is selected randomly every time the filter is calculated, and thus it may contain different cases.


==Filter Publish Mode==
== Saving filters ==
You can also define whether to set the filter to be published only to you (Private), everybody (Public), or if the filter is the default filter for the model (Model Default).
You can save the set of filter rules that are in the header, so that they can be retrieved easily. Filter are saved to the model that is currently open. Saving is done by hovering the mouse over the filter dropdown menu (without clicking) and choosing '''Save as new filter'''. There must be at least one filter rule available to be able to save the filter. This will prompt a pop-up window where you can name your filter.


== Other Operations in Filter Properties ==
[[File:Savingfilters.png|1100px]]
Clicking the '''Export...''' button gives you the option of exporting the filter to a '''.pacm''' file or the events to an Excel sheet. Note that when exporting a filter, only visible cases, events and attributes are included in the destination. That is, if the filter has any filter rules, then only cases, events and attributes visible for that filter will be exported.


Clicking the '''Save As New Model''' button will save the filtered data as a new model. Only the filtered cases, events and attributes are included to the new model.
You can also set the '''Privacy mode''' as follows:
* '''Private''': Filter is available only for you.
* '''Public''': Filter is available for all users that can use the model. The creator and model administrators can change the public filter.
* '''Default Public''': Filter is public and in addition the default filter of the model. The default filter is set active for all users automatically when the model is opened. Only one filter can be the default filter pf the model, and when setting a filter as default, the previous default filter is changed to public.


== Filter Rule Types ==
== Turning off filter rules ==
Following filter rule types are available:
It's possible to turn off (disable) individual filter rules in a filter. When a filter rule is turned off, it's not applied, i.e. it doesn't have any effect on the calculation. The turned off filter rule is still preserved as part of the filter, and it's thus easy to turn the filter rule on again. This way, filter rules can be toggled on and off without removing them.
* '''Include/exclude cases based on case attribute values''': For example, include only those cases where case attribute "Account Manager" is "Patricia White" or "Mary Wilson".
* '''Include/exclude cases having certain event type(s)''': For example, include cases that have event types "Invoice Created" or "Invoice Paid" (either or both).
* '''Include/exclude cases having certain flow(s)''': For example, include cases that have a flow from "Outbound Delivery" to "Handling unit". To match, there must not be other events between those two events.
* '''Include/exclude cases based on case duration''': For example, include cases the case duration is over 50 days. Case duration is the last event timestamp minus the first event timestamp.
* '''Include/exclude cases based on flow duration''': For example, include cases the flow from "Sales Order" to "Outbound Delivery" is over 5 weeks.
* '''Include/exclude cases belonging to certain variation(s) (sequence of events)''': For example, include cases belonging to variation "Sales Order sent" -> "Invoice Created" -> "Invoice Paid".
* '''Include/exclude cases having certain event attribute value(s)''': For example, include cases having event(s) with event attribute "Organization" is "Finance".
* '''Include/exclude cases having certain part of variation''': For example, include cases where variation starts with "Sales Order sent" -> "Invoice Created" -> "Invoice Paid".
* '''Include/exclude event types''': For example, include event types "Sales Order sent", "Invoice Created" and "Invoice Paid".


There are two kinds of filter rules: case filter rules and event type filter rule. Case filter rules filter out cases, and the number of cases decreases. The event type filters filter out events, so the number of cases doesn't decrease but the process flow in individual cases may change as event types are left out. Note that event type filter rules may filter out all events of a case, which results in cases that don't have events at all. It's not possible to show those cases in flowcharts or calculated durations for them.
[[File:DisabledFilterRules.png|800px]]


A case has a '''Flow''' between events A and B means that the case has both events A and B and there are no other events between them. A case may have the same flow multiple times. '''Flow duration''' is the event B timestamp minus A timestamp. Note also that flows always has a direction: flow from A to B is different than flow from B to A.
== Filter actions ==
Users with [[Roles_and_Permissions#Roles_and_Their_Permissions|Analyzer]] role for the project can modify and delete saved filters (that are in models located in the project). You can do this by opening the filters list, hovering your mouse over a filter and clicking on the three dots. You have the following actions available:
* '''Properties''': Open filter properties dialog, where the filter name, privacy mode and filter rules can be modified.
* '''Duplicate''': Create a copy of this filter.
* '''Delete''': Delete the filter permanently.
* '''Replace''': Replace the rules of this filter with the currently selected rules in the header.
* '''Export''': Export the rules of this filter to a file (in JSON format).
* '''Import''': Replace the rules of this filter with rules imported from a file (in JSON format).


'''Variation''' means a sequence of events that a case goes through. A case always belongs to a certain variation. If another case has different events or they are in different order, the case belongs to a different variation. Duration between events doesn't matter in terms of which variation a case belongs.
== Filter rule types ==
When creating a new filter the following filter rule types are available:
* '''Cases by Case Attribute''': Select cases having specific case attribute values.
* '''Cases by Event Attribute''': Select cases having one or several events with specific event attribute values.
* '''Cases with Specific Events''': Select cases having one or several specific types of events.
* '''Cases Flowing Through''': Select cases having specific flow (i.e., direct transition between specific types of events).
* '''First Event in Case''': Select cases starting with specific event.
* '''Last Event in Case''': Select cases ending to specific event.
* '''Case IDs''': Select cases with specific case ID's.
* '''Variations''': Select cases belonging the specific variations.
* '''Events by Attribute''': Select events having specific events attribute values. This filter rule type is available only in Snowflake.
* '''Events by Type''': Select events having specific events types.


[[Category: QPR ProcessAnalyzer]]
Filter rules can be created for the dashboard (i.e., applied to all charts in the dashboard) by clicking the blue plus button in the header, or to specific charts in the chart settings in the '''Filter''' tab. When running the root causes analysis, the root causes criteria is also selected similar to filter rules.

Revision as of 20:54, 3 June 2022

Filters define a subset of cases and events in the model, e.g., certain region or time period. Filter consists of a list of filter rules, that are criteria defining which cases/events are included and which are excluded from the resulting dataset. Filters are very powerful feature in QPR ProcessAnalyzer, because any filter can be applied to any analysis and chart.

Filter consists of one or several filter rules, which are applied in the defined order starting from the leftmost. The evaluation order matters in some rules, because the rule is evaluated to the eventlog that is the result of the previous rule evaluation. For example, if excluding event types, number of events in cases change, and thus subsequent filter rules may match do different cases.

Filter excludes a case/event, if there is a single filter rule that excludes the case/event (i.e., there is an AND type of logic between the filter rules). Filtering functionality is described in more detail in the concepts section.

Saving filters

You can save the set of filter rules that are in the header, so that they can be retrieved easily. Filter are saved to the model that is currently open. Saving is done by hovering the mouse over the filter dropdown menu (without clicking) and choosing Save as new filter. There must be at least one filter rule available to be able to save the filter. This will prompt a pop-up window where you can name your filter.

Savingfilters.png

You can also set the Privacy mode as follows:

  • Private: Filter is available only for you.
  • Public: Filter is available for all users that can use the model. The creator and model administrators can change the public filter.
  • Default Public: Filter is public and in addition the default filter of the model. The default filter is set active for all users automatically when the model is opened. Only one filter can be the default filter pf the model, and when setting a filter as default, the previous default filter is changed to public.

Turning off filter rules

It's possible to turn off (disable) individual filter rules in a filter. When a filter rule is turned off, it's not applied, i.e. it doesn't have any effect on the calculation. The turned off filter rule is still preserved as part of the filter, and it's thus easy to turn the filter rule on again. This way, filter rules can be toggled on and off without removing them.

DisabledFilterRules.png

Filter actions

Users with Analyzer role for the project can modify and delete saved filters (that are in models located in the project). You can do this by opening the filters list, hovering your mouse over a filter and clicking on the three dots. You have the following actions available:

  • Properties: Open filter properties dialog, where the filter name, privacy mode and filter rules can be modified.
  • Duplicate: Create a copy of this filter.
  • Delete: Delete the filter permanently.
  • Replace: Replace the rules of this filter with the currently selected rules in the header.
  • Export: Export the rules of this filter to a file (in JSON format).
  • Import: Replace the rules of this filter with rules imported from a file (in JSON format).

Filter rule types

When creating a new filter the following filter rule types are available:

  • Cases by Case Attribute: Select cases having specific case attribute values.
  • Cases by Event Attribute: Select cases having one or several events with specific event attribute values.
  • Cases with Specific Events: Select cases having one or several specific types of events.
  • Cases Flowing Through: Select cases having specific flow (i.e., direct transition between specific types of events).
  • First Event in Case: Select cases starting with specific event.
  • Last Event in Case: Select cases ending to specific event.
  • Case IDs: Select cases with specific case ID's.
  • Variations: Select cases belonging the specific variations.
  • Events by Attribute: Select events having specific events attribute values. This filter rule type is available only in Snowflake.
  • Events by Type: Select events having specific events types.

Filter rules can be created for the dashboard (i.e., applied to all charts in the dashboard) by clicking the blue plus button in the header, or to specific charts in the chart settings in the Filter tab. When running the root causes analysis, the root causes criteria is also selected similar to filter rules.