Validating KPIs for the object-centric Unshipped Orders app
The Setup and Validation view is the best way to validate and adjust the KPIs in the Unshipped Orders app’s Knowledge Model. It guides you through the steps to validate each use case. We explain how we calculate each KPI, and what parameters the app uses by default. You can change them to align with how things are done in your organization.
To change any of the parameters, click the Settings button to open the settings view for the use case. Use the dropdowns and fields to change any parameters you want to for the step you’re working on.
The last step lets you verify your calculations using a sample of your source system data. If anything here is not as you expect, you can go back and adjust the parameters again.
If you’ve worked through a use case in the Setup and Validation view but something is still not the way you want it, you can make further adjustments directly in the Knowledge Model.
The Knowledge Model also includes calculated attributes that contain the business logic to classify and provide metadata about objects. You can use them in PQL queries as if they were another column in the database table for the object type. They appear in the Knowledge Model as attributes of relevant records, and they can be shared by KPIs. If you're editing view components, and you make an edit to a calculated attribute there, we'll automatically update it in the Knowledge Model. You can also adjust calculated attributes directly in the Knowledge Model before or after editing the views.
If you need to make any adjustments directly in the Knowledge Model, work with it in Studio. You’ll need Analyst permissions on Studio and the Knowledge Model. If you need training, check out the training track “Build Knowledge Models and Views” on the Celonis Academy.
The main Knowledge Model for the Unshipped Orders app is called “Knowledge Model”. Work with this Knowledge Model to validate and change KPIs and calculated attributes. “Knowledge Model” points to the base Knowledge Model stored in the Celonis Marketplace, which you can’t update directly from the YAML code. Changes you make to the PQL formulas, calculated attributes, KPI names, or formatting in “Knowledge Model” override the base Knowledge Model. Your changes are applied when you publish a new version of the Starter Kit.
“Knowledge Model - User Guide” is in the folder User Guide. The User Guide’s Knowledge Model extends “Knowledge Model” and picks up your changes to that model automatically, so you don’t need to validate the KPIs again. You normally only need to work with “Knowledge Model - User Guide” if you want to add something extra in the User Guide that won’t appear in the Action View.
Each KPI in a Knowledge Model contains a PQL (Process Query Language) formula. Some KPIs are reused inside other KPIs as nested formulas. When you adjust the business logic in a single formula, and save it, the change is simultaneously reflected in all the KPIs that reuse the formula. The same thing happens if the business logic is contained in a calculated attribute rather than a KPI - all the KPIs that share the calculated attribute will reflect your changes.
Here’s how to work with the KPIs and calculated attributes in the Knowledge Model:
In the Celonis navigation menu, select Studio.
In the Studio overview, find the Unshipped Orders app in the space where you installed it, and click its tile.
Go to the Knowledge Models folder and select “Knowledge Model”.
Select the KPIs section of the Knowledge Model to work with KPIs, or the Records section to work with calculated attributes.
You can sort and search the KPIs using their name or ID. The prefix to the ID shows what type of component they are. The table at the end of this topic lists the calculated attributes for the Starter Kit, with the records where you can find them.
To see and edit the full PQL formula and other settings for a KPI or calculated attribute, click its row to open an editor. The editor automatically validates any changes that you make in the PQL formula.
If you want a fuller-featured PQL editor that lets you select from the tables and columns in your data, click on the pen icon next to the PQL formula.
If you need to disable a KPI or formula, click the three vertical dots at the top of the editor, and select Disable Scope, then click Disable to confirm. When you do this, the object can't be accessed or used anywhere in the package, including by other apps that depend on it.
When you’ve made changes to the KPIs, use the Publish button at the top of the screen in your Studio space to publish a new version of the app.
Here are the calculated attributes for the Unshipped Orders app:
Calculated Attribute name | Attribute ID | Record ID | Description |
|---|---|---|---|
Delivery is overdue? | IsOverdue | O_CELONIS_DELIVERY | When a delivery is past its expected delivery date. |
Delivery is pending goods issue? | IsPendingGoodsIssue | O_CELONIS_DELIVERY | When a delivery is not shipped. |
Delivery value | NetAmountConverted | O_CELONIS_DELIVERY | The sum of the delivery item value. |
Delivery is picked? | IsPicked | O_CELONIS_DELIVERY | When a delivery is picked. If one delivery item is not picked, the delivery will be classified as not picked. |
Delivery is packed? | IsPacked | O_CELONIS_DELIVERY | When a delivery is packed. If one delivery item is not packed, it will be classified as not packed. |
Delivery packed and not picked up? | PackingCompletedAndNotPickedUp | O_CELONIS_DELIVERY | When a delivery that has to be picked up by a customer, has been packed but not picked up. |