Work with native KPIs
Calculate a KPI from its dataset configuration and maintain its goals, units and access settings.
A native IFBI KPI expresses a measure over a dataset, such as an outstanding balance or a workload count. Agree the business meaning first: the column, aggregation, unit and relevant time period determine whether the number is useful.
Define the measure before calculating it
A saved KpiModel holds the dataset reference, dataset column, aggregate, display settings, goal and access assignments. The required save fields include Name, ColorId, DatasetId, DatasetColumn, AggregateId and UnitId. Consult the model for nullable values and other settings.
Use Get KPIAggregates to obtain the supported aggregate identifiers. Select IDs from the installation rather than inventing identifiers or assuming they are the same across environments. Choose units and colours through their corresponding reference operations.
Retrieve a result for an application
Get KPIResult takes a KpiDataModel. Supply DatasetId, DatasetColumn and AggregateId; include the configured RoundingAmount when needed. Read the saved KPI first to obtain these calculation inputs.
The result arrives as a string in Data. Check the wrapper’s error state and preserve that representation unless your application has explicit numeric and locale conversion rules. The Retrieve a native KPI result for your application recipe in Recipes reads a saved KPI and builds the calculation request from it.
Change a goal carefully
KPI Save accepts the full model. Read the existing KPI, retain its ID and settings, change the intended field, save, and read it back. A goal-only object can omit settings that an update needs to preserve.
The Update a KPI goal without rebuilding the KPI recipe demonstrates that sequence. Coordinate with other editors so that a save preserves their intended changes.
Keep measurement and automation distinct
A goal and its condition describe KPI configuration. They do not automatically create an email alert or workflow action. If a business rule needs an action, design and verify that separate workflow.
Use refresh history when the age of the underlying data matters, and canvases to present KPIs alongside dashboards.
Updated 3 days ago