KPI Configuration Updates

When you change a KPI set or its KPI definitions, trigger UPDATE_KPI_SET to regenerate the calculation configuration and sync it to the CG Cloud Processing Service.

Required Editions

Available in: Lightning Experience

Available in: Enterprise and Unlimited Editions where Consumer Goods Cloud is enabled

When you add a KPI definition to a KPI set, the system consolidates the configuration settings for individual KPIs and creates a single JSON file for the entire KPI set. This configuration is stored in the CG cloud processing service, the engine that helps the system perform the various calculations (simple and complex).

When a KPI set is changed, the system generates the configuration JSON and sends the JSON to the processing service to transport the details of the KPI set across the deployment stages.

A JSON file contains:

  • Settings that control the display, aggregation, and calculation of all KPIs included in the set.
  • Order of the KPI definitions in the KPI set.
  • KPI subsets selected while associating each KPI definition with the KPI set.
  • Values represented along the X and Y axes of the promotion P&L.

Any change in KPI set or KPI definition, such as when you add a new KPI, improve a KPI’s performance, or remove bugs from a KPI, update the configuration by using UPDATE_KPI_SET. Triggering the KPI update either creates a calculation configuration or updates the existing configuration with the newly generated JSON in the processing services. The system detects the KPIs that are required for calculation (formula inputs, compound, and compound-dependent KPIs, metrics) from the KPIs in the subset.

When the KPI configuration is updated, the system generates one KPI subset configuration for each subset of the KPI set. The KPIs in the generated subset configuration inherit the same properties as the main KPI set.

The system calculates the summary of a KPI set (1) that includes KPIs by type (2), and then stores the calculated summary JSON in the KPI_Set.statistics table.

JSON of KPI summary
  • Sample KPI Set JSON
    When a KPI set is changed, the system generates the configuration JSON and sends the JSON to the processing service to transport the details of the KPI set across the deployment stages.