Use this table to reference valid attributes and keywords for mapping Groups 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 |
|---|---|---|---|---|---|
| Group Name | The name of the Group 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'). | Elements are groups, so name of element. Can also be a sub attribute called Name. SQL: Name, Group Name or GroupName, Display Order or DisplayOrder | yes | yes | yes |
| Display Order | Numeric value that overrides the default alphanumeric order of Groups. Groups with blanks will be sorted alphanumerically and displayed below Groups with numbers. | Numeric Value | yes | yes | yes |
| Description | The description of the Group 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 Element or a sub attribute called Description. SQL: isplay Order or DisplayOrder | yes | yes | yes |
| Parent Name | The name of the parent Group that this Group belongs to (Note: This is used when Groups have only one parent). Parent-Child relationships are defined by either this field or a combination of Group Selection Query and custom attributes. | auto from position in hierarchy | yes | no | |
| Group Selection Query | Determines what child Groups will appear in this Group based on their attributes (e.g., all Groups where 'Region' = 'Region NE'). For Groups with only 1 parent, it is best to use the Parent Name field on the child Groups. | no | yes | no | |
| KPI Selection Query | Determines what KPIs will appear in this Group based on their attributes (e.g., all KPIs where 'Region' = 'Region NE'). For KPIs with only 1 parent, it is best to use the Group Name field on the KPIs. | no | yes | no | |
| Chart Selection Query | Determines what Charts (Trends, Pareto Charts, XY Plots, etc.) will appear in this Group based on their attributes (e.g., all Charts where 'Region' = 'Region NE'). For Charts with only 1 parent, it is best to use the Group Name field on the Charts. | no | yes | no | |
| Table Selection Query | Determines what Tables will appear in this Group based on their attributes (e.g., all Tables where 'Region' = 'Region NE'). For Tables with only 1 parent, it is best to use the Group Name field on the Tables. | no | yes | no | |
| 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 and inmation custom property 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 |
| Contact | The main contact for the Group chosen from the collection defined in the Contact tab (can be one or more people). This appears in Group details. | Contact with valid values being the Contact Name as defined in the VKPI | yes | yes | yes |
| Default Tab | Overrides the default tab selection (Groups, KPIs, Charts, etc.) when the Group is selected. | Default, Groups, KPIs, Charts, Tables, System | yes | yes | yes |
| Default Group View | Overrides the default Group View (List, Geo Map, etc.) when the Groups tab is selected. | Default, List, Geo Map | yes | yes | yes |
| Default KPI View | Overrides the default KPI View (List, Geo Map, KPI Map, etc.) when the KPIs tab is selected. | Default, List, KPI Map, Bullet Chart, Geo Map, Group Map | yes | yes | yes |
| Default Chart View | Overrides the default Chart View (List, Geo Map, etc.) when the Charts tab is selected. | Default, List, Geo Map | yes | yes | yes |
| Default Table View | Overrides the default Table View (List, Geo Map, etc.) when the Tables tab is selected. | Default, List, Geo Map | yes | yes | yes |
| Default Group Expansion | Controls whether the Groups view will be expanded (show child groups) or collapsed when the Groups tab is selected. | Collapsed, Expanded | yes | yes | yes |
| Default KPI Expansion | Controls whether the KPIs view will be expanded (show KPIs in child Groups) or collapsed when the KPIs tab is selected. | Collapsed, Expanded | yes | yes | yes |
| Default Chart Expansion | Controls whether the Charts view will be expanded (show child Charts in child Groups) or collapsed when the Charts tab is selected. | Collapsed, Expanded | yes | yes | yes |
| Default Table Expansion | Controls whether the Tables view will be expanded (show child Tables in child Groups) or collapsed when the Charts tab is selected. | Collapsed, Expanded | yes | yes | yes |
| Attribute Grouping | Overrides the default way objects are grouped (by Status, Group, custom attributes, etc.) when expanded. | Default, None, Status, Group, any custom attribute defined in vKPI (ie Plant, Unit, etc). inmation: use custom properties. | yes | yes | yes |
| Show | A boolean value used to specify the Group's 'Show' setting (visibility) -- a setting of 'False' will suppress the display of the Group 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 | |
| Show Sparklines | Controls whether or not Sparklines are shown for KPIs and Charts in this Group (Sparklines feature must be enabled). | boolean (t/f) or numeric 1/0 | yes | yes | yes |
| Sparkline Start Time | Overrides the default End Time for sparklines in this group (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. | Relative or absolute (ie * or 4/25/2018 1:00:04 PM) | yes | yes | yes |
| Sparkline Start Time Interface | The interface used to retrieve the Sparkline Start Time value. If this field is blank, then the Trend Start Time field is treated as a constant value. | auto | yes | no | |
| Sparkline End Time | Overrides the default end time for and sparklines in this group. This value can be either an actual or relative date (e.g. 6/12/2015 or *-7Days). End time must be > Start time. Pair this with an interface to have a dynamic value. | Relative or absolute (ie * or 4/25/2018 1:00:04 PM) | yes | yes | yes |
| Sparkline End Time Interface | The interface used to retrieve the Sparkline End Time value. If this field is blank, then the Trend End Time field is treated as a constant value. | auto | yes | no | |
| 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 | |
| Zoom Level | Overrides the default Google Maps zoom level on Geo Maps. | Numeric Value 1 - 21 | yes | yes | yes |
| Geo Label Format | Overrides what is displayed for a Group on a Geo Map. | Default, Name, Name: Info | yes | yes | yes |
| 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 | |
| KPI Actual Column Display Name | Overrides the default Actual column name (header) for KPIs in this Group. | yes | yes | yes | |
| KPI Target Column Display Name | Overrides the default Target column name (header) for KPIs in this Group. | yes | yes | yes | |
| Group Info Column Display Name | Overrides the default Info column name (header) for Groups in this Group. | yes | yes | yes | |
| Show Group Info Column | Controls if the Info column is displayed for Groups in this Group. | boolean (t/f) or numeric 1/0 | yes | yes | yes |
| KPI Info Column Display Name | Overrides the default Info column name (header) for KPIs in this Group. | yes | yes | yes | |
| Show KPI Info Column | Controls if the Info column is displayed for KPIs in this Group. | boolean (t/f) or numeric 1/0 | yes | yes | yes |
| Chart Info Column Display Name | Overrides the default Info column name (header) for Charts in this Group. | yes | yes | yes | |
| Show Chart Info Column | Controls if the Info column is displayed for Charts in this Group. | boolean (t/f) or numeric 1/0 | yes | yes | yes |
| Table Info Column Display Name | Overrides the default Info column name (header) for Tables in this Group. | yes | yes | yes | |
| Show Table Info Column | Controls if the Info column is displayed for Tables in this Group. | boolean (t/f) or numeric 1/0 | yes | yes | yes |
| Group Map KPI Cell Count | Overrides the default number of KPI cells displayed on each Group Map (1 min and 20 max). | 1 to 20 | yes | yes | yes |
| Group Map Header Priority | Overrides default Group Map cell header behavior. 'Recently Changed' sets the header color to the recently changed KPI status and Icon to overall KPI status. 'Overall' sets header color to the overall KPI status and Icon to recently changed status. | Overall, Recently Changed, Custom Colors | yes | yes | yes |
| Group Map Expansion | Overrides the default Group Map settings for expanded or collapsed (header only). | Collapsed, Expanded | yes | 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 | no | |
| 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 | |
| Group 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
KPI Attributes & Keywords Reference