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 Attribute | Description | Value | AF | SQL | inmation |
|---|---|---|---|---|---|
| Table Name | The 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 attribute | yes | yes | yes |
| Display Order | The numeric value that overrides the default alphanumeric order of Tables. Tables with blanks will be sorted alphanumerically and displayed below Tables with numbers. | Numeric Value | yes | yes | yes |
| Description | The 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. | yes | yes | yes |
| Group Name | The 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) | no | no | no | |
| ConnectString | The ConnectString for the data source used in the query. Pair this with an interface to display a dynamic value. | yes | yes | yes | |
| ConnectString Interface | The 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. | auto | yes | no | |
| Query | SQL query (or delimited queries) to execute to get data for the Table. Pair this with an interface to display a dynamic value. | yes | yes | yes | |
| Query Interface | The 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. | auto | yes | no | |
| Query Delimiter | Delimiter used to separate multiple queries. | yes | yes | yes | |
| Query Date Format | Formatting applied to {TIMESTAMP} and {TIMESTAMP.Date} parameters passed into the query. If this field is empty windows settings will be used. | yes | yes | yes | |
| Query Time Format | Formatting applied to {TIMESTAMP} and {TIMESTAMP.Time} parameters passed into the query. If this field is empty windows settings will be used. | yes | yes | yes | |
| Start Time | Overrides 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. | yes | yes | yes | |
| Start Time Interface | The interface used to retrieve the Start Time value. If this field is blank, then the Start Time field is treated as a constant value. | auto | yes | no | |
| End Time | Overrides 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. | yes | yes | yes | |
| End Time Interface | The interface used to retrieve the End Time value. If this field is blank, then the End Time field is treated as a constant value. | auto | yes | no | |
| Chart Time | Overrides 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. | yes | yes | yes | |
| Chart Time Interface | Interface used to retrieve the Chart Time value. If this field is blank then the Chart Time field is treated as a constant value. | auto | yes | no | |
| Database Time Zone | The 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/) | yes | yes | yes |
| Convert Timestamps | Boolean (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/0 | yes | yes | yes |
| Scroll Interval | Numeric Length of time that timestamp based charts and tables can be scrolled (pair with Scroll Interval UOM) | Numeric Value | yes | yes | yes |
| Scroll Interval UOM | Unit of time that timestamp based charts and tables can be scrolled (pair with Scroll Interval) | Minutes, Hours, Days, Weeks | 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 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. | yes | yes | yes |
| Contact | The 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 VKPI | yes | yes | no |
| Show | Boolean (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. | 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 | |
| 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 | |
| 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 | |
| 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 | 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]> | yes | yes | yes | |
| 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. | auto | yes | auto | |
| 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]> | yes | yes | yes | |
| 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. | auto | yes | auto | |
| 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]> | yes | yes | yes | |
| 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. | auto | yes | auto | |
| 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]> | yes | yes | yes | |
| 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. | auto | yes | auto | |
| 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]> | yes | yes | yes | |
| 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. | auto | yes | auto | |
| 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]> | yes | yes | yes | |
| 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. | auto | yes | auto | |
| 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]> | yes | yes | yes | |
| 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. | auto | yes | auto | |
| 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]> | yes | yes | yes | |
| 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. | auto | yes | auto | |
| 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]> | yes | yes | yes | |
| 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. | auto | yes | auto | |
| 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]> | yes | yes | yes | |
| 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. | auto | yes | auto | |
| 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 | no | |
| Table 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