kpi
- Last UpdatedNov 20, 2024
- 3 minute read
Note: This table is currently not used.
The kpi table allows for any number of KPI values to be defined with their associated properties such as alarm limits etc. It also allows a linkage to be stored that specifies which KPIs are to be captured at which physical entities (departments, lines or machines) and allows the default properties to be overridden for each entity. The same concept is available to extend the linkage and overridable properties to a string based key such as item classes.
|
Field |
Datatype |
PK |
Nulls? |
Description |
|---|---|---|---|---|
|
kpi_name |
string40 |
N |
N |
Unique name for this KPI |
|
key_int |
int32 |
N |
N |
Optional integer (e.g., ent_id or user grp_id) to allow properties of this KPI to be overridden for different entities or user groups. Default value for all entities or users is -1. |
|
key_string |
string40 |
N |
Y |
Optional string (e.g., item_class_id) to allow properties of this KPI to be overridden for different item classes or some other string identifier. Default value for all item classes is "". |
|
kpi_group |
string40 |
N |
N |
Group to which this KPI belongs for the purpose of grouping related KPIs for data entry and reporting. |
|
kpi_desc |
string254 |
N |
Y |
More detailed description of this KPI. |
|
uom |
string40 |
N |
Y |
Unit of measure for this KPI. To handle different units of measure create multiple KPI’s. Unrelated to UOM table. |
|
display_seq |
int32 |
N |
Y |
Display sequence for this KPI. Useful for sorting KPI’s within and across groups. |
|
entry_role |
string40 |
N |
Y |
The role of the user that enters this KPI. Useful for filtering KPI’s by role for data entry. |
|
view_role |
string40 |
N |
Y |
The role of the user that views this KPI. Useful for filtering KPI’s by role for data analysis. |
|
capture_only |
bool |
N |
N |
True if this value is used to calculate other KPI’s and so should be captured but not presented in reports / analytics. Default = No. |
|
long_term_tgt |
tfloat |
N |
Y |
Long term target for this KPI. |
|
short_term_tgt |
tfloat |
N |
Y |
Short term target for this KPI. |
|
upper_reas_limit |
tfloat |
N |
Y |
Upper reasonable limit for this KPI – values above this will not be accepted. |
|
lower_reas_limit |
tfloat |
N |
Y |
Lower reasonable limit for this KPI – values below this will not be accepted. |
|
hihi_alarm_limit |
tfloat |
N |
Y |
High-High alarm limit for this KPI. |
|
hi_alarm_limit |
tfloat |
N |
Y |
High alarm limit for this KPI. |
|
lo_alarm_limit |
tfloat |
N |
Y |
Low alarm limit for this KPI. |
|
lolo_alarm_limit |
tfloat |
N |
Y |
Low-Low alarm limit for this KPI. |
|
last_data_row_id |
int32 |
N |
Y |
Lowest row id from the kpi_data table of any rows inserted for this KPI that have not been processed (processed is considered true if last_data_row_id = last_proc_data_row_id). This value will be maintained by MES as new KPI data rows are added or existing rows edited. |
|
last_proc_data_row_id |
int32 |
N |
Y |
Highest row id in the kpi_data table of recent rows processed by an external system for this KPI. This allows external systems to update this value after processing any rows and thus easily detect when any new KPI data is entered– ie. if this value is different to that in the last_ins_row_id column. |
|
kpi_num_formula |
string254 |
N |
Y |
The equation for calculating the KPI numerator (kpi_data.kpi_value_num). |
|
kpi_den_formula |
string254 |
N |
Y |
The equation for calculating the KPI denominator (kpi_data.kpi_value_den). |
|
spare1 |
string40 |
N |
Y |
Spare value for this KPI that is copied to kpi_data table when a KPI is entered, where it may be updated for a specific instance if required. |
|
spare2 |
string40 |
N |
Y |
Spare value for this KPI as above. |
|
spare3 |
string40 |
N |
Y |
Spare value for this KPI as above. |
|
spare4 |
string40 |
N |
Y |
Spare value for this KPI as above. |
|
last_edit_comment |
string254 |
N |
Y |
Reserved for internal use to indicate why this record was changed |
|
last_edit_by |
string40 |
N |
N |
Who last changed this record |
|
last_edit_at |
tdatetime |
N |
N |
When this record was last changed |
|
row_id |
ID 1 |
Y |
N |
Unique row identifier, for audit trail |
kpi_name, key_int, key_string is clustered UK.