Generic filters
Exact matches only

Tables Attributes & Keywords Reference

Use this reference for valid attributes and keywords for mapping Table 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
Table NameThe name of the Table that will appear to your users. Longer names may be truncated on small devices, so consider short names with unique attributes at the beginning (e.g., 'Site 1 Table').Name of the parent attributeyesyesyes
Display OrderThe numeric value that overrides the default alphanumeric order of Tables. Tables with blanks will be sorted alphanumerically and displayed below Tables with numbers.Numeric Valueyesyesyes
DescriptionThe description of the Table 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 Group that Table belongs to (used when Tables belong to only one group). Parent-Child relationships are defined by either this field or a combination of Table Selection Query (on Group) and custom attributes (on Table)nonono
ConnectStringThe ConnectString for the data source used in the query. Pair this with an interface to display a dynamic value.yesyesyes
ConnectString InterfaceThe interface used to retrieve data based on the contents of the ConnectString field. If this field is blank, then the ConnectString field is treated as a constant value.autoyesno
QuerySQL query (or delimited queries) to execute to get data for the Table. Pair this with an interface to display a dynamic value.yesyesyes
Query InterfaceThe interface used to retrieve data based on the contents of the Query field. If this field is blank, then the Query field is treated as a constant value.autoyesno
Query DelimiterDelimiter used to separate multiple queries.yesyesyes
Query Date FormatFormatting applied to {TIMESTAMP} and {TIMESTAMP.Date} parameters passed into the query. If this field is empty windows settings will be used.yesyesyes
Query Time FormatFormatting applied to {TIMESTAMP} and {TIMESTAMP.Time} parameters passed into the query. If this field is empty windows settings will be used.yesyesyes
Start TimeOverrides the default Start Time for the Table (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
Start Time InterfaceThe interface used to retrieve the Start Time value. If this field is blank, then the Start Time field is treated as a constant value.autoyesno
End TimeOverrides the default End Time for the Table (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
End Time InterfaceThe interface used to retrieve the End Time value. If this field is blank, then the End Time field is treated as a constant value.autoyesno
Chart TimeOverrides the default Chart Time for the Table (Note: 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
Chart Time InterfaceInterface used to retrieve the Chart Time value. If this field is blank then the Chart Time field is treated as a constant value.autoyesno
Database Time ZoneThe time zone setting for the database you are querying. Only set this field if the database time zone differs from the web server.string field based on Ids from .Net (http://remy.supertext.ch/2012/04/the-net-timezoneinfo-getsystemtimezones-list/)yesyesyes
Convert TimestampsBoolean (True/False). Controls whether or not timestamps in the returned table will be converted to client time for display. A setting of True will convert all timestamps in the returned table.boolean (t/f) or numeric 1/0yesyesyes
Scroll IntervalNumeric Length of time that timestamp based charts and tables can be scrolled (pair with Scroll Interval UOM)Numeric Valueyesyesyes
Scroll Interval UOMUnit of time that timestamp based charts and tables can be scrolled (pair with Scroll Interval)Minutes, Hours, Days, Weeksyesyesyes
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 AFAttribute 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 called Plant Type with a value of Coal.yesyesyes
ContactThe main contact for the Table, as selected from the Contact tab collection (can be one or more people). The contact appears in Table details.Contact with valid values being the Contact Name as defined in the VKPIyesyesno
ShowBoolean (True/False) or equivalent (Non-zero = True, 0 = False). Sets the Show (visibility) of the Table. A setting of False will suppress the display of the Table to the users. Pair this with an interface to have a dynamic value.yesyesyes
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
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
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
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 Numericyesyesno
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]>yesyesyes
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.autoyesauto
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]>yesyesyes
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.autoyesauto
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]>yesyesyes
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.autoyesauto
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]>yesyesyes
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.autoyesauto
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]>yesyesyes
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.autoyesauto
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]>yesyesyes
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.autoyesauto
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]>yesyesyes
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.autoyesauto
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]>yesyesyes
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.autoyesauto
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]>yesyesyes
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.autoyesauto
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]>yesyesyes
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.autoyesauto
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.yesyesno
Table 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

KPI Attributes & Keywords Reference

Charts Attributes & Keywords Reference

Was this article helpful?

Related Articles