Search
Generic filters
Exact matches only

KPI Attributes & Keywords Reference

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 AttributeDescriptionValueAFSQLinmation
KPI NameThe 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 attributeyesyesyes
Display OrderNumeric value that overrides the default alphanumeric order of KPIs. KPIs with blanks will be sorted alphanumerically and displayed below KPIs with numbers.Numeric Valueyesyesyes
DescriptionThe 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.yesyesyes
Group NameThe 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).nonono
MinThe 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.yesyesyes
Min InterfaceThe 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.autoyesno
Low Low LowThe limit value for the KPI -- limits values are used in KPI status calculations. Pair this with an interface to display a dynamic value.yesyesyes
Low Low Low InterfaceThe 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.autoyesno
Low LowThe limit value for the KPI -- limits values are used in KPI status calculations. Pair this with an interface to display a dynamic value.yesyesyes
Low Low InterfaceThe 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.autoyesno
LowThe limit value for the KPI -- limits values are used in KPI status calculations. Pair this with an interface to display a dynamic value.yesyesyes
Low InterfaceThe 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.autoyesno
TargetTarget (desired) value of the KPI. Pair this with an interface to have a dynamic value.yesyesyes
Target InterfaceInterface 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.autoyesno
ActualActual value of the KPI. Pair this with an interface to have a dynamic Actual.TODOyesyes
Actual InterfaceInterface to retrieve Actual value for the KPI. If this field is blank then the Actual field is treated as a constant value.TODOyesauto
HighThe limit value for the KPI -- limits values are used in KPI status calculations. Pair this with an interface to display a dynamic value.yesyesyes
High InterfaceThe 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.autoyesno
High HighThe limit value for the KPI -- limits values are used in KPI status calculations. Pair this with an interface to display a dynamic value.yesyesyes
High High InterfaceThe 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.autoyesno
High High HighThe limit value for the KPI -- limits values are used in KPI status calculations. Pair this with an interface to display a dynamic value.yesyesyes
High High High InterfaceThe 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.autoyesno
MaxThe 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.yesyesyes
Max InterfaceThe 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.autoyesno
OffsetThe 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).yesyesyes
CUSTOM ATTRIBUTESUser-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.yesyesyes
Numeric FormatThe numeric formatting code (.NET) used to modify how numbers are displayed. Click the link in the header for more information.yesyesyes
UOMThe unit of measure (UoM) of the KPI.yesyesyes
Display FormatThe display position of the UoM (e.g., $100, 42.5kg).Number, Number + UOM, UOM + Numberyesyesyes
ContactThe 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 VKPIyesyesyes
Alternate Contact 1The 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 VKPIyesyesyes
Alternate Contact 2The 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 VKPIyesyesyes
Notification TypeDetermines 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, Emailyesyesyes
Alert SilenceA 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/0yesyesyes
Alert Silence InterfaceThe interface used to retrieve the alarm silencing boolean value. If this field is blank, then Alert Silence is treated as a constant value.autoyesno
Alert Silence DurationThe numerical override for the alert silence duration (overrides Alert Template setting). Only valid if the Alert Silence is true.yesyesyes
Time In StateThe 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.yesyesyes
Alert TemplateThe template that controls alert behavior for this KPI.Must be the name of an already defined Alert Templateyesyesyes
StatusOverride 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)yesyesyes
Status InterfaceThe interface used to retrieve Status. If this field is blank, then the Status field is treated as a constant value.noyesno
In ServiceA 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/0yesyesyes
In Service InterfaceThe 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.autoyesno
ShowA 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/0yesyesyes
Show InterfaceThe interface used to retrieve the In Show value. If this field is blank, then the Show field is treated as a constant value.autoyesno
Trend Start TimeOverrides 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.yesyesyes
Trend Start Time InterfaceThe 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.autoyesno
Trend End TimeOverrides 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.yesyesyes
Trend End Time InterfaceThe 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.autoyesno
Actual Trend TypeThe trend line type for the Actual pen on a KPI trend.Interpolated, Step, Symbol, Interpolated + Symbol, Step + Symbolyesyesyes
Target Trend TypeThe trend line type for the Target pen on a KPI trend.Interpolated, Step, Symbol, Interpolated + Symbol, Step + Symbolyesyesyes
Limit Trend TypeThe trend line type for the limit pens on a KPI trend.Interpolated, Step, Symbol, Interpolated + Symbol, Step + Symbolyesyesyes
Trend ScaleThe trend scale type for the KPI.Single Scale, Multi-scaleyesyesyes
Trend Y AxisThe trend y axis scale type for the KPI.Auto-Scale, KPI Min and Max, Min and Max Y Axisyesyesyes
Min Y AxisOverride for minimum of trend scale on the y axis.yesyesyes
Max Y AxisOverride for maximum of trend scale on the y axis.yesyesyes
Trend LimitsThe 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/0yesyesyes
Trend TargetThe 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/0yesyesyes
Show Average TrendlineA 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/0yesyesyes
Show Status BackgroundThe default setting to show or hide the status bars in the background on a KPI trend.boolean (t/f) or numeric 1/0yesyesno
Lookup Text LengthThe numerical override for the maximum length of lookup text displayed on chart cursors.yesyesyes
Show Calcs In Chart CursorA boolean override that controls whether or not calculations (equations) are displayed in chart cursors.boolean (t/f) or numeric 1/0yesyesyes
Bullet Chart TypeControls the display type for Bullet Charts. Deviation types require a KPI Target.Actual EU, Deviation EU, Deviation %yesyesyes
LatitudeThe geo location latitude value used for display on a Geo Map. Pair this with an interface to display a dynamic location.yesyesyes
Latitude InterfaceThe 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.autoyesno
LongitudeThe geo location longitude value used for display on a Geo Map. Pair this with an interface to display a dynamic location.yesyesyes
Longitude InterfaceThe 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.autoyesno
Geo Label FormatOverrides what is displayed for a KPI on a Geo Map.Actual, Name, Name: Actualyesyesyes
Sparkline Refresh IntervalThe 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 Valueyesyesyes
Is SPCDetermines 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/0yesyesyes
WE 1: 1 > 3 sigmaDetermines 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"yesyesyes
WE 2: 2/3 > 2 sigmaDetermines 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"yesyesyes
WE 3: 4/5 > 1 sigmaDetermines 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"yesyesyes
WE 4: 9 <> CLDetermines 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"yesyesyes
Status Calc Sample CountThe 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.yesyesyes
Limit Calc Start TimeThe 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.yesyesyes
Limit Calc Start Time InterfaceThe 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.autoyesno
Limit Calc End TimeThe 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.yesyesyes
Limit Calc End Time InterfaceThe 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.autoyesno
LCLThe Lower Control Limit value used to determine SPC rule violations for SPC KPIs. Pair this with an interface to display a dynamic value.yesyesyes
LCL InterfaceThe 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.autoyesno
Center LineOverride of Center Line value used to determine SPC rule violations for SPC KPIs. Pair this with an interface to display a dynamic value.yesyesyes
Center Line InterfaceThe 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.autoyesno
UCLThe Upper Control Limit value used to determine SPC rule violations for SPC KPIs. Pair this with an interface to display a dynamic value.yesyesyes
UCL InterfaceThe 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.autoyesno
InfoAdditional relevant information (can be hyperlinked).yesyesyes
Info InterfaceInterface 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.autoyesno
Info Numeric FormatThe numeric formatting code (.NET) used to modify how numbers are displayed. Click the link in the header for more information.yesyesyes
Info UOMUnit of measure for the Info value (applicable if value is numeric).yesyesyes
Info Display FormatThe display position of the UoM (e.g., $100, 42.5kg).Number, Number + UOM, UOM + Numberyesyesyes
Info URLURL link for the Info field (creates a hyperlink in the Info field).yesyesyes
Info DescriptionIf 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.yesyesyes
Top TextThe 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.yesyesyes
Top Text InterfaceThe 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.autoyesno
Bottom TextThe 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.yesyesyes
Bottom Text InterfaceThe 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.autoyesno
Additional TextThe 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.yesyesyes
Additional Text InterfaceThe 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.autoyesyes
KPI Name Click PathControls 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, URLyesyesyes
Group Map PositionThe 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 - 20yesyes
LinksList of associated Links or URLs (semicolon separated, limit 10) for the object.yesyesyes
Link DescriptionsList 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)yesyesyes
Calculation TypeOverride 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 Numericyesyesyes
Parameter 1Can 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]>noyesno
Parameter 1 InterfaceThe 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.noyesno
Parameter 2Can 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]>noyesno
Parameter 2 InterfaceThe 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.noyesno
Parameter 3Can 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]>noyesno
Parameter 3 InterfaceThe 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.noyesno
Parameter 4Can 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]>noyesno
Parameter 4 InterfaceThe 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.noyesno
Parameter 5Can 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]>noyesno
Parameter 5 InterfaceThe 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.noyesno
Parameter 6Can 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]>noyesno
Parameter 6 InterfaceThe 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.noyesno
Parameter 7Can 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]>noyesno
Parameter 7 InterfaceThe 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.noyesno
Parameter 8Can 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]>noyesno
Parameter 8 InterfaceThe 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.noyesno
Parameter 9Can 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]>noyesno
Parameter 9 InterfaceThe 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.noyesno
Parameter 10Can 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]>noyesno
Parameter 10 InterfaceThe 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.noyesno
Access Group ListList 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.yesyesyes
KPI IDRead-only system level identifier.autoautoauto

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

Charts Attributes & Keywords Reference

Tables Attributes & Keywords Reference

Was this article helpful?

Related Articles