Configuring augmented attributes for the object-centric Shipped Not Invoiced app
In the Shipped Not Invoiced app’s Knowledge Model “Knowledge Model - Shipped Not Invoiced”, configure any additional values you want for the status of delivery items. You only need to do this if there’s something important to add besides the supplied values.
The status for delivery items is shown in the Status column of the Action View table. Users can set a delivery item’s status to one of these values to track its progress. The default status values that users can pick are "New", "In Progress", and "Rejected". A “Done” status is automatically set when the item is invoiced. You can’t remove the existing status values.
You work with Knowledge Models in the visual editor in Studio, and any changes you make are applied when you publish a new version of the app. “Knowledge Model - User Guide” picks up your changes automatically, so you don’t need to configure this.
Here’s how to set up any new status values that you want to add:
In the Celonis navigation menu, select Studio.
Find the Shipped Not Invoiced app in your Studio space navigation.
Expand the package’s structure using the arrow.
Go to the Knowledge Models folder and select “Knowledge Model - Shipped Not Invoiced”.
Select the Records section of the visual editor, and search for “UNBILLED_STATUS” to find the relevant records.
Tip
You can hide auto-generated items in the Knowledge Model by clicking the “Hide auto-generated definitions” icon next to the search bar.
In the row for “Delivery Item”, click the arrow in the Record Items field to open the augmented attributes. Click the second attribute UNBILLED_STATUS to edit it. (You don’t need to work with “Delivery Item Augmented Unbilled Status”, which is generated from the augmented table, or with the UNBILLED_STATUS_CLOSED attribute.)
Scroll down to the Augmented Attribute Settings section, and enter each of your new status values in the Possible Value box, then click Add Value to add it to the list. Click Save to save the new values.
Still working in the Records section of the visual editor, search for “INTERNAL_STATUS_NEW”. Repeat the last two steps to add each of your new status values to the Possible Value settings for the “INTERNAL_STATUS_NEW” augmented attribute of “Customer”, “Delivery,” “Sales Order”, and “Sales Order Item”. Ignore the autogenerated “Augmented Internal Status New” versions of the rows - you can hide these by clicking the “Hide Autogenerated Definitions” icon next to the search bar.
Now go to the Variables section of the visual editor, and search for “UNBILLED_STATUS” again to get the Knowledge Model variables VAR_AUG_ATTR_VALUES_UNBILLED_STATUS_IN_PROGRESS and VAR_AUG_ATTR_VALUES_UNBILLED_STATUS_REJECTED.
Click on the row for each of the variables to edit it, and update the Value field with any relevant new or modified values that you added for the augmented attribute UNBILLED_STATUS. You can add new values and overwrite the existing one. Separate multiple values with a comma and put single quotes around each value. Click Save to save your changes.
VAR_AUG_ATTR_VALUES_UNBILLED_STATUS_IN_PROGRESS is for all the values that represent an “in progress” status, like the default value “In Progress”. When an item in this status gets invoiced, the item is counted as realized value in the app’s Closed tab.
VAR_AUG_ATTR_VALUES_UNBILLED_STATUS_REJECTED is for all the values that represent a “rejected” status, like the default value “Rejected”. An item in this status is not counted towards the realized value after billing.
Optional: At the moment, your new status values will be displayed with the default “Queued” icon that’s used for all status values without their own icons. If you want them to have their own icons, you’ll need to replace the custom object that holds the display rule for unbilled status. Here’s how to do this:
In the visual editor for “Knowledge Model - Shipped Not Invoiced”, click the Switch to YAML icon </> to view the YAML for the Knowledge Model.
Click inside the YAML editor to access the editor’s own search function (instead of your browser search, which won’t work), then press Ctrl + F and search for the custom object CO_DISPLAYRULE_UNBILLED_STATUS.
Copy the whole of the custom object, then click Edit Mode.
Paste the custom object into the customObjects section of the YAML. Change the ID to something different - here we’ve used CO_DISPLAYRULE_UNBILLED_STATUS_CUSTOM.
Add a custom attribute for each of your new status values, including a suitable icon for each of them. Click Save and Exit Edit Mode to finish, then click the palette icon to switch back to the visual editor.
In each of the tables where a display rule for unbilled status is used, apply your new custom object instead of the preset custom object. Click the Edit Component button on the table to go to the component editor, then find the value setting in the table settings (here it’s “Status”). Specify your new custom object for the styling rule, and click Save.
Go to the Action View and check that your new values are available in the Status dropdowns for the items, and showing the icons you expect.
When you’ve completed and checked your changes, use the Publish Package button at the top of the screen in your Studio space to publish a new version of the app.