Skip to main content

Celonis Product Documentation

Augmented Attributes (KM)
Why do they exist?

When using Celonis you usually work on data coming from external source systems. A drawback of this, is that it is hard to write data back to the system and usually requires workarounds or reloading data models. To overcome this issue, you can create Augmented Attributes. Augmented Attributes are used to store user defined data in your Studio App. This gives you the possibility to describe your business objects in further detail and generate additional process insights or possibilities.

What do they do?

Augmented Attributes are similar to regular Attributes in that they represent an additional column in Records. However, unlike Attributes, they are updated in real time and do not rely on Data Model reload times. When an Augmented Attribute is created, an augmented Table with the same name will be created in your data model. This table stores the custom data for this Augmented Attribute including information about when the Augmented Attribute was created and modified. You can find more detailed information about Augmented Attributes and their use in Views here.

How are they used?

Augmented Attributes are used to store additional information on top of the existing data. There are three different ways Augmented Attributes can be updated:

  • Using an Action Flow module "Update Augmented Attribute"

  • Using a Skill action "Update Augmented Attribute"

  • Updating an Augmented Attribute in a Table through the In-line Editing functionality

How are they created?

Before you create your Augmented Attributes in your Knowledge Model, please make sure the appropriate conditions are met. For Augmented Attributes to work correctly:

  • the underlying Record must have a correctly defined Identifier

  • the underlying Data Model must not be a Demo Data Model

  • the underlying table must not be larger than 30M rows

  • they must not be defined on top of an Augmented Table. (Augmented Table on Augmented Table)

Using the Visual Editor:

In the Visual Editor, Augmented Attributes are created from inside the Records Tab in the Knowledge Model. The Augmented Attributes section contains all the Augmented Attributes that exist in the Knowledge Model. You can create a new Augmented Attribute by clicking on the plus button on the Augmented Attribute section. This will lead you to the Augmented Attribute Creation window, which contains all Augmented Attribute associated value assignments. These associated value assignments are the following:

General Settings:

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

  • ID: A unique technical identifier used to reference this Augmented Attribute. Must be unique within all Augmented Attributes.

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

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

Augmented Attribute Settings:

  • Column Type: Specifies the data type for the Augmented Attribute. The following data types are currently supported: Strings, Integers, Floats, Booleans, Date, Time or Date & Time.

  • Format: Specifies the format of the content of the Augmented Attribute will be presented in based on the Column Type.

  • Unit: Allows users to append a unit to the end of every Augmented Attribute.

  • Default Value: Is the value shown on the Augmented Attribute when it is added to a View Component.

  • Possible Values: To add a list of potential values the Augmented Attribute can have.

Advanced Settings:

  • Housekeeping: When activated, Augmented Attribute values referring to rows no longer existing in the Data Model will be removed automatically. This only applies when the table of Augmented Attribute values already has more than 95 000 rows

Screenshot_2022-06-29_at_11_35_02.png
Using YAML:

YAML declarations of Augmented Attribute follow this format:

records:
  - id: "INVOICE"
    augmentedAttributes:
      - id: status
        displayName: Status
        description: This describes my augmented attribute
        internalNote: For devs this can be used to store internal info
        possibleValues:
          - “OPEN”
          - “IN_PROGRESS”
          - “CLOSED”
        columnType: string
        defaultValue: OPEN
        housekeeping: false

where:

  • id: A unique technical identifier used to reference this Augmented Attribute. Must be unique within all Augmented Attributes.

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

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

  • internalNote: A field only visible within the Knowledge Model

  • possibleValues: A list of potential values the Augmented Attribute can have (Optional).

  • columnType: Specifies the data type for the Augmented Attribute. Augmented Attribute can be of data types Strings, Integers, Booleans, Floats, Date, Time or Date & Time.

  • defaultValue: Is the value shown on the Augmented Attribute when it is added to a View Component.

  • housekeeping: To show whether Augmented Attributes that relate to rows that no longer exist in the Data Model are shown. Possible values are true/false.