Bookmarks
Group Bookmarks
Group List
| Attribute Name | Attribute Type | Required | Notes |
|---|---|---|---|
| AF Object ID | String | Yes | ID of AF Element mapping to the Visual KPI Group |
| Expand | Boolean | No | A setting of false (default) will only list child groups while a setting of true will list all descendant groups |
| Filter | String | No | A semicolon (;) delimited list of status ordinals to filter out. E.g. “3:0:-102” will filter out HHH, Good and Not In Service |
Showing 1 to 3 of 3 entries
Group Geo
| Attribute Name | Attribute Type | Required | Notes |
|---|---|---|---|
| AF Object ID | String | Yes | ID of AF Element mapping to the Visual KPI Group |
| Expand | Boolean | No | A setting of false (default) will only list child groups while a setting of true will list all descendant groups |
| Filter | String | No | A semicolon (;) delimited list of status ordinals to filter out. E.g. “3:0:-102” will filter out HHH, Good and Not In Service |
Showing 1 to 3 of 3 entries
KPI Bookmarks
KPI List
KPI Geo
KPI Bullet
KPI Map
Group Map
KPI Summary History
KPI Status History
KPI Notification History
KPI Trend
Gauge Chart
KPI List
| Attribute Name | Attribute Type | Required | Notes |
|---|---|---|---|
| AF Object ID | String | Yes | ID of AF Element mapping to the Visual KPI Group |
| Expand | Boolean | No | A setting of false (default) will only list child KPIs of the Group while a setting of true will list all descendant KPIs |
| Filter | String | No | A semicolon (;) delimited list of status ordinals to filter out. E.g. “3:0:-102” will filter out HHH, Good and Not In Service |
| Group By | String | No | This can be used to override the default grouping. Standard Attributes (None, Status, Group) and Custom Attributes (e.g., Unit, Region, etc.) can be used. |
| Start Time | String | No | Overrides the default Start Time for Sparklines. This must be paired with an End Time). Can be relative (*-8h) or a fixed timestamp |
| End Time | String | No | Overrides the default End Time for Sparklines. This must be paired with a Start Time). Can be relative (*) or a fixed timestamp |
Showing 1 to 6 of 6 entries
KPI Geo
| Attribute Name | Attribute Type | Required | Notes |
|---|---|---|---|
| AF Object ID | String | Yes | ID of AF Element mapping to the Visual KPI Group |
| Expand | Boolean | No | A setting of false (default) will only list child KPIs of the Group while a setting of true will list all descendant KPIs |
| Filter | String | No | A semicolon (;) delimited list of status ordinals to filter out. E.g. “3:0:-102” will filter out HHH, Good and Not In Service |
Showing 1 to 3 of 3 entries
KPI Bullet
| Attribute Name | Attribute Type | Required | Notes |
|---|---|---|---|
| AF Object ID | String | Yes | ID of AF Element mapping to the Visual KPI Group |
| Expand | Boolean | No | A setting of false (default) will only list child KPIs of the Group while a setting of true will list all descendant KPIs |
| Filter | String | No | A semicolon (;) delimited list of status ordinals to filter out. E.g. “3:0:-102” will filter out HHH, Good and Not In Service |
| Group By | String | No | This can be used to override the default grouping. Standard Attributes (None, Status, Group) and Custom Attributes (e.g., Unit, Region, etc.) can be used. |
| Start Time | String | No | Overrides the default Start Time for Sparklines. This must be paired with an End Time). Can be relative (*-8h) or a fixed timestamp |
| End Time | String | No | Overrides the default End Time for Sparklines. This must be paired with a Start Time). Can be relative (*) or a fixed timestamp |
Showing 1 to 6 of 6 entries
KPI Map
| Attribute Name | Attribute Type | Required | Notes |
|---|---|---|---|
| AF Object ID | String | Yes | ID of AF Element mapping to the Visual KPI Group |
| Expand | Boolean | No | A setting of false (default) will only list child KPIs of the Group while a setting of true will list all descendant KPIs |
| Filter | String | No | A semicolon (;) delimited list of status ordinals to filter out. E.g. “3:0:-102” will filter out HHH, Good and Not In Service |
| Group By | String | No | This can be used to override the default grouping. Standard Attributes (None, Status, Group) and Custom Attributes (e.g., Unit, Region, etc.) can be used. |
| Start Time | String | No | Overrides the default Start Time for Sparklines. This must be paired with an End Time). Can be relative (*-8h) or a fixed timestamp |
| End Time | String | No | Overrides the default End Time for Sparklines. This must be paired with a Start Time). Can be relative (*) or a fixed timestamp |
Showing 1 to 6 of 6 entries
Group Map
| Attribute Name | Attribute Type | Required | Notes |
|---|---|---|---|
| AF Object ID | String | Yes | ID of AF Element mapping to the Visual KPI Group |
| Expand | Boolean | No | A setting of false (default) will only list child KPIs of the Group while a setting of true will list all descendant KPIs |
| Filter | String | No | A semicolon (;) delimited list of status ordinals to filter out. E.g. “3:0:-102” will filter out HHH, Good and Not In Service |
| Group By | String | No | This can be used to override the default grouping. Standard Attributes (None, Status, Group) and Custom Attributes (e.g. Unit, Region, etc) can be used. |
| Start Time | String | No | Overrides the default Start Time for Sparklines. This must be paired with an End Time). Can be relative (*-8h) or a fixed timestamp |
| End Time | String | No | Overrides the default End Time for Sparklines. This must be paired with a Start Time). Can be relative (*) or a fixed timestamp |
| Group Map Expansion | String | No | Overrides the default Group Map (Header) Expansion. Value should be either Collapsed or Expanded |
Showing 1 to 7 of 7 entries
KPI Summary History
| Attribute Name | Attribute Type | Required | Notes |
|---|---|---|---|
| AF Object ID | String | Yes | ID of AF Element mapping to the Visual KPI Group |
| Expand | Boolean | No | A setting of false (default) will only list child KPIs of the Group while a setting of true will list all descendant KPIs |
| Filter | String | No | A semicolon (;) delimited list of status ordinals to filter out. E.g. “3:0:-102” will filter out HHH, Good and Not In Service |
Showing 1 to 3 of 3 entries
KPI Status History
| Attribute Name | Attribute Type | Required | Notes |
|---|---|---|---|
| AF Object ID | String | Yes | ID of AF Element mapping to the Visual KPI Group |
| Expand | Boolean | No | A setting of false (default) will only list child KPIs of the Group while a setting of true will list all descendant KPIs |
| Filter | String | No | A semicolon (;) delimited list of status ordinals to filter out. E.g. “3:0:-102” will filter out HHH, Good and Not In Service |
Showing 1 to 3 of 3 entries
KPI Notification History
| Attribute Name | Attribute Type | Required | Notes |
|---|---|---|---|
| AF Object ID | String | Yes | ID of AF Element mapping to the Visual KPI Group |
| Expand | Boolean | No | A setting of false (default) will only list child KPIs of the Group while a setting of true will list all descendant KPIs |
| Filter | String | No | A semicolon (;) delimited list of status ordinals to filter out. E.g. “3:0:-102” will filter out HHH, Good and Not In Service |
Showing 1 to 3 of 3 entries
KPI Trend
| Attribute Name | Attribute Type | Required | Notes |
|---|---|---|---|
| AF Object ID | String | Yes | ID of AF Attribute mapping to the Visual KPI KPI |
| Start Time | String | No | Overrides the default Start Time for the Trend. This must be paired with an End Time). Can be relative (*-8h) or a fixed timestamp |
| End Time | String | No | Overrides the default End Time for the Trend. This must be paired with a Start Time). Can be relative (*) or a fixed timestamp |
| Show Status Background | Boolean | No | True to enable, False to disable |
Showing 1 to 4 of 4 entries
Gauge Chart (KPI Gauge)
| Attribute Name | Attribute Type | Required | Notes |
|---|---|---|---|
| AF Object ID | String | Yes | ID of AF Attribute mapping to the Visual KPI KPI |
| Start Time | String | No | Overrides the default Start Time for the Chart. This must be paired with an End Time). Can be relative (*-8h) or a fixed timestamp |
| End Time | String | No | Overrides the default End Time for the Chart. This must be paired with a Start Time). Can be relative (*) or a fixed timestamp |
Showing 1 to 3 of 3 entries
Chart Bookmarks
Chart List
| Attribute Name | Attribute Type | Required | Notes |
|---|---|---|---|
| AF Object ID | String | Yes | ID of AF Element mapping to the Visual KPI Group |
| Expand | Boolean | No | A setting of false (default) will only list child Charts of the Group while a setting of true will list all descendant Charts |
| Group By | String | No | This can be used to override the default grouping. Standard Attributes (None, Chart Type, Group) and Custom Attributes (e.g., Unit, Region, etc) can be used. |
| Start Time | String | No | Overrides the default Start Time for Sparklines. This must be paired with an End Time). Can be relative (*-8h) or a fixed timestamp |
| End Time | String | No | Overrides the default End Time for Sparklines. This must be paired with a Start Time). Can be relative (*) or a fixed timestamp |
Showing 1 to 5 of 5 entries
Chart Geo
| Attribute Name | Attribute Type | Required | Notes |
|---|---|---|---|
| AF Object ID | String | Yes | ID of AF Element mapping to the Visual KPI Group |
| Expand | Boolean | No | A setting of false (default) will only list child Charts of the Group while a setting of true will list all descendant Charts |
Showing 1 to 2 of 2 entries
Bar Chart
| Attribute Name | Attribute Type | Required | Notes |
|---|---|---|---|
| AF Object ID | String | Yes | ID of AF Attribute mapping to the Visual KPI Bar Chart |
| Start Time | String | No | Overrides the default Start Time for the Chart. This must be paired with an End Time). Can be relative (*-8h) or a fixed timestamp |
| End Time | String | No | Overrides the default End Time for the Chart. This must be paired with a Start Time). Can be relative (*) or a fixed timestamp |
| Timestamp | String | No | Overrides the default Chart Time for the Chart. Can be relative (*) or a fixed timestamp |
Showing 1 to 4 of 4 entries
Box Plot
| Attribute Name | Attribute Type | Required | Notes |
|---|---|---|---|
| AF Object ID | String | Yes | ID of AF Attribute mapping to the Visual KPI Box Plot |
| Start Time | String | No | Overrides the default Start Time for the Chart. This must be paired with an End Time). Can be relative (*-8h) or a fixed timestamp |
| End Time | String | No | Overrides the default End Time for the Chart. This must be paired with a Start Time). Can be relative (*) or a fixed timestamp |
| Timestamp | String | No | Overrides the default Chart Time for the Chart. Can be relative (*) or a fixed timestamp |
Showing 1 to 4 of 4 entries
Embedded Content
| Attribute Name | Attribute Type | Required | Notes |
|---|---|---|---|
| AF Object ID | String | Yes | ID of AF Attribute mapping to the Visual KPI Embedded Content |
| Start Time | String | No | Overrides the default Start Time for the content. This must be paired with an End Time). Can be relative (*-8h) or a fixed timestamp |
| End Time | String | No | Overrides the default End Time for content. This must be paired with a Start Time). Can be relative (*) or a fixed timestamp |
| Timestamp | String | No | Overrides the default Chart Time for the content. Can be relative (*) or a fixed timestamp |
Showing 1 to 4 of 4 entries
Gantt Chart
| Attribute Name | Attribute Type | Required | Notes |
|---|---|---|---|
| AF Object ID | String | Yes | ID of AF Attribute mapping to the Visual KPI Gantt Chart |
| Start Time | String | No | Overrides the default Start Time for the content. This must be paired with an End Time). Can be relative (*-8h) or a fixed timestamp |
| End Time | String | No | Overrides the default End Time for the Chart. This must be paired with a Start Time). Can be relative (*) or a fixed timestamp |
| Timestamp | String | No | Overrides the default Chart Time for the Chart. Can be relative (*) or a fixed timestamp |
Showing 1 to 4 of 4 entries
Pareto Chart
| Attribute Name | Attribute Type | Required | Notes |
|---|---|---|---|
| AF Object ID | String | Yes | ID of AF Attribute mapping to the Visual KPI Pareto Chart |
| Start Time | String | No | Overrides the default Start Time for the Chart. This must be paired with an End Time). Can be relative (*-8h) or a fixed timestamp |
| End Time | String | No | Overrides the default End Time for the Chart. This must be paired with a Start Time). Can be relative (*) or a fixed timestamp |
| Timestamp | String | No | Overrides the default Chart Time for the Chart. Can be relative (*) or a fixed timestamp |
Showing 1 to 4 of 4 entries
Pie Chart
| Attribute Name | Attribute Type | Required | Notes |
|---|---|---|---|
| AF Object ID | String | Yes | ID of AF Attribute mapping to the Visual KPI Pie Chart |
| Start Time | String | No | Overrides the default Start Time for the Chart. This must be paired with an End Time). Can be relative (*-8h) or a fixed timestamp |
| End Time | String | No | Overrides the default End Time for the Chart. This must be paired with a Start Time). Can be relative (*) or a fixed timestamp |
| Timestamp | String | No | Overrides the default Chart Time for the Chart. Can be relative (*) or a fixed timestamp |
Showing 1 to 4 of 4 entries
Trend
| Attribute Name | Attribute Type | Required | Notes |
|---|---|---|---|
| AF Object ID | String | Yes | ID of AF Attribute mapping to the Visual KPI Trend |
| Start Time | String | No | Overrides the default Start Time for the Trend. This must be paired with an End Time). Can be relative (*-8h) or a fixed timestamp |
| End Time | String | No | Overrides the default End Time for the Trend. This must be paired with a Start Time). Can be relative (*) or a fixed timestamp |
Showing 1 to 3 of 3 entries
XY Plot
| Attribute Name | Attribute Type | Required | Notes |
|---|---|---|---|
| AF Object ID | String | Yes | ID of AF Attribute mapping to the Visual KPI XY Plot |
| Start Time | String | No | Overrides the default Start Time for the Chart. This must be paired with an End Time). Can be relative (*-8h) or a fixed timestamp |
| End Time | String | No | Overrides the default End Time for the Chart. This must be paired with a Start Time). Can be relative (*) or a fixed timestamp |
Showing 1 to 3 of 3 entries
Table Bookmarks
Table List
| Attribute Name | Attribute Type | Required | Notes |
|---|---|---|---|
| AF Object ID | String | Yes | ID of AF Element mapping to the Visual KPI Group |
| Expand | Boolean | No | A setting of false (default) will only list child Tables of the Group while a setting of true will list all descendant Tables. |
| Group By | String | No | This can be used to override the default grouping. Standard Attributes (None, Group) and Custom Attributes (e.g. Unit, Region, etc) can be used. |
Showing 1 to 3 of 3 entries
Table Geo
| Attribute Name | Attribute Type | Required | Notes |
|---|---|---|---|
| AF Object ID | String | Yes | ID of AF Element mapping to the Visual KPI Group |
| Expand | Boolean | No | A setting of false (default) will only list child Tables of the Group while a setting of true will list all descendant Tables. |
Showing 1 to 2 of 2 entries
Table
| Attribute Name | Attribute Type | Required | Notes |
|---|---|---|---|
| AF Object ID | String | Yes | ID of AF Attribute mapping to the Visual KPI Table |
| Start Time | String | No | Overrides the default Start Time for the Table. This must be paired with an End Time). Can be relative (*-8h) or a fixed timestamp |
| End Time | String | No | Overrides the default End Time for the Table. This must be paired with a Start Time). Can be relative (*) or a fixed timestamp |
| Timestamp | String | No | Overrides the default Chart Time for the Table. Can be relative (*) or a fixed timestamp |
Showing 1 to 4 of 4 entries
Link Bookmarks
Generic Link
| Attribute Name | Attribute Type | Required | Notes |
|---|---|---|---|
| Bookmark URL | String | Yes | URL of the link. This is meant for external links. For internal Visual KPI links use the System Link bookmark. |
Showing 1 to 1 of 1 entries
Dashboard
| Attribute Name | Attribute Type | Required | Notes |
|---|---|---|---|
| AF Object ID | String | Yes | ID of AF Attribute mapping to the Visual KPI Dashboard |
Showing 1 to 1 of 1 entries
System Link
| Attribute Name | Attribute Type | Required | Notes |
|---|---|---|---|
| Bookmark URL | String | No | Partial system link (query string). This partial url is everything but the base URL and be be found by browsing the Visual KPI site and copying the query string. (e.g., ?pid=10&gid=43cf45a9-61a7-11ec-897e-ccd0c6467bcf&gid0=62d7a593-61a6-11ec-897e-ccd0c6467bcf) |
Showing 1 to 1 of 1 entries