Search
Generic filters
Exact matches only

Groups Attributes & Keywords Reference

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 AttributeDescriptionValueAFSQLinmation
Group NameThe 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 DisplayOrderyesyesyes
Display OrderNumeric value that overrides the default alphanumeric order of Groups. Groups with blanks will be sorted alphanumerically and displayed below Groups with numbers.Numeric Valueyesyesyes
DescriptionThe 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 DisplayOrderyesyesyes
Parent NameThe 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 hierarchyyesno
Group Selection QueryDetermines 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.noyesno
KPI Selection QueryDetermines 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.noyesno
Chart Selection QueryDetermines 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.noyesno
Table Selection QueryDetermines 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.noyesno
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 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.yesyesyes
ContactThe 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 VKPIyesyesyes
Default TabOverrides the default tab selection (Groups, KPIs, Charts, etc.) when the Group is selected.Default, Groups, KPIs, Charts, Tables, Systemyesyesyes
Default Group ViewOverrides the default Group View (List, Geo Map, etc.) when the Groups tab is selected.Default, List, Geo Mapyesyesyes
Default KPI ViewOverrides 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 Mapyesyesyes
Default Chart ViewOverrides the default Chart View (List, Geo Map, etc.) when the Charts tab is selected.Default, List, Geo Mapyesyesyes
Default Table ViewOverrides the default Table View (List, Geo Map, etc.) when the Tables tab is selected.Default, List, Geo Mapyesyesyes
Default Group ExpansionControls whether the Groups view will be expanded (show child groups) or collapsed when the Groups tab is selected.Collapsed, Expandedyesyesyes
Default KPI ExpansionControls whether the KPIs view will be expanded (show KPIs in child Groups) or collapsed when the KPIs tab is selected.Collapsed, Expandedyesyesyes
Default Chart ExpansionControls whether the Charts view will be expanded (show child Charts in child Groups) or collapsed when the Charts tab is selected.Collapsed, Expandedyesyesyes
Default Table ExpansionControls whether the Tables view will be expanded (show child Tables in child Groups) or collapsed when the Charts tab is selected.Collapsed, Expandedyesyesyes
Attribute GroupingOverrides 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.yesyesyes
ShowA 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/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
Show SparklinesControls whether or not Sparklines are shown for KPIs and Charts in this Group (Sparklines feature must be enabled).boolean (t/f) or numeric 1/0yesyesyes
Sparkline Start TimeOverrides 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)yesyesyes
Sparkline Start Time InterfaceThe 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.autoyesno
Sparkline End TimeOverrides 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)yesyesyes
Sparkline End Time InterfaceThe 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.autoyesno
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
Zoom LevelOverrides the default Google Maps zoom level on Geo Maps.Numeric Value 1 - 21yesyesyes
Geo Label FormatOverrides what is displayed for a Group on a Geo Map.Default, Name, Name: Infoyesyesyes
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
KPI Actual Column Display NameOverrides the default Actual column name (header) for KPIs in this Group.yesyesyes
KPI Target Column Display NameOverrides the default Target column name (header) for KPIs in this Group.yesyesyes
Group Info Column Display NameOverrides the default Info column name (header) for Groups in this Group.yesyesyes
Show Group Info ColumnControls if the Info column is displayed for Groups in this Group.boolean (t/f) or numeric 1/0yesyesyes
KPI Info Column Display NameOverrides the default Info column name (header) for KPIs in this Group.yesyesyes
Show KPI Info ColumnControls if the Info column is displayed for KPIs in this Group.boolean (t/f) or numeric 1/0yesyesyes
Chart Info Column Display NameOverrides the default Info column name (header) for Charts in this Group.yesyesyes
Show Chart Info ColumnControls if the Info column is displayed for Charts in this Group.boolean (t/f) or numeric 1/0yesyesyes
Table Info Column Display NameOverrides the default Info column name (header) for Tables in this Group.yesyesyes
Show Table Info ColumnControls if the Info column is displayed for Tables in this Group.boolean (t/f) or numeric 1/0yesyesyes
Group Map KPI Cell CountOverrides the default number of KPI cells displayed on each Group Map (1 min and 20 max).1 to 20yesyesyes
Group Map Header PriorityOverrides 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 Colorsyesyesyes
Group Map ExpansionOverrides the default Group Map settings for expanded or collapsed (header only).Collapsed, Expandedyesyesyes
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 Numericyesno
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
Group 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

KPI Attributes & Keywords Reference

Charts Attributes & Keywords Reference

Tables Attributes & Keywords Reference

Was this article helpful?

Related Articles