Skip to main content

Celonis Product Documentation

Updating the case-centric Shipped Not Invoiced app

When there’s an update for the Shipped Not Invoiced app, you’ll see an UPDATE AVAILABLE button next to the package name in the Dependencies tab in the package settings. The package settings are available from the package’s context menu (the three vertical dots by the package name). Update your app regularly to benefit from our new developments.

Updates with new features are announced in the Release Notes, and all the updates for the case-centric Shipped Not Invoiced app are listed at the end of this topic. The change history for the object-centric version of the app is in Updating the object-centric Shipped Not Invoiced app.

Here’s how to update your app:

  1. Check the change history at the end of this topic for all the releases that have happened since your current version, to see what changes were made since you last updated the app. If there’s any action you need to take, such as manually updating a KPI or reapplying some of your customizations, we’ll tell you here.

    Tip

    Your current app version is shown in the Dependencies tab in the package settings.

  2. In Studio, click Publish Package to publish your current app package, so that you can revert to this in case there are any problems during the update.

  3. In the Dependencies tab in the package settings, click the UPDATE AVAILABLE button to update the app to the latest version. The popup lists the updated assets - click Update to proceed.

  4. In the visual editor for the app’s Knowledge Model, check that the Knowledge Model Key variable is still set to the value of the Knowledge Model key for your local app installation. If you have multiple copies of the app, the update might overwrite it. Setting the Knowledge Model Key variable for the case-centric Shipped Not Invoiced app tells you how to find the local Knowledge Model key and set the variable value.

  5. In Studio, make any required manual updates that we’ve noted in the change history for your new app version, or for the other versions since you last updated the app.

  6. Check all the app’s views to make sure everything works correctly, all the fields are populated, and the numbers look as you’d expect.

  7. If there’s an issue and you’re sure you made any required manual changes correctly, see Contacting support to find how to get help.

  8. If everything’s working, click Publish Package to publish your updated package and make it available to your users.

Change history
Version 3
  • Version 3.0.2: We optimized some PQL queries which in some cases significantly improves performance when opening profile views.

Version 3.0.1
  • We’ve flattened the view architecture by removing base views and reducing the depth of embedded views, so it’s simpler for you to customize the app. Views deleted in version 3.0.1 of the Shipped Not Invoiced app lists the deleted views and their keys, and where the content has gone to in Version 3.0.1.

  • In the app’s Knowledge Model, we’ve revised the PQL queries to make them more intuitive to read and understand. The PQL statements are refactored, simplified and reformatted, but the underlying logic stays the same. KPI changes in version 3.0.1 of the case-centric Shipped Not Invoiced app shows where KPI IDs have changed.

  • If you want to deploy the Shipped Not Invoiced app for a related use case (such as unbilled contracts, unbilled service orders, or unbilled stock transfer orders), you can now do so easily with our new templates. The custom object templates and instructions to use them are shipped in the app package.

Important

When you upgrade to or beyond this release, you'll need to transfer any customizations you made to the views and KPIs that are being removed in this version of the app, to the equivalent views and KPIs in the new version. If you have significant customizations in the Shipped Not Invoiced app, we recommend that you use the following upgrade instructions for Version 3.0.1 in place of the standard procedure.

In these steps, you'll customize a temporary instance of the app package, and then overwrite your original app package with it. Doing the customization work in a separate instance means that you can avoid downtime for your end users. Overwriting the original app package rather than just using the new instance means that you can keep your augmented attributes, tasks, and their transactional activity history.

  1. Install a second, temporary instance of the case-centric Shipped Not Invoiced app from the Celonis Marketplace.

  2. Check the views and KPIs components listed in the tables below for any customizations you've made to them in your original Shipped Not Invoiced app installation. If you have made any customizations to the listed entities, move these to the equivalent view or KPI in your temporary instance of the Shipped Not Invoiced app. Also copy all custom created assets that are not in the default Shipped Not Invoiced app to your temporary instance. Verify that everything in the temporary instance looks as you expect.

  3. Publish a version of your original Shipped Not Invoiced app, so that you can revert to it quickly in case of any issues.

  4. Use the copy-to functionality to overwrite the content of your existing Shipped Not Invoiced app package with the content of the package for the temporary instance.

  5. Verify that the update was successful, then publish another version of your Shipped Not Invoiced app.

  6. Remove the temporary instance of the Shipped Not Invoiced app.

Table 14. Views deleted in version 3.0.1 of the Shipped Not Invoiced app

View Name

Key

Where the content is now

Item Table

view-item-table

Component table-59c73dd6-c21b-48d9-aa58-0f4330e5d04a moved to action-view as open item table

Item Tabs

view-item-tabs

Layout moved to action-view

Open Item Table

view-open-item-table

Component table-59c73dd6-c21b-48d9-aa58-0f4330e5d04a moved to action-view

Closed Item Table

view-closed-item-table

Table component moved to action-view - new component ID table-943b1af1-52fe-44d6-9204-8939065e5f1f to resolve conflict with open item table

Sidebar

view-sidebar-base

Layout and components moved to view-sidebar-open and view-sidebar-closed

Sidebar Filters

view-sidebar-filters-base

Layout and components moved to view-sidebar-open and view-sidebar-closed

Sidebar Filters Open

view-sidebar-filters-open

Layout and components moved to view-sidebar-open

Sidebar Filters Closed

view-sidebar-filters-closed

Layout and components moved to view-sidebar-closed



Table 15. KPI changes in version 3.0.1 of the case-centric Shipped Not Invoiced app

Previous KPI ID

New KPI ID

FORMULA_ORDERITEM_CALC_BILLING_DELAY

Split into: 

FORMULA_ORDERITEM_CALC_BILLING_DELAY_IN_DAYS_BILLED

FORMULA_ORDERITEM_CALC_BILLING_DELAY_IN_DAYS_UNBILLED

FORMULA_TIMELINECOLUMN_DISPLAY_BILLING_DATE_DAY

FORMULA_TIMELINECOLUMN_DISPLAY_INVOICE_CREATION_DAY

FORMULA_TIMELINECOLUMN_DISPLAY_BILLING_DATE_MONTH

FORMULA_TIMELINECOLUMN_DISPLAY_INVOICE_CREATION_MONTH

FORMULA_TIMELINECOLUMN_DISPLAY_BILLING_DATE_QUARTER

FORMULA_TIMELINECOLUMN_DISPLAY_INVOICE_CREATION_QUARTER

FORMULA_TIMELINECOLUMN_DISPLAY_BILLING_DATE_YEAR

FORMULA_TIMELINECOLUMN_DISPLAY_INVOICE_CREATION_YEAR

FORMULA_CUSTOMER_INDICATOR_CURRENT_BILLING_BLOCK_BUSINESS_LOGIC

FORMULA_CUSTOMER_INDICATOR_CURRENT_BILLING_BLOCK

KPI_ORDERITEM_SUM_BLOCKED_ORDERITEM_COUNT

Deleted

FORMULA_ORDER_INDICATOR_CURRENT_BILLING_BLOCK_BUSINESS_LOGIC

FORMULA_ORDER_INDICATOR_CURRENT_BILLING_BLOCK

FORMULA_ORDER_INDICATOR_BILLING_BLOCK_BUSINESS_LOGIC

FORMULA_ORDER_INDICATOR_BILLING_BLOCK

FORMULA_ORDERITEM_INDICATOR_CURRENT_BILLING_BLOCK_BUSINESS_LOGIC_ALL_LEVELS

FORMULA_ORDERITEM_INDICATOR_CURRENT_BILLING_BLOCK_ALL_LEVELS

FORMULA_ORDERITEM_CALC_DAYS_BETWEEN_GI_INVOICE_CREATION_OR_TODAY

Split into: 

FORMULA_ORDERITEM_CALC_HOURS_BETWEEN_GI_INVOICE_CREATION

FORMULA_ORDERITEM_CALC_HOURS_BETWEEN_GI_AND_NOW

FORMULA_ORDERITEM_PARAMETER_GOODS_ISSUE_DATE

FORMULA_ORDERITEM_PARAMETER_LAST_GOODS_ISSUE_TIMESTAMP

FORMULA_ORDERITEM_INDICATOR_UNBILLED_ORDER

Deleted

KPI_ORDERITEM_SUM_UNBILLED_ORDER_ITEM

KPI_ORDERITEM_COUNT_UNBILLED_ITEMS

FORMULA_ORDERITEM_PARAMETER_BILLING_DATE

FORMULA_ORDERITEM_PARAMETER_BILLING_DATE

FORMULA_ORDERITEM_CALC_BILLING_DELAY_HISTORICAL

FORMULA_ORDERITEM_CALC_BILLING_DELAY_IN_DAYS_BILLED

KPI_ORDERITEM_AVG_BILLING_DELAY_HISTORICAL

KPI_ORDERITEM_AVG_BILLING_DELAY_IN_DAYS_BILLED

KPI_ORDERITEM_AVG_BILLING_DELAY_CURRENT

Deleted



Table 16. Other Knowledge Model changes in version 3.0.1 of the case-centric Shipped Not Invoiced app

Previous ID

New ID

SALES_ORDER_ITEM.BILLING_DATE_DAY (attribute)

SALES_ORDER_ITEM.INVOICE_CREATION_DAY

SALES_ORDER_ITEM.BILLING_DATE_MONTH (attribute)

SALES_ORDER_ITEM.INVOICE_CREATION_MONTH

SALES_ORDER_ITEM.BILLING_DATE_QUARTER (attribute)

SALES_ORDER_ITEM.INVOICE_CREATION_QUARTER

SALES_ORDER_ITEM.BILLING_DATE_YEAR (attribute)

SALES_ORDER_ITEM.INVOICE_CREATION_YEAR

FILTER_BILLING_RELEVANT (filter)

FILTER_ORDERITEM_BILLING_RELEVANT

VAR_ACTIVITY_REMOVE_BILLING_BLOCK (Knowledge Model variable)

Deleted

removeBillingBlockActivity (package variable)

Deleted

ACTION_ORDERITEM_REMOVE_UNBILLED_STATUS (action)

Deleted



Version 2
  • Version 2.4.3: We've fixed the ID naming of the KPI "Avg. weighted time to bill last 365 days".

  • Version 2.4.2:

    • We've activated advanced filters to allow business users to add their own filters to the Action View in Apps.

    • We've removed some quick-filters in the Validation and Value Assessment View which were not used by users.

  • Version 2.4.0:

    • We've updated the realized value calculation of cash flow freed up from reducing the time to bill. You'll find the details in the Settings and User Guide views.

    • We've split the realized value KPI into its components FCF and P&L.

  • Version 2.3.4:

    • We've added a category for cases that were billed before the goods issue.

    • We've added a chart with historic weighted billing delay for easier baseline setting.

  • Version 2.3.0:

    • We've added infinite scrolling to the table in the Action View.

    • You can now bulk update comments and status values from the table in the Action View faster.

  • Version 2.2.7: We've added default values to the excluded document types.

  • Version 2.2.2 to Version 2.2.6: We've added the functionality that task tables are created independent of whether inefficiencies exist or not, so during the initial setup, you don't need to create missing task tables manually any longer. We've also made some further bug fixes and improvements.

  • Version 2.2.0 and Version 2.2.1: We've added a new view "Validation and Value Assessment". This view guides you through the process of understanding and validating all business logic related to the use case step by step and helps you frame the use case's value before requiring any app configuration.

  • Version 2.1.1: We've updated the default "create invoice activities" and made the net order value field parameterizable.

  • Version 2.1.0: We've made UI adjustments to enhance the experience on smaller screens and several formatting improvements.

  • Version 2.0.0 to Version 2.0.2: These releases remove the Knowledge Model dependency to the Order Management Starter Kit. All Knowledge Model entities from the Starter Kit which are required by the Shipped Not Invoiced app have been added to the Shipped Not Invoiced Knowledge Model.

    Important

    When you upgrade to or beyond these releases, if you have customized any of the Knowledge Model entities in the Order Management Starter Kit which are reused in the Shipped Not Invoiced app, copy these definitions into the Shipped Not Invoiced app Knowledge Model.

    Here's the other changes we made in Version 2.0.0 to Version 2.0.2:

    • PQL process reference operators are now used to reference activity and case tables.

    • The realized value calculation of the FCF impact now weighs the time-to-bill by the items' net order value.

    • Returned orders can now be excluded by specifying an activity by which items are excluded in the Settings View.

    • Timeline columns (specified with TIMELINE_COLUMN) which were previously defined on the sales order item record were moved to the KPIs section of the Knowledge Model.

    • The formula FORMULA_ORDERITEM_CLASSIFICATION_BILLING_STATUS_DETAILED was removed. Its logic is now included in FORMULA_ORDERITEM_CLASSIFICATION_BILLING_STATUS.

    • These billing categories were renamed:

      • LONG_RUNNER is now AGED

      • LATE is now PAST_DUE

      • BILLED_LONG_RUNNER is now BILLED_AGED

      • BILLED_LATE is now BILLED_PAST_DUE

    • These variables were renamed or removed:

      • VAR_THRESHOLD_BILLING_LONG_RUNNER is now VAR_THRESHOLD_AGED_UNBILLED

      • VAR_THRESHOLD_BILLED_LATE_BUFFER is now VAR_THRESHOLD_PAST_DUE_UNBILLED

      • VAR_OPTION_ORDERS_WITHOUT_BILLING_BLOCKS_FOR_UNBILLED was removed

      • VAR_ACTIVITY_REJECTION was removed

      • VAR_ACTIVITY_CANCEL_REJECTION was removed

      • VAR_OPTION_RETURNED_ORDERS_FOR_UNBILLED was removed

Version 1
  • Version 1.2.3 and Version 1.2.4:

    • Added the option to specify a value tracking start date in the Settings view (in the Value calculation section). With this change, the KPIs "Cumulative realized value" and "Current realized value" only consider value realized after the specified date.

    • Fixed a minor bug which prevented certain user settings being displayed in the closed tab's chart.

  • Version 1.2.0 to Version 1.2.2:

    • Added an integrated User Guide which allows new app users to onboard quickly by exploring the app's functionalities in an interactive way. The User Guide is a view that can be accessed via the package tree. All assets for the User Guide are bundled in the folder User Guide. If your package key differs from order-management-shipped-not-invoiced-store, update the Knowledge Model Key variable VAR_KNOWLEDGE_MODEL_KEY in "Knowledge Model - User Guide".

    • Restructured the Settings view to include the sections Unbilled items definition, Billing relevant items, and Value calculation.

  • Version 1.1.2: Revised calculation of the current realized value.

  • Version 1.1.1: Fixed a bug that prevented loading the Knowledge Model.

  • Version 1.1.0:

    • The closed item tab now contains billed items independent of whether they were processed in the app or not. The open item tab now also includes "Due" items.

    • Added aggregated data component in the closed item tab, comprising a breakdown table and a chart with the option to set the left and right y-axis, the time dimension, the date on the x-axis, and the attribute to stack/split by.

    • The status of items in the closed tab can no longer be updated.

    • Status 'realized' can no longer be set manually by the user; instead items will get the status assigned automatically after an item has been set to 'in progress' and is later billed.

    • Revised calculation of 'Realized Value' and respective input value on the settings page.

    • The user has the option to 'reject' items and show/exclude them via a checkbox in the filter bar.

    • The display rule for the prioritization now automatically adjusts to the value range without the need to manually set thresholds. Categorization is done based on the value exceeding quantile values of the value of billing the item (> 0.75th quantile is high, > 0.5th quantile is medium, > 0.25th quantile is low).

    • Updated generic email template for better readability of sales order and item number.

    • The SALES_ORDER_ITEM record in the Knowledge Model has additional attributes TIME_TO_BILL, UNBILLED_STATUS_CLOSED, BILLING_RELEVANCE_CODE, and multiple other attributes for chart aggregations. Default values were added for the augmented attribute UNBILLED_STATUS.

    • These KPIs were added to the Knowledge Model: FORMULA_ORDERITEM_INDICATOR_UNBILLED_USER_REJECTED, KPI_ORDERITEM_SUM_REALIZED_VALUE, FORMULA_ORDERITEM_CLASSIFICATION_BILLING_STATUS_DETAILED, FORMULA_ORDERITEM_CALC_UNBILLED_ITEM_PRIORITIZATION_SCORE, KPI_ORDERITEM_SUM_UNBILLED_ORDER_ITEM, KPI_ORDERITEM_AVG_TIME_TO_BILL, FORMULA_ORDERITEM_PARAMETER_BILLING_DATE, FORMULA_ORDERITEM_CALC_HOURS_BETWEEN_GI_INVOICE_CREATION, KPI_TIMELINETABLE_CALC_REALIZED_VALUE, and FORMULA_ORDERITEM_PARAMETER_CREATION_DATE.

    • The KPI FORMULA_ORDERITEM_INDICATOR_UNBILLED_OPEN is now using FORMULA_ORDERITEM_INDICATOR_UNBILLED_USER_REJECTED.

    • These KPIs were removed from the Knowledge Model: KPI_ORDERITEM_SUM_OPEN_UNBILLED_REVENUE, KPI_ORDERITEM_COUNT_REALIZED_UNBILLED_ITEMS, KPI_ORDERITEM_COUNT_OPEN_UNBILLED_ITEMS, KPI_ORDERITEM_SUM_REALIZABLE_VALUE, FORMULA_ORDERITEM_CALC_REALIZABLE_VALUE, KPI_ORDERITEM_SUM_REALIZED_UNBILLED_REVENUE, FORMULA_ORDERITEM_INDICATOR_UNBILLED_CLOSED, FORMULA_ORDERITEM_INDICATOR_UNBILLED_REALIZED, KPI_ORDERITEM_AVG_BILLING_DELAY (available from Starter Kit), and FORMULA_ORDERITEM_CALC_BILLING_DELAY (available from Starter Kit).

    • The filter FILTER_ORDERITEM_NOT_REJECTED was added to the Knowledge Model.

    • These filters were removed from the Knowledge Model: FILTER_ORDERITEM_UNBILLED_CLOSED, FILTER_ORDERITEM_UNBILLED_OPEN, FILTER_ORDERITEM_UNBILLED_TRACKED, and FILTER_ORDERITEM_GI_IN_PREVIOUS_MONTH.

    • These variables were added to the Knowledge Model: VAR_AUG_ATTR_VALUES_UNBILLED_STATUS_REJECTED, VAR_AUG_ATTR_VALUES_UNBILLED_STATUS_IN_PROGRESS, VAR_TIME_TO_BILL_BASELINE.

    • These variables were removed from the Knowledge Model: VAR_AUG_ATTR_VALUES_UNBILLED_STATUS_CLOSED, VAR_AUG_ATTR_VALUES_UNBILLED_STATUS_REALIZED, and VAR_BILLING_DELAY_BASELINE.

    • The custom object CO_DISPLAYRULE_UNBILLED_STATUS_CLOSED was added to the Knowledge Model, along with various objects for the settings of the chart in the closed tab.

    • The custom object CO_DISPLAYRULE_ORDERITEM_PRIORITY was updated.

    • The action ACTION_ORDERITEM_UPDATE_UNBILLED_STATUS now has a filter to only apply for open items.

    • The action ACTION_ORDERITEM_SEND_EMAIL now passes the sales order number and position.