Use this table to reference valid attributes and keywords for mapping KPI metadata from AF, SQL, and inmation databases to Visual KPI Remote Context Service (RCS).
The first column represents the Visual KPI Attribute to which you can map your external elements. Use the Value column to get more information about specific attribute values. The last three columns tell you if such a mapping is possible in either AF, SQL or inmation databases.
Learn more about Mapping AF and SQL Remote Context Service Attributes.
Visual KPI Designer, AF, SQL and inmation Attributes
| Visual KPI Attribute | Description | Value | AF | SQL | inmation |
|---|---|---|---|---|---|
| KPI Name | The name of the KPI that will appear to your users. Longer names may be truncated on small screen devices, so consider short names with unique attributes at the beginning (e.g., 'Site 1 Profit'). | Name of the parent attribute | yes | yes | yes |
| Display Order | Numeric value that overrides the default alphanumeric order of KPIs. KPIs with blanks will be sorted alphanumerically and displayed below KPIs with numbers. | Numeric Value | yes | yes | yes |
| Description | The description of the KPI that will appear to your users. Use longer descriptions, in conjunction with shorter names, to accommodate small screen formats. | Can either be the description of the attribute or a sub attribute called Description. | yes | yes | yes |
| Group Name | The name of the Group that the KPI belongs to (used when KPIs belong to only one group). Parent-Child relationships are defined by either this field or a combination of KPI selection queries (on Group) and custom attributes (on KPI). | no | no | no | |
| Min | The lowest valid value for the KPI -- values below Min will result in an unknown status. Pair this with an interface to display a dynamic Min. | yes | yes | yes | |
| Min Interface | The interface used to retrieve data based on the contents of the Min field. If this field is blank, then the Min field is treated as a constant value. | auto | yes | no | |
| Low Low Low | The limit value for the KPI -- limits values are used in KPI status calculations. Pair this with an interface to display a dynamic value. | yes | yes | yes | |
| Low Low Low Interface | The interface used to retrieve data based on the contents of the Limit field. If this field is blank, then the Limit field is treated as a constant value. | auto | yes | no | |
| Low Low | The limit value for the KPI -- limits values are used in KPI status calculations. Pair this with an interface to display a dynamic value. | yes | yes | yes | |
| Low Low Interface | The interface used to retrieve data based on the contents of the Limit field. If this field is blank, then the Limit field is treated as a constant value. | auto | yes | no | |
| Low | The limit value for the KPI -- limits values are used in KPI status calculations. Pair this with an interface to display a dynamic value. | yes | yes | yes | |
| Low Interface | The interface used to retrieve data based on the contents of the Limit field. If this field is blank, then the Limit field is treated as a constant value. | auto | yes | no | |
| Target | Target (desired) value of the KPI. Pair this with an interface to have a dynamic value. | yes | yes | yes | |
| Target Interface | Interface used to retrieve the data based on the Target field contents. If this field is blank then the Target field is treated as a constant value. | auto | yes | no | |
| Actual | Actual value of the KPI. Pair this with an interface to have a dynamic Actual. | TODO | yes | yes | |
| Actual Interface | Interface to retrieve Actual value for the KPI. If this field is blank then the Actual field is treated as a constant value. | TODO | yes | auto | |
| High | The limit value for the KPI -- limits values are used in KPI status calculations. Pair this with an interface to display a dynamic value. | yes | yes | yes | |
| High Interface | The interface used to retrieve data based on the contents of the Limit field. If this field is blank, then the Limit field is treated as a constant value. | auto | yes | no | |
| High High | The limit value for the KPI -- limits values are used in KPI status calculations. Pair this with an interface to display a dynamic value. | yes | yes | yes | |
| High High Interface | The interface used to retrieve data based on the contents of the Limit field. If this field is blank, then the Limit field is treated as a constant value. | auto | yes | no | |
| High High High | The limit value for the KPI -- limits values are used in KPI status calculations. Pair this with an interface to display a dynamic value. | yes | yes | yes | |
| High High High Interface | The interface used to retrieve data based on the contents of the Limit field. If this field is blank, then the Limit field is treated as a constant value. | auto | yes | no | |
| Max | The highest valid value of the KPI -- values above Max will result in an unknown status. Pair this with an interface to display a dynamic Max. | yes | yes | yes | |
| Max Interface | The interface used to retrieve data based on the contents of the Max field. If this field is blank, then the Max field is treated as a constant value. | auto | yes | no | |
| Offset | The relative time offset used to retrieve values from interfaces for this KPI. This allows for KPIs to show values at different times, such as Profit Today, Profit Yesterday, and Profit Last Week. This value uses our standard offset format (e.g., -1day). | yes | yes | yes | |
| CUSTOM ATTRIBUTES | User-defined attribute. These are used for the grouping of objects and can be used in Group selection queries to determine parent-child relationships. Select 'Attributes' under the Options menu (gear icon) to view/edit custom attributes. | Need to have AF Attribute name or inmation custom properties name the same as the VKPI Custom attribute. If I have a VKPI custom attribute called Plant Type, I can have a string AF Attribute (or inmation custom property called Plant Type with a value of Coal. | yes | yes | yes |
| Numeric Format | The numeric formatting code (.NET) used to modify how numbers are displayed. Click the link in the header for more information. | yes | yes | yes | |
| UOM | The unit of measure (UoM) of the KPI. | yes | yes | yes | |
| Display Format | The display position of the UoM (e.g., $100, 42.5kg). | Number, Number + UOM, UOM + Number | yes | yes | yes |
| Contact | The main contact for the KPI, as selected from the Contact tab collection (can be one or more people). The contact appears in KPI details and is used in notifications. | Contact with valid values being the Contact Name as defined in the VKPI | yes | yes | yes |
| Alternate Contact 1 | The alternate contact for the KPI, as selected from the Contact tab collection (can be one or more people). This contact appears in KPI details and is used in notifications. | Contact with valid values being the Contact Name as defined in the VKPI | yes | yes | yes |
| Alternate Contact 2 | The alternate contact for the KPI, as selected from the Contact tab collection (can be one or more people). This contact appears in KPI details and is used in notifications. | Contact with valid values being the Contact Name as defined in the VKPI | yes | yes | yes |
| Notification Type | Determines if KPI status changes will trigger e-mails to be sent to contacts. If set to 'Email', then a contact must also be assigned. | None, Email | yes | yes | yes |
| Alert Silence | A boolean equivalent used to turn alarm silencing on or off for this KPI (overrides Alert Template setting). Pair this with an interface to display a dynamic value. | boolean (t/f) or numeric 1/0 | yes | yes | yes |
| Alert Silence Interface | The interface used to retrieve the alarm silencing boolean value. If this field is blank, then Alert Silence is treated as a constant value. | auto | yes | no | |
| Alert Silence Duration | The numerical override for the alert silence duration (overrides Alert Template setting). Only valid if the Alert Silence is true. | yes | yes | yes | |
| Time In State | The numerical override for the Time in State (overrides Alert Template setting) -- this is the delay, in minutes, before status is used to determine if notifications are sent. This helps to prevent nuisance notifications for rapidly-changing KPIs. | yes | yes | yes | |
| Alert Template | The template that controls alert behavior for this KPI. | Must be the name of an already defined Alert Template | yes | yes | yes |
| Status | Override of system-calculated KPI status. Allows user to specify static or dynamic value or even an equation involving multiple parameters to determine which of the standard or custom status to display. See KPI Status config for ordinal values. | Either a status name like (Low Low) or the ordinal value (-2) | yes | yes | yes |
| Status Interface | The interface used to retrieve Status. If this field is blank, then the Status field is treated as a constant value. | no | yes | no | |
| In Service | A boolean value used to set KPI's In Service state. Pair this with an interface to display a dynamic value. | boolean (t/f) or numeric 1/0 | yes | yes | yes |
| In Service Interface | The interface used to retrieve the KPI's In Service value. If this field is blank, then the Actual field is treated as a constant value. | auto | yes | no | |
| Show | A boolean value used to specify the KPI's 'Show' setting (visibility) -- 'False' will suppress the display of the KPI to the users. Pair this with an interface to display a dynamic value. | boolean (t/f) or numeric 1/0 | yes | yes | yes |
| Show Interface | The interface used to retrieve the In Show value. If this field is blank, then the Show field is treated as a constant value. | auto | yes | no | |
| Trend Start Time | Overrides the default Start Time for the KPI trend (Note: The Start Time must be < the End Time and the value can be an actual or relative date [e.g., 6/12/2015 or *-7Days]). Pair this with an interface to display a dynamic value. | yes | yes | yes | |
| Trend Start Time Interface | The interface used to retrieve the Trend Start Time value. If this field is blank, then the Trend Start Time field is treated as a constant value. | auto | yes | no | |
| Trend End Time | Overrides the default End Time for the KPI trend (Note: The End Time must be > the Start Time and the value can be an actual or relative date [e.g., 6/12/2015 or *-7Days]). Pair this with an interface to display a dynamic value. | yes | yes | yes | |
| Trend End Time Interface | The interface used to retrieve the Trend End Time value. If this field is blank, then the Trend End Time field is treated as a constant value. | auto | yes | no | |
| Actual Trend Type | The trend line type for the Actual pen on a KPI trend. | Interpolated, Step, Symbol, Interpolated + Symbol, Step + Symbol | yes | yes | yes |
| Target Trend Type | The trend line type for the Target pen on a KPI trend. | Interpolated, Step, Symbol, Interpolated + Symbol, Step + Symbol | yes | yes | yes |
| Limit Trend Type | The trend line type for the limit pens on a KPI trend. | Interpolated, Step, Symbol, Interpolated + Symbol, Step + Symbol | yes | yes | yes |
| Trend Scale | The trend scale type for the KPI. | Single Scale, Multi-scale | yes | yes | yes |
| Trend Y Axis | The trend y axis scale type for the KPI. | Auto-Scale, KPI Min and Max, Min and Max Y Axis | yes | yes | yes |
| Min Y Axis | Override for minimum of trend scale on the y axis. | yes | yes | yes | |
| Max Y Axis | Override for maximum of trend scale on the y axis. | yes | yes | yes | |
| Trend Limits | The default setting to show or hide the limit pens on a KPI trend. Users can still show pens by clicking in the legend. | boolean (t/f) or numeric 1/0 | yes | yes | yes |
| Trend Target | The default setting to show or hide the Target pen on a KPI trend. Users can still show the Target pen by clicking in the legend. | boolean (t/f) or numeric 1/0 | yes | yes | yes |
| Show Average Trendline | A boolean value used to set visibility of a line depicting the average of the Actual trend data within the trend timeframe. | boolean (t/f) or numeric 1/0 | yes | yes | yes |
| Show Status Background | The default setting to show or hide the status bars in the background on a KPI trend. | boolean (t/f) or numeric 1/0 | yes | yes | no |
| Lookup Text Length | The numerical override for the maximum length of lookup text displayed on chart cursors. | yes | yes | yes | |
| Show Calcs In Chart Cursor | A boolean override that controls whether or not calculations (equations) are displayed in chart cursors. | boolean (t/f) or numeric 1/0 | yes | yes | yes |
| Bullet Chart Type | Controls the display type for Bullet Charts. Deviation types require a KPI Target. | Actual EU, Deviation EU, Deviation % | yes | yes | yes |
| Latitude | The geo location latitude value used for display on a Geo Map. Pair this with an interface to display a dynamic location. | yes | yes | yes | |
| Latitude Interface | The interface used to retrieve data based on the contents of the Latitude field. If this field is blank, then the Latitude field is treated as a constant value. | auto | yes | no | |
| Longitude | The geo location longitude value used for display on a Geo Map. Pair this with an interface to display a dynamic location. | yes | yes | yes | |
| Longitude Interface | The interface used to retrieve data based on the contents of the Longitude field. If this field is blank, then the Longitude field is treated as a constant value. | auto | yes | no | |
| Geo Label Format | Overrides what is displayed for a KPI on a Geo Map. | Actual, Name, Name: Actual | yes | yes | yes |
| Sparkline Refresh Interval | The refresh interval (in seconds) for the sparkline. If set to default the site wide screen data update interval will be used. If set to 0 then the sparkline will not auto refresh. | Numeric Value | yes | yes | yes |
| Is SPC | Determines if KPI status and trend are SPC-based. If set to true, then status calculations are based on the worst case status from the violated SPC rules. | boolean (t/f) or numeric 1/0 | yes | yes | yes |
| WE 1: 1 > 3 sigma | Determines KPI Status when Western Electric Rule 1 (any single data point falls outside the 3s limit from the centerline) is triggered. Click on the header for more information. | Either a status name like (Low Low) or the ordinal value (-2) or "Ignore". Can also be an attribute named "WE1" | yes | yes | yes |
| WE 2: 2/3 > 2 sigma | Determines KPI Status when Western Electric Rule 2 (two out of three consecutive points fall beyond the 2s limit on the same side of the centerline) is triggered. Click on the header for more information. | Either a status name like (Low Low) or the ordinal value (-2) or "Ignore". Can also be an attribute named "WE2" | yes | yes | yes |
| WE 3: 4/5 > 1 sigma | Determines KPI Status when Western Electric Rule 3 (four out of five consecutive points fall beyond the 1s limit on the same side of the centerline) is triggered. Click on the header for more information. | Either a status name like (Low Low) or the ordinal value (-2) or "Ignore". Can also be an attribute named "WE3" | yes | yes | yes |
| WE 4: 9 <> CL | Determines KPI Status when Western Electric Rule 4 (nine consecutive points fall on the same side of the centerline ) is triggered. Click on the header for more information. | Either a status name like (Low Low) or the ordinal value (-2) or "Ignore". Can also be an attribute named "WE4" | yes | yes | yes |
| Status Calc Sample Count | The number of points used to determine status for SPC KPIs. This value must be equal to, or greater than, the number of points required for each selected WE Rule. | yes | yes | yes | |
| Limit Calc Start Time | The Start Time that is used to calculate the limits and mean for the SPC KPI (Note: Start Time must be < End Time and the value can be an actual or relative date [e.g., 6/12/2015 or *-7Days]). Pair this with an interface to display a dynamic value. | yes | yes | yes | |
| Limit Calc Start Time Interface | The interface used to retrieve the Limit Calc Start Time value. If this field is blank, then the Limit Calc Start Time field is treated as a constant value. | auto | yes | no | |
| Limit Calc End Time | The End Time that is used to calculate the limits and mean for the SPC KPI (Note: End Time must be > Start Time and the value can be actual or relative date [e.g., 6/12/2015 or *-7Days]). Pair this with an interface to display a dynamic value. | yes | yes | yes | |
| Limit Calc End Time Interface | The interface used to retrieve the Limit Calc End Time value. If this field is blank, then the Limit Calc End Time field is treated as a constant value. | auto | yes | no | |
| LCL | The Lower Control Limit value used to determine SPC rule violations for SPC KPIs. Pair this with an interface to display a dynamic value. | yes | yes | yes | |
| LCL Interface | The interface used to retrieve data based on the contents of the LCL field. If this field is blank, then the LCL field is treated as a constant value. | auto | yes | no | |
| Center Line | Override of Center Line value used to determine SPC rule violations for SPC KPIs. Pair this with an interface to display a dynamic value. | yes | yes | yes | |
| Center Line Interface | The interface used to retrieve data based on the contents of the Center Line field. If this field is blank, then the Center Line field is treated as a constant value. | auto | yes | no | |
| UCL | The Upper Control Limit value used to determine SPC rule violations for SPC KPIs. Pair this with an interface to display a dynamic value. | yes | yes | yes | |
| UCL Interface | The interface used to retrieve data based on the contents of the UCL field. If this field is blank, then the UCL field is treated as a constant value. | auto | yes | no | |
| Info | Additional relevant information (can be hyperlinked). | yes | yes | yes | |
| Info Interface | Interface used to retrieve the data based on the Info field contents. If this field is blank then the Info field is treated as a constant value. | auto | yes | no | |
| Info Numeric Format | The numeric formatting code (.NET) used to modify how numbers are displayed. Click the link in the header for more information. | yes | yes | yes | |
| Info UOM | Unit of measure for the Info value (applicable if value is numeric). | yes | yes | yes | |
| Info Display Format | The display position of the UoM (e.g., $100, 42.5kg). | Number, Number + UOM, UOM + Number | yes | yes | yes |
| Info URL | URL link for the Info field (creates a hyperlink in the Info field). | yes | yes | yes | |
| Info Description | If the Info field is a hyperlinked value, then this will be the tooltip or mouseover text for the link. If only a URL is used, then this will be the text displayed in Info. | yes | yes | yes | |
| Top Text | The value displayed on the top line of a KPI Block in a Group Map or a KPI Map -- if blank, then the default setting of KPI Name will be used. Pair this with an interface to display a dynamic value. | yes | yes | yes | |
| Top Text Interface | The interface used to retrieve data based on the contents of the Top Text field. If this field is blank, then the Top Text field is treated as a constant value. | auto | yes | no | |
| Bottom Text | The value displayed on the bottom line of a KPI Block in a Group Map or a KPI Map -- if blank, then the default setting of Actual will be used. Pair this with an interface to display a dynamic value. | yes | yes | yes | |
| Bottom Text Interface | The interface used to retrieve data based on the contents of the Bottom Text field. If this field is blank, then the Bottom Text field is treated as a constant value. | auto | yes | no | |
| Additional Text | The additional value displayed on the bottom of a KPI Block in a KPI Map -- if blank, then the default setting of Description will be used. Pair this with an interface to display a dynamic value. | yes | yes | yes | |
| Additional Text Interface | The interface used to retrieve data based on the contents of the Addtional Text field. If this field is blank, then the Addition Text field is treated as a constant value. | auto | yes | yes | |
| KPI Name Click Path | Controls what happens when a user clicks the name of a KPI. The user will either be shown the Trend of the KPI (default) or the user will be taken to the first Link defined on the KPI (if one exists). | Trend, URL | yes | yes | yes |
| Group Map Position | The numerical location (left to right, top to bottom) of the KPI in a Group Map. If this is blank, then the KPI will not be shown in the Group Map. | Numeric Value 1 - 20 | yes | yes | |
| Links | List of associated Links or URLs (semicolon separated, limit 10) for the object. | yes | yes | yes | |
| Link Descriptions | List of associated Link or URL descriptions (semicolon separated, limit 10) for the object. These are used to both shorten and give better meaning to links (e.g., instead of www.xyz.com?x=5&type=2, the user could see SOPs or Shift Report) | yes | yes | yes | |
| Calculation Type | Override for how non-numeric values in calculations are handled. This is useful when dealing with exception data (i.e., BadValue) returned from calculation-derived data sources. | Default, Standard, Force Numeric | yes | yes | yes |
| Parameter 1 | Can be used in many fields that need data from multiple sources like Actual, Bar3, Pen4 (any Dynamic field) plus Attributes and Description. Specify in square brackets, e.g. [P1] for single value. Use equation form otherwise, e.g. <[P1]+[P2]-[Min]> | no | yes | no | |
| Parameter 1 Interface | The interface used to retrieve data based on the contents of the Parameter field. If this field is blank, then the Parameter field is treated as a constant value. | no | yes | no | |
| Parameter 2 | Can be used in many fields that need data from multiple sources like Actual, Bar3, Pen4 (any Dynamic field) plus Attributes and Description. Specify in square brackets, e.g. [P1] for single value. Use equation form otherwise, e.g. <[P1]+[P2]-[Min]> | no | yes | no | |
| Parameter 2 Interface | The interface used to retrieve data based on the contents of the Parameter field. If this field is blank, then the Parameter field is treated as a constant value. | no | yes | no | |
| Parameter 3 | Can be used in many fields that need data from multiple sources like Actual, Bar3, Pen4 (any Dynamic field) plus Attributes and Description. Specify in square brackets, e.g. [P1] for single value. Use equation form otherwise, e.g. <[P1]+[P2]-[Min]> | no | yes | no | |
| Parameter 3 Interface | The interface used to retrieve data based on the contents of the Parameter field. If this field is blank, then the Parameter field is treated as a constant value. | no | yes | no | |
| Parameter 4 | Can be used in many fields that need data from multiple sources like Actual, Bar3, Pen4 (any Dynamic field) plus Attributes and Description. Specify in square brackets, e.g. [P1] for single value. Use equation form otherwise, e.g. <[P1]+[P2]-[Min]> | no | yes | no | |
| Parameter 4 Interface | The interface used to retrieve data based on the contents of the Parameter field. If this field is blank, then the Parameter field is treated as a constant value. | no | yes | no | |
| Parameter 5 | Can be used in many fields that need data from multiple sources like Actual, Bar3, Pen4 (any Dynamic field) plus Attributes and Description. Specify in square brackets, e.g. [P1] for single value. Use equation form otherwise, e.g. <[P1]+[P2]-[Min]> | no | yes | no | |
| Parameter 5 Interface | The interface used to retrieve data based on the contents of the Parameter field. If this field is blank, then the Parameter field is treated as a constant value. | no | yes | no | |
| Parameter 6 | Can be used in many fields that need data from multiple sources like Actual, Bar3, Pen4 (any Dynamic field) plus Attributes and Description. Specify in square brackets, e.g. [P1] for single value. Use equation form otherwise, e.g. <[P1]+[P2]-[Min]> | no | yes | no | |
| Parameter 6 Interface | The interface used to retrieve data based on the contents of the Parameter field. If this field is blank, then the Parameter field is treated as a constant value. | no | yes | no | |
| Parameter 7 | Can be used in many fields that need data from multiple sources like Actual, Bar3, Pen4 (any Dynamic field) plus Attributes and Description. Specify in square brackets, e.g. [P1] for single value. Use equation form otherwise, e.g. <[P1]+[P2]-[Min]> | no | yes | no | |
| Parameter 7 Interface | The interface used to retrieve data based on the contents of the Parameter field. If this field is blank, then the Parameter field is treated as a constant value. | no | yes | no | |
| Parameter 8 | Can be used in many fields that need data from multiple sources like Actual, Bar3, Pen4 (any Dynamic field) plus Attributes and Description. Specify in square brackets, e.g. [P1] for single value. Use equation form otherwise, e.g. <[P1]+[P2]-[Min]> | no | yes | no | |
| Parameter 8 Interface | The interface used to retrieve data based on the contents of the Parameter field. If this field is blank, then the Parameter field is treated as a constant value. | no | yes | no | |
| Parameter 9 | Can be used in many fields that need data from multiple sources like Actual, Bar3, Pen4 (any Dynamic field) plus Attributes and Description. Specify in square brackets, e.g. [P1] for single value. Use equation form otherwise, e.g. <[P1]+[P2]-[Min]> | no | yes | no | |
| Parameter 9 Interface | The interface used to retrieve data based on the contents of the Parameter field. If this field is blank, then the Parameter field is treated as a constant value. | no | yes | no | |
| Parameter 10 | Can be used in many fields that need data from multiple sources like Actual, Bar3, Pen4 (any Dynamic field) plus Attributes and Description. Specify in square brackets, e.g. [P1] for single value. Use equation form otherwise, e.g. <[P1]+[P2]-[Min]> | no | yes | no | |
| Parameter 10 Interface | The interface used to retrieve data based on the contents of the Parameter field. If this field is blank, then the Parameter field is treated as a constant value. | no | yes | no | |
| Access Group List | List of Active Directory or local groups (semicolon separated) defining access rights to the object. Only applies if Object Level Security is enabled and the site is secured. | yes | yes | yes | |
| KPI ID | Read-only system level identifier. | auto | auto | auto |
Learn more
Mapping AF and SQL Remote Context Service Attributes
Visual KPI Remote Context Services (RCS)
How Visual KPI Remote Context Server Works
More Attributes & Keywords References
Groups Attributes & Keywords Reference