How to: Initialize KPI Pack
In this article
To build a business extension pack
To use Actionable Insights, you must first have a KPI Pack and have initialized it. LS Retail provides the Actionable Insights Base Pack by default, partners can also develop and add their own KPI Packs.
You can easily insert the default KPI Pack(s) provided by LS Retail with the Insert Default KPI Packs action on the Actionable Insights KPI Packs page. A newly added KPI Pack will have its own Calculation Codeunit ID, Workflow Codeunit ID, Setup Page ID, and a default status of Run Initialize. After the KPI Pack is inserted, you can use the Initialize KPI Pack or the Initialize All KPI Packs functionalities to perform KPI Pack initialization. All KPIs belonging to the pack, together with their KPI Families and KPI Groups will be created automatically in the system.
Note: To insert and initialize a KPI Pack, you need to have the Actionable Insights administrator rights which you can configure in the Actionable Insights User Setup page.
To initialize KPI Pack
- Click the icon, enter Actionable Insights KPI Packs, and select the relevant link.
- If needed, click Insert Default KPI Packs to create the entry(s) for the default KPI Pack(s), LS Retail currently provides the Actionable Insights Base Pack. See Actionable Insights Base Pack.xlsx for a complete list of KPIs that are available in the base pack.
- Fill in or edit the relevant fields in the KPI Pack, if needed:
- Select the KPI Pack that you want to initialize, and click Initialize KPI Pack.
- Alternatively, if there are multiple KPI Packs that need to be initialized, click Actions - Initialize All KPI Packs to initialize all the KPI Packs with Initialization Status set to Run Initialize.
- After the KPI Pack initialization process, you can see the Initialization Status is set to Initialized and that all the KPIs belonging to the pack, together with their KPI Families and KPI Groups, were created. You can view the KPI Families, KPI Groups, and KPIs that belong to the KPI Pack by clicking on its No. of KPIs field.
Field | Description |
---|---|
Calculation Codeunit ID | This field specifies the ID of the codeunit that initializes the KPI Pack and performs the KPI calculations.
Caution: An incompatible calculation codeunit will cause unexpected behavior in the KPI calculations. |
Workflow Codeunit ID | This field specifies the ID of the codeunit that guides you to the data source from where the signals calculation is based.
Caution: An incompatible workflow codeunit will cause unexpected behavior in the Go to Data Source functionality of the KPIs. |
Setup Page ID |
This field specifies the ID of the page that is used to configure the calculation setup for the KPI Pack. Caution: An incompatible setup page will cause unexpected behavior in the KPI calculations. |
Days to Keep Entries | This field specifies how far back in days the system should keep the signal, alert, and notification entries. |
Days to Keep Deleted Entries | This field specifies how far back in daysthe system should keep the already marked as deleted signal, alert, and notification entries. |
Initialization Status | This field specifies whether the status of the KPI Pack is Run Initialize or Initialized. A newly added KPI Pack has the default status of Run Initialize and after the KPI Pack has been initialized, all KPIs belonging to the pack, together with their KPI Families and KPI Groups, will be automatically created in the system. Tip: You can reset the status and rerun the initialization process. |
To build a business extension pack
If you are an LS Retail partner and wish to develop your own KPI Packs, you have to ensure your packs are initialized correctly and that the right setup data is created. You can refer to the codeunits, setup table, and page that are used in the Actionable Insights Base Pack for technical information and references on how an extension pack can be built:
Object Type | Object Name | Description |
---|---|---|
Codeunit | LSC ACI Base Pack Mgmt | The functionality in this codeunit covers the logic to initialize the Actionable Insights Base Pack with default data. The pack includes the KPIs from the Family Budgets, Inventory, Replenishment, Vendors, Purchases, Transfers, Sales, and Forecast. The initialization functions make use of some generic helper functions that reside in the codeunit LSC ACI Mgmt. |
Codeunit | LSC ACI Base Pack Signal | The functionality in this codeunit covers the logic to calculate and create the signals for the KPIs in the Actionable Insights Base Pack. |
Codeunit | LSC ACI Base Pack Workflow | The functionality in this codeunit covers the logic to open the related pages from the Go to Data Source functionality, which will help guide your users to the data behind the KPI calculations. |
Table & Page | LSC ACI Base Pack KPI Setup | The table and page consist of the setup fields for the KPIs in the Actionable Insights Base Pack. These setup fields are required for some of the KPIs to produce meaningful signals. |
See also
Actionable Insights KPI Overview