Creating and using augmented attributes
Augmented attributes created using previous Studio features
You're currently viewing a topic about using augmented attributes in the new Studio experience. Any augmented attributes created using the previous Studio features continue to be found in their existing location (Knowledge Model - Records) and can continue to be used in views created using those features.
If your Celonis Platform team has been migrated to the new Studio experience, existing augmented attributes created using the previous features are not automatically available in the new Studio experience. You must migrate them first. See Migrating augmented attributes.
To learn more about using augmented attributes using the previous Studio features, see: Augmented Attributes.
Augmented attributes are a Knowledge Model (KM) asset that can be updated in real-time and without the data model reloading. By assigning an augmented attribute to a specific table in the data model, you can add additional information to the source system. This additional information can then be referenced in your views, describing your business objects in further detail and generating additional process insights.
When using an augmented attribute, the following conditions apply:
The table in the data model you assign the augmented attribute can have a maximum of 30 million rows.
The maximum number of augmentation tables per data model is 200.
The maximum number of values per augmented attribute is 200k (however rows containing the default value are not included).
Table names and column names in your data model can't contain spaces. For example, you should use "VENDOR_INFO" instead of "VENDOR INFO" as a table name.
Any tables you want to use must have a primary key (also known as an ID) set in the data model. For more information, see: Setting the primary keys.
Augmented attributes are created within and added to a KM (which itself is stored within a Studio package).
To create an augmented attribute from within a package:
Open your KM and click Augmented Attributes.
Click Create Augmented Attribute and follow the guided process, including entering a name, selecting data types, and choosing your input type.
You can select from the following data types here:
String: Text values.
Integer: Whole number values (whether positive, negative, or zero).
Float: A number with a decimal point value.
Boolean: A True or False value.
And you can select from the following input methods here:
Custom: Allow the user to enter a custom value (with the option to define a default value)
Predefined: Manually enter the values that can be selected and define a default value.
In the following example, five predefined values have been entered and the default value is set to zero.
Click Save.
The augmented attribute is saved to the KM and can be referenced in your views. This update will then be able in your app when the version you're editing is next published.
Using the PQL editor, you can leverage augmented attributes in your views in the following ways:
With the augmented attribute appearing under the data model table to which it has been added, you can use it as a reference in your components. When using the augmented attribute in this way, the autogenerated PQL will be consistently correct even if the configuration of the attribute changes.
Each augmented attribute has it's own table in the data model. With this table, more advanced information can be extracted (such as the time of the last update or the user who performed it).
This table uses the following naming convention:
<data model table>_AUG_<Augmented Attribute Name>
When configuring a table component within a view, you can assign augmented attributes and enable inline editing of the data displayed per column.
To enable inline editing for a table column, click the column configuration icon and then select Cell Interactions - Inline Editing:
For example, the invoice status column in this table is based on an augmented attribute. When inline editing is enabled, the app user can edit this table column to update the current status of the invoice from Open to In Progress.
For more information about configuring table components, see: Tables.
Using table actions, you can update augmented attributes when interacting with them in a published view. With the attributed selected, an customizable button appears above the table, allowing you to update values in real-time.
For more information, see: Actions.
 |
In the new Studio experience, you create augmented attributes in the KM by directly referencing tables in the Data Model rather than referencing records. Record-based augmented attributes are not compatible with the new Studio experience and can’t be used in new Studio components. With a dedicated Migration Tool, you can easily migrate your record-based augmented attributes to a format that is compatible with the new Studio experience.
To migrate your record-based augmented attributes:
In Studio, go to your Knowledge Model > Records.
Select your record.
In your record, go to the augmented attribute you want to migrate.
At the bottom of the augmented attribute editor, go to the Migration Tool.
Click Create new attribute.
This created a new augmented attribute with the same configuration as the old one but with every value set to the default. No values are copied at this stage.
Click Transfer Data to copy over all values of the old augmented attribute value to the new one, which is compatible with the new Studio experience.
The Migration Tool count shows differences between the new and old augmented attributes which might have been introduced after the last transfer. Note that if you click Transfer Data, the values of your new augmented attribute will be replaced with the latest values of the old augmented attributes. If the Migration tool count shows all values as null, both versions are identical.
Tip
To avoid conflicts, we suggest scheduling with your team a cut-off date for making changes to the old augmented attribute as part of the migration process.