Skip to main content

Celonis Product Documentation

KM - Filters

Why do they exist?

One of the most powerful capabilities of Studio and the PQL engine is data filtering using Filters. Filters provide a way to select only those data records that match certain criteria. Filters are used in various places and Studio services. By storing and maintaining Filters in a Knowledge Model, they can be easily reused and managed in one place.

What do they do?

Filters apply a refining condition to a data object in Studio to show a result that complies with this condition. The refining condition is defined using PQL and is known as a Filter Statement. Once a filter is applied to a component, the component will only show data that complies with the condition specified on the Filter.

How are they used?

Filters are used to refine the data shown across a multitude of components within Views. These can be applied to all components of the following types:

  • KPIs & Attributes

  • Charts & Tables

  • Anomalies & Root Causes

  • Execution & Action Components

  • Filter Components

  • Explorers

  • Design Components

  • Form Components

Filters can be created as individual filters or as global filters. Individual filters impact only the components in which they are activated, whereas global filters are used to refine the PQL statements of all the objects within the Knowledge Model in which they are activated. If there is a global filter active in your Knowledge Model you will see the "Global Filter Active" tag on top of the KM preview:

Screenshot_2022-11-08_at_14_22_05.png
How are they Built?
How are they Built?

In the Visual Editor, Filters are created from inside the Filters Tab in the Knowledge Model. The Filter section contains all the Filters that exist in the Knowledge Model. You can create a new Filter by clicking on the plus button on the top right of the Filter section:

Screenshot_2022-11-08_at_14_20_13.png

This will lead you to the Filter Creation window, which contains all Filter associated value assignments. These associated value assignments are the following:

General Settings:

  • Display Name: A human-readable label used in the user interface.

  • Short Display Name: Shorter human readable label for the object shown automatically on the Views whenever the Display Name is truncated. Can contain max 20 characters.

  • ID: A technical identifier used for unique referencing of this Filter.

  • Description: A human-readable description for the Filter.

  • Filter Statement: Defines the criteria which will be used to filter the data this Filter is applied to. This criterion is defined using PQL statements.

  • Global: Indicates whether the filter is a Global Filter.

Screenshot_2022-11-08_at_13_13_13.png
<p></p>
YAML

In YAML, Filters are defined by using the following value declaration formats:

- id: COUNTRY_FILTER
  displayName: "Country filter"
  description: "Filters down to DE and US data"
  pql: FILTER "TABLE"."Country" IN ('DE','US')
  global: true
+[[where,]]+
  • id: A unique technical identifier used to reference this Filter. Must be unique within all Filter in the KM.

  • displayName: A human-readable label used in the user interface.

  • shortDisplayName:Shorter human readable label for the object shown automatically on the Views whenever the displayName is truncated. Can contain max 20 characters (optional).

  • description (optional): A human-readable description for the Flag.

  • pql: Contains the PQL query that states the condition used to synthesise the data.

  • global: Indicates whether the filter is a global filter that will be applied to the PQL of all the objects in the KM.