Skip to main content

Celonis Product Documentation

Legacy view components

Legacy view component

You're currently viewing a topic about a legacy view component in Studio. This component can still be used in legacy Studio views, however we recommend using the visual view editor in the new Studio experience. The updated interface includes drag and drop capabilities, allowing you to easily add components and configure your views.

For more information, see: Views.

You can customize your legacy studio views by adding and configuring View components. View components allow you to visualize your data in a number of ways, enable you to add interactive elements to your Views, and help you customize the look and feel of the View.

You can also add display rules to your knowledge model, allowing you to visually customize your Views with different stylings and icons.

As an example, the following view including a customized image, dropdown filters, KPI lists, and three different charts:

View_components_example.png
Adding view components to studio Views

Components can be added while creating a new View.

create_view.png

Alternatively, you can edit an existing view by clicking Edit Mode:

edit_an_existing_view.png

And then clicking Create or Choose Component:

create_or_choose_component.png
Available view components

The following studio view components are available for your Celonis Platform:

Anomalies and root causes

  • Execution Gap List: View an automatically generated list of all anomalies detected in your system, including defined KPIs, occurrences, and the current impact. These anomalies can then be analyzed on a profile view level. See Configuring an execution gap list in legacy views.

Charts and tables
Embedded components
Execution and actions
Explorers

  • Case explorer: Displays the connected data tables and provides a tool for examining cases and their respective activities. See Case Explorer.

  • Network and signal link explorer: Visualize your data using a custom graph. See Network Explorer.

  • Process explorer: View a visual process diagram, showing the number of items that have reached each stage of that progress over the reporting period. See Process Explorer.

Filters
Form components
KPIs and Attributes
View components
Configuring a KPI card in legacy views

Legacy view component

You're currently viewing a topic about a legacy view component in Studio. This component can still be used in legacy Studio views, however we recommend using the visual view editor in the new Studio experience. The updated interface includes drag and drop capabilities, allowing you to easily add components and configure your views.

For more information, see: Views.

Display a detailed KPI card for a single KPI within your view.

image3.png
Basic KPI card configuration

To configure a basic KPI card component, the following attributes are available:

Attribute

Required

Type

Description

kpi

Yes

KPI

References a KPI defined in the Knowledge Model.

The example YAML for a basic KPI card configuration:

id:kpi-card-component-1244
type:kpi-card
settings:
    data:
        kpi:undesired_process_steps
Advanced KPI card configuration

To configure an advanced KPI card component, the following attributes are available:

Attribute

Required

Type

Possible values

Description

description

value:

placeholders:

  • field:

No

String

-

Defines description/supporting text that is displayed below the KPI value. You can also define attributes, KPIs, or variables from your knowledge model that you want to reference in this text. Once these have been defined in your parameter configuration, you can use them by referencing them using the format "Placeholder {X}" where "X" is the order placement you listed it in.

Note

When referencing the parameter in the text field, the ordering reference should start at {0}. If you have three fields listed, you can reference these as

  • Placeholder {0}

  • Placeholder {1}

  • Placeholder {2}

relatedKPIs:

  • kpi:

No

KPI

Define related KPIs to be displayed on the KPI card component. These KPIs should be used to support the main KPI with additional metrics.

image2.png

trend:

timeDimension:

range:

growthRates:

No

Defines if trend visualizations should be displayed on the KPI card component. Trends can be added to gauge how your KPI has been trending across the selected time period. There are two types of trend visualizations that can be added:

  1. General trend marker: The general trend marker displays the percentage of change in the KPI value (also known as slope). You must define the time dimension (i.e. invoice date, closing date, etc.) and range (daily, weekly, monthly, or yearly) that the trend is calculated over. Once these are defined, a badge will be added to show the average increase or decrease per time period defined.

    Note

    The column type must be defined for the time dimension. Date and Time are the only valid data types.

    image4.png
    image7.png

  2. Year of Year (YoY)/Month of Month (MoM) growth trends:These are additional trend details that can be added by setting “growthRates: true”. These will be displayed based on available data:

    image1.png
    image6.png

    Note

    The calculations will always take into account the latest two full periods of data. For example, if you access your view on June 12th, 2022, you will only send MoM trends if you have data for April and May 2022 and YoY if you have data for 2020 and 2021. It will always be calculated as:

    ((Last period - Second to last period) / Second to last period) x 100

showTarget

No

Boolean

true

false

Defines if target information is displayed. Target information will only be displayed if the data is available. A red/green target icon will display next to this target based on how you are currently tracking towards your target.

image5.png

Note

In the Knowledge Model, you can define default target information for each KPI. Once set, the target is stored for the KPI and automatically propagated to all components that use it.

shorwPriority

No

Boolean

true

false

Defines if priority information is displayed. Priority information will only be displayed if the data is available.

Note

Priority selection can only be set using the priority switcher tool and must be first added to your view to use it.

displayContentRule

No

String

-

References a Display Rule in the Knowledge Model.

kpiParams

  • id

value

No

Legacy view variables

-

Defines parameters that are also used in the Knowledge Model.

The ID value defines the ID value of the parameter defined. The ID value must match the KPI parameter ID defined in KM to work correctly.

Thevaluedefines the parameter that will be passed from the knowledge model. This value should be defined using a variable with the input coming from e.g. a dropdown component.

The example YAML for an advanced KPI card configuration:

id:kpi-card-component-1244
        type:kpi-card
        settings:
            data:
            kpi:undesired_process_steps
            description:
            value:The {0} happens in {3} ({2}) of cases. In total, it happens {1} times. On average it happens {4} times per case.
            placeholders:
                -field:unwanted_activity
                -field:undesired_process_steps
                -field:number_of_cases_with_undesired_process_steps
                -field:new_unwanted_activity_rate
                -field:occurrences_of_undesired_process_steps_per_case_affected_
            relatedKpis:
                -kpi:throughput_time_with_activity
                -kpi:impact_on_median_throughput_time
           trend:
                timeDimension:CEL_AP_ACTIVITIES.EVENTTIME
                range:day
                growthRates:true
            options:
                showTarget:true
                showPriority:true
                swapTitle:false