Skip to main content

Celonis Product Documentation

Amending the in-app documentation

Important

IMPORTANT: Amending the in-app documentation is optional but we recommend you do so if you have made changes to the user interface.

In-app documentation types

Type

Description

Static

Documentation which is hardcoded for individual components such as Execution Gaps.

Dynamic

Documentation which uses KPI metadata such as descriptions given in the Knowledge Model.

Amending static content
  1. Open the view containing the component you want to update.

  2. Click Edit Mode.

  3. Click the component to open the Visual Editor.

  4. Switch to the Code Editor.

    Note

    Adding info text or documentation is not currently supported in the Visual Editor.

  5. Add your content in the YAML code below settings using infoText. You can provide a title as well as content; use basic HTML to format your content.

  6. An info icon appears next to the header of the updated component; hover over this icon with your cursor to display your updated content.

Amending dynamic content
  1. Follow steps 1 to 4 of "Amending static content".

  2. Set up a kpiMeta variable.

    image12.png
  3. Reference the kpiMeta-variable:

    image24.png
  4. Click Save then Exit Editor.

  5. An info icon appears next to the header of the updated component; hover over this icon with your cursor to display your updated content. The description will be dynamically updated with any changes made in the Knowledge Model.

Limitations

It is not currently possible to connect the descriptions of multiple KPIs to provide descriptions for several KPIs at once. The description will always be displayed in the Knowledge Model Visual Editor. As this provides helpful context when creating an extension of a KPI or when deciding which KPI to use in a certain scenario, we recommend adding a description wherever possible.

Important

The case table used is MARC so classification is made on a material-plant level. It is therefore possible for a material to be flagged both as stockout and over stock as there may be no quantity at one location while another may have more than required.