Celonis Product Documentation

First, we will start to set up a KPI. This KPI will serve as an input for the execution-gap component since we want to render multiple Anomalies which impact a certain KPI.

For this go to the KM and add a new KPI:

Knowledge Model

kpis:
  - id: KPI_TOTAL
    displayName: Total count
    description: Total count
    pql: COUNT_TABLE("VBAK")
    desiredDirection: INCREASE                                                # Make sure they have the attribute "desiredDirection" defined
    format: .3s

In this set, you connect the KPI with Anomaly and provide the required information for rendering the Anomaly in the execution gap component.

You connect the KPI with the flag, which is used for the impact calculation.

Using the Visual Editor

In the Visual Editor, Flags can be created from inside the Records tab in the Knowledge Model or within the Flag specific tab in the Knowledge Model Main Listing. The Flag section within the Record contains all the Flags that exist for this Record, whereas the individual Flag Tab contains all the Flags that exist in the Knowledge Model. You can create a Flag from inside a Record by clicking on the plus button on the Flag section:

If you want to create a Flag from inside the Flag Tab in the Knowledge Model Main Listing, you can click on the Create Flag button on the top right corner of the Flag Main List:

Both of these options will lead you to the Flag Creation window, which contains all Flag associated value assignments. These associated value assignments are the following:

Prerequisite Fields:

General Settings:

Flag Settings:

Let's assume you are using Studio to improve an Order Management process. You heard from a colleague that a lot of manual tasks need to be completed in order to create a new sales order. To verify this, you want to see the impact the 'Create Sales Order' Activity has on the O2C Automation Rate KPI that contains the automation rate for this process. To see the impact this Activity has in the Automation Rate, you add a Flag for all 'Create Sales Order' activities within your process and relate it to the O2C Automation Rate KPI. You do this with the Visual Editor, which results in the following:

You now want to see how your Automation Rate is impacted by only selecting the 'Create Sales Order' activities, so you click on the O2C Automation Rate KPI in your Impacted KPI List. This switches the preview to the Impact Calculation Preview, which shows you the following values:

By looking at the updated Impact Calculation, you see that while the overall Automation Rate for your process is 80%, the Automation Rate for your 'Create Sales Order' Activity is only 76%. This indicates a difference of 4% between your global Automation Rate and your flagged Automation Rate. With this you can conclude that your 'Create Sales Order' Activity requires more manual input than the rest of the Activities in the process.

Using YAML

anomalies:
  - id: ANOMALY_EXPRESS_1
    displayName: Anomaly Express delivery 1                                                  # Defines the display name of the anomaly in the execution gap component
    description: Anomaly Express delivery 1
    flag: FLAG_EXPRESS_1                                                                     # Reference a flag definition from a record. Make sure this record has an identifier defined (record.identifier.pql). It is needed to calculate the number of occurrences.
    kpis:                                                                                    # References a list of KPIs in the Knowledge Model. Make sure those KPIs have the attribute "desiredDirection" defined. It is important for the correct display of the impact.
      - kpiId: KPI_TOTAL
        #impactCalculation: IMPACT_FOR_PERCENTAGES                                      optional - reference a kpi definition as your custom impactCalculation for this kpi and anomaly
    knowledgeObjectId: ANOMALY                                                               # The knowledge model object will be used when creating the Profile View
    #customAttributes:                                                                         optional - allows to pass custom attributes to the Profile View
      #prop1: anomaly_express_1_customattribute1
      #prop2: anomaly_express_1_customattribute2
  - id: ANOMALY_EXPRESS_7
    displayName: Anomaly Express delivery 7
    description: Anomaly Express delivery 7
    flag: FLAG_EXPRESS_7
    kpis:
      - kpiId: KPI_TOTAL
    knowledgeObjectId: ANOMALY
    #customAttributes:
      #prop1: anomaly_express_7_customattribute1
      #prop2: anomaly_express_7_customattribute2

To flag cases which impact our initially-defined KPI, go to Records and add flags. Please find below an example configuration of flags:

Knowledge Model

records:
  - id: VBAK
    displayName: Vbak
    pql: '"VBAK"'
#   ...
    flags:                                                          # Insert the following flag configuration
      - id: FLAG_EXPRESS_1
        displayName: Flag Express 1
        description: Flag Express 1
        pql: "\"VBAK\".\"VTWEG_TEXT\" = 'Express 1'"                # Defines the condition when a record.attribute should be flagged for calculating the impact on a KPI
      - id: FLAG_EXPRESS_7
        displayName: Flag Express 7
        description: Flag Express 7
        pql: "\"VBAK\".\"VTWEG_TEXT\" = 'Express 7'"

Now go to the View where you want to place the execution-gap component. Here you can insert the following configuration:

View

id: execution-gap-list-0d1ac17b-dd43-4e75-84f8-9bb669000d66
type: execution-gap-list
settings:
  kpi: KPI_TOTAL

You cannot click on an Anomaly to retrieve more details. To do this, you must create a new Profile View:

Profile View

metadata:
  key: execution-gap-profile-view
  template: false
  name: Execution Gap Profile View
  knowledgeModelKey: knowledge-model
  knowledgeObjectId: ANOMALY                                                         # References the knowledgeObjectId (see Knowledge Model configuration) for the respective anomaly
  profileView: true                                                                  # Defines that the it's a profile view
variables:
  - name: id
layout:

metadata:
  key: execution-gap-profile-view
  template: false
  name: ${anomaly.displayName}                                                                   # Example of Object variable. It takes the displayName straight from the KM
  knowledgeModelKey: knowledge-model
  knowledgeObjectId: ANOMALY
  profileView: true
variables:
  - name: id
  - name: anomaly                                                                                                               # Defines an object variable of type anomaly
    defaultValue:
      id: ANOMALY_EXPRESS_1
layout:
  ...
components:
  - id: text-box-5a30b628-f9f1-4f30-9f05-a351cbaf99ae
    type: text-box
    settings:
      title: Object based values
      content: |
        <p><strong>id:</strong> ${anomaly.id} <p/>                                              # Displays the different object variables, which are available from the KM
        <p><strong>name:</strong> ${anomaly.displayName} <p/>
        <p><strong>description:</strong> ${anomaly.description} <p/>
        <p><strong>flag:</strong> ${anomaly.flag} <p/>
        <p><strong>prop1:</strong> ${anomaly.customAttributes.prop1} <p/>
        <p><strong>prop2: </strong> ${anomaly.customAttributes.prop2} <p/>
        <p><strong>prop3: </strong> ${anomaly.customAttributes.prop3} <p/>