Skip to main content

Celonis Product Documentation

KM - Event Logs

Why do they exist?

Event logs provide an x-ray into your organization’s processes and help identify any inefficiencies. Event logs are defined using Activity tables that contain the Activity, Case and Timestamp data. The KM event logs help in defining the activities, KPIs and transitions (for Multi Event Logs) that should be shown in visualisation components like the process explorer. This data is contained within Activity Tables in your Data Model.

What do they do?

Event Logs take the sequence of events described in Activity Tables and allow you to store these as objects in the Knowledge Model. This enables the content of your Activity Tables for you to use inside Views.

How are they used?

Event logs are used by components like the Process Explorer.

How are they created?

Event log metadata contains all the necessary configurations to visualise single or multiple processes in the process explorer. This includes:

  1. Event logs: Define the activities that should be visualized on the process graph.

  2. Transitions: Define the relationships between different event logs. This is applicable when multiple event logs are visualized on the process graph.

  3. KPI Views: Define the KPIs that should be displayed on activities and connections in the process graph.

1. Event Logs

Event logs can be created using either the Visual Editor or the Code Editor.

Using the Visual Editor

Using the Visual Editor, Event Logs can be created and edited from inside the Event Log tab in the Knowledge Model. This tab contains all the Event Logs that exist in the Knowledge Model. You can create a new Event Log by clicking on the plus button on the top right corner of the Event Log main list. This will lead you to the Event Log creation, which contains all Event Log associated value assignments.

Screenshot_2022-10-24_at_11_48_56.png

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 unique technical identifier used to reference this Attribute. Must be unique within all Attributes in the Record.

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

  • Internal Note: A field only visible within the Knowledge Model.

Event Log Specific Fields:

  • PQL Formula: Contains the PQL query that links an Activity Table to your Event Log.

  • Record: Connects a Record to the Event Log to link a profile View.

    Screenshot_2022-11-08_at_12_01_32.png

Using YAML

In YAML, Eventlogs have the following value declaration format:

 eventLogsMetadata:
 eventLogs:
   - id: O2C_EVENTLOG
     displayName: Order Management
     pql: '"O2C_ACTIVITY_TABLE"."ACTIVITY_EN"'
     recordID: O2C_ACTIVITY_TABLE

Where:

  • id: A unique technical identifier used to reference this Event Log. Must be unique within all Event Logs in the Record.

  • 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: A human-readable description for the event log (optional)

  • pql: Contains the PQL query that links an activity table to your event log.

  • recordID: Is the id the Record connected to the event log to link a profile View.

2. Transitions

If multiple event logs are involved, the process explorer can display the transitions between the event logs. Transitions also can be defined in the KM using either the Visual Editor of the Code Editor.

Using the Visual Editor

Transition Specific Field Fields:

  • Transition Name: With the name of the Event Logs that are connected through the transition.

  • Transition Type: To specify the type of Transition that will be created between the Event Logs. Follow this link to learn more about Interleaved and Non-Interleaved Transitions.

    Screenshot_2022-11-08_at_13_06_38.png

Note

The preview for your Event Log will only show a Transition if the selected Event Logs have cases that flow through both processes. If the Event Logs have no common cases, the preview will not show any connection between the Event Logs.

Using YAML

Transitions are listed under a separate category in YML, which has the following declaration format:

transitions:
   - id: O2C_P2P
     displayName: O2C to P2P
     firstEventLogId: O2C_EVENTLOG
     secondEventLogId: P2P_EVENTLOG

Where:

  • id: A unique technical identifier used to reference this Event Log. Must be unique for all Event Logs in the Knowledge Model.

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

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

  • firstEventLogId: With the ID of the first event log involved in the transition.

  • secondEventLogId: With the ID of the second event log involved in the transition.

3. KPI Views

A KPI View is a collection of Activity and Connection KPIs shown on the process explorer. Multiple KPI Views can be created for an event log. Depending on the use case the appropriate KPI view can be picked by the end user for display on the process graph.

The process explorer has five in-built KPI Views.

Display Name

ID

Case frequency

STANDARD_KPI_CASE_COUNT

Activity frequency

STANDARD_KPI_ACTIVITY_COUNT

Throughput Time (Average)

STANDARD_KPI_AVG_THROUGHPUT_TIME

Throughput Time (Median)

STANDARD_KPI_MEDIAN_THROUGHPUT_TIME

Throughput Time (Trimmed Mean)

STANDARD_KPI_TRIMMED_MEAN_THROUGHPUT_TIME

Currently, KPI Views can only be created using the YAML editor. The below set of attributes and objects have to be defined for a KPI View.

Each KPI View definition will have the three parts below:

  1. KPI View Overview definition

  2. Event Log KPIs definition

  3. Node and Edge KPI definition

1. KPI View Overview definition

The KPI Overview section contains general information about the KPI View. This section is used to provide details about the group of KPIs that are bundled together as one KPI View.

Attribute

Required

Type

Description

id

true

Free text

A technical identifier used for unique referencing of this KPI View.

displayName

true

Free Text

A human-readable label used in the user interface.

Screenshot_2022-12-05_at_16_32_11.png

icon

false

List of Icons

To represent the KPI View in the KPI switcher of the process explorer

Screenshot_2022-12-05_at_16_32_44.png

description

false

Free Text

A human-readable description for the KPI View.

internalNode

false

Free Text

A section that can be used by developers to add comments

type

false

Options:

INTERLEAVED/NON-INTERVEAVED

2. Event Log KPIs definition

Each KPI View holds KPI definitions for multiple event logs (if multi event logs are used in the process explorer). The KPI definitions relevant for one event log are grouped together under one eventLogKPIs block.

Attribute

Required

Type

Description

id

true

Free text

A technical identifier used for unique referencing of this Event Log KPIs.

eventLogId

true

ID of Event Log

The technical identifier of the event log while defining it in the Event Log section of the KM - Event Log Metadata

displayName

true

Free Text

A human-readable label used in the user interface.

internalNode

false

Free Text

A section that can be used by developers to add comments

nodeKpiIds

false

KPI ID

Deprecated

edgeKpiIds

false

KPI ID

Deprecated

3. Node and Edge KPI definition

Within each event log section of a KPI View, you can define the node (on activities) and edge (on connections) KPIs that should be visible. The below attributes are required to define the KPIs:

Attribute

Required

Type

Description

id

true

Free text

A technical identifier used for unique referencing of KPIs.

kpiId

true

ID of KPI

The technical identifier of the KPI while defining it in the KM - KPI section

icon

false

List of icons

To represent the KPI on the node/edge in the process graph and the node/edge pop-ups when the user clicks on them.

Screenshot_2022-12-05_at_16_33_11.png

alertMetrics (object)

false

Object (see required attributes below)

To display alerts on activities and connections in the process graph.

You can configure alerts on activities/connections which will be based on the KPIs in the KPI View. This will help the end user identify inefficiencies in the process without manually exploring the process by themselves.

Attribute

Required

Type

Description

Id

true

Free text

A technical identifier used for unique reference

pql

true

PQL

The logic needed to apply alerts on the activities/connections should be defined here in PQL. The end user will see alerts based on numeric value computed.

Note: As of now, only top 5 activities/connections with the highest value will have alerts.

Screenshot_2022-12-05_at_16_33_45.png

message

true

Free text

The message configured here will be displayed on the activities/connections where the alert is visible

Sample YAML

kpiViews:
   - id: sample_kpi_view
     displayName: Sample KPI View
     icon: gauge
     description: Sample KPI View
     internalNote: This is a sample KPI View
     eventLogKpis:
       - id: sample_kpis
         eventLogId: achse
         displayName: Sample KPIs
         internalNote: for one event log
         nodeKpiIds:
           - KPI1
         edgeKpiIds:
           - KPI2
         nodeKpis:
           - id: kpi1
             kpiId: KPI1
             icon: gauge
             alertMetrics:
  - id: activity_alert
                  pql: KPI(activity_alert)
                  message: This activity has an alert
         edgeKpis:
           - id: kpi2
             kpiId: KPI2
             icon: gauge
             alertMetrics: []
       - id: sample_kpis_1
         displayName: Sample KPIs
         eventLogId: EL_HINTERACHE__MELDEPUNKT_HIGH_LEVEL
         nodeKpiIds:
           - KPI3
         edgeKpiIds:
           - KPI4
         nodeKpis:
           - id: kpi3
             kpiId: KPI3
             icon: gauge
             alertMetrics: []
         edgeKpis:
           - id: kpi4
             kpiId: KPI4
             icon: gauge
             alertMetrics: []