Widgets
Group Widgets
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
Group Block
| Attribute Name | Attribute Type | Required | Notes |
|---|---|---|---|
| AF Object ID | String | Yes | ID of AF Element mapping to the Visual KPI Group |
| 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 2 of 2 entries
KPI Widgets
KPI List
KPI Geo
KPI Bullet
KPI Map
Group Map
KPI Summary History
KPI Status History
KPI Notification History
KPI Block
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 Block
| Attribute Name | Attribute Type | Required | Notes |
|---|---|---|---|
| AF Object ID | String | Yes | ID of AF Attribute mapping to the Visual KPI KPI |
| Show Sparkline | Boolean | No | True to enable, False to disable |
| Show Bullet Chart | Boolean | No | True to enable, False to disable |
| Show Status History Chart | Boolean | No | True to enable, False to disable |
| Show Statistics | Boolean | No | True to enable, False to disable |
| Show Actions | Boolean | No | True to enable, False to disable |
| Show Contact | Boolean | No | True to enable, False to disable |
Showing 1 to 7 of 7 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 Widgets
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 Widgets
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 & Text Widgets
Generic Link
| Attribute Name | Attribute Type | Required | Notes |
|---|---|---|---|
| Link URL | String | Yes | URL of the link |
| Link Name | String | No | Name alias for the URL |
| Link Description | String | No | Description for the link |
| Widget Color | String | No | Hex color code for the widget (e.g., #669900) |
| Widget Icon | String | No | Icon for the widget (e.g., tf-fire22) |
Showing 1 to 5 of 5 entries
Dashboard Link
| Attribute Name | Attribute Type | Required | Notes |
|---|---|---|---|
| AF Object ID | String | Yes | ID of AF Attribute mapping to the Visual KPI Dashboard |
| Widget Color | String | No | Hex color code for the widget (e.g., #669900) |
| Widget Icon | String | No | Icon for the widget (e.g., tf-fire22) |
Showing 1 to 3 of 3 entries
Text Block
| Attribute Name | Attribute Type | Required | Notes |
|---|---|---|---|
| Label | String | No | Label for the Text Block |
| Text | String | No | Text for the Text Block |
| Text Interface | String | No | Name of the Interface to retrieve data for text (only required if text is a lookup) |
| Text Alignment | String | No | Left (default), Center, Right |
| Numeric Format | String | No | Numeric format override (e.g., ##.000) |
| Text Size | Int | No | Override (in pixels) for text size |
| Widget Color | String | No | Hex color code for the widget (e.g., #669900) |
Showing 1 to 7 of 7 entries