Skip to main content

Celonis Product Documentation

Variables

If the possible values of the augmented attribute UNBILLED_STATUS were customized, you would need to update the following variable.

Knowledge Model key variable

Ensure that the variable VAR_KNOWLEDGE_MODEL_KEY is set to the full key of the app's knowledge model. In a regular setup, the default value does not require any update.

Variable ID

Description

VAR_KNOWLEDGE_MODEL_KEY

This variable is required to query the correct augmented attributes when the data model is shared with other apps with the same aug. attribute ids.

The default value is set to order-management-shipped-not-invoiced-store.knowledge-model-shipped-not-invoiced

Status value variables

Variable ID

Description

VAR_AUG_ATTR_VALUES_UNBILLED_STATUS_IN_PROGRESS

This variable defines which values are defined as "in progress" which is required to determine the status in the closed tab. If an item had been set to an "in progress" status and then gets invoiced, the item is considered as "realized" in the closed tab.

By default, this variable's value is set to the value 'In Progress'. If the possible values of UNBILLED_STATUS were adjusted, add new values to this variable value or overwrite the existing value. If multiple values need to be set, separate them with a comma.

VAR_AUG_ATTR_VALUES_UNBILLED_STATUS_REJECTED

This variable defines which values are defined as "rejected" which is required for filtering. If an item is set to a "rejected" status, it is not counted towards the realized value after billing.

By default, this variable's value is set to the value 'Rejected'. If the possible values of UNBILLED_STATUS were adjusted, add new values to this variable value or overwrite the existing value. If multiple values need to be set, separate them with a comma.

Additionally, update the custom attribute CO_DISPLAYRULE_UNBILLED_STATUS to consider your custom values.

Variables for the determination of unbilled items

During the app installation, the runtime variables and their value from the Order Management Starter Kit were copied to the Shipped Not Invoiced app package. To adjust any values, use the view Settings if you installed the Shipped Not Invoiced app before completing the setup of the "Unbilled Orders" use case in the Order Management Starter Kit you will need to update the variable values in the SNI Settings page in Apps and/or Studio.

Variable ID

Description

VAR_ACTIVITY_RECORD_GOODS_ISSUE

Specifies the "Record Goods Issue" activities; set by runtime variable recordGoodsIssueActivity

VAR_ACTIVITY_CANCEL_GOODS_ISSUE

Specifies the "Cancel Goods Issue" activities; set by runtime variable cancelGoodsIssueActivity

VAR_ACTIVITY_CREATE_INVOICE

Specifies the "Create Invoice" activities; set by runtime variable createInvoiceActivities

VAR_ACTIVITY_CREATE_INVOICE_CANCELLED

Specifies the invoice cancellation activities; set by runtime variable createInvoiceCanceledActivity

VAR_ACTIVITY_REJECTION

Specifies the rejection activities; set by runtime variable rejectionActivity

VAR_ACTIVITY_CANCEL_REJECTION

Specifies the rejection activities; set by runtime variable cancelRejectionActivity

VAR_THRESHOLD_BILLING_LONG_RUNNER

Specifies the number of days since goods issue that an item is considered a "long runner" with regards to invoice creation; set by runtime variable billingLongRunnerThreshold

VAR_THRESHOLD_BILLED_LATE_BUFFER

Specifies the number of days since goods issue that an item is considered late with regards to invoice creation; set by runtime variable unbilledRevenueBuffer

VAR_THRESHOLD_LOWER_VALUE_FOR_UNBILLED

Specifies the minimum net order value of an item to be considered in the unbilled order use case (VBAP.NETWR_CONVERTED), set by runtime variable unbilledMinValueThreshold

VAR_EXCLUDED_DOCUMENT_TYPES_FOR_UNBILLED

Specifies the document types which should not be considered in the unbilled order use case (VBAK.AUART); set by runtime variable unbilledExcludedDocumentTypes

VAR_EXCLUDED_BILLING_RELEVANCE

Specifies the billing relevance codes which should not be considered in the unbilled order use case (VBAP.FKREL); set by runtime variable unbilledExcludedBillingRelevance

VAR_OPTION_ORDERS_WITHOUT_BILLING_BLOCKS_FOR_UNBILLED

Specifies whether only orders without billing block should be considered; set by runtime variable ordersWithoutBillingBlockOnly

VAR_OPTION_RETURNED_ORDERS_FOR_UNBILLED

Specifies whether only orders with return should be considered; set by runtime variable unbilledConsidersReturns

VAR_TRADING_PARTNER_TYPES

Specifies whether internal, external, or all trading partners are considered

Variable for the calculation of realized value

The following variable is used to calculate the KPI KPI_ORDERITEM_SUM_REALIZED_VALUE and KPI_TIMELINETABLE_CALC_REALIZED_VALUE.

Variable ID

Description

VAR_TIME_TO_BILL_BASELINE

This variable references the runtime variable unbilledTimeToBillBaseline which can be set in the view Settings.

Note

You can see which objects refer to a variable by copying the Variable ID, going into the YAML editor into the View mode (“Final Model without variable replacement”) and search for the copied variable

Note

The runtime variable values in Apps and Studio are independent after the initial publishing. We recommend updating the runtime variable values in the view Settings in Apps as this is the view your business users access.

If you prefer to maintain the values across Apps and Studio you can do so by setting the values directly in the corresponding Knowledge Model variables.