Dashboard settings

Each dashboard is made up of a number of cards and other features that you can customize.

You can create or edit a dashboard through the dashboard editor. For advanced configuration of dashboards, you can define the content to display on a dashboard and how to display it in a .json configuration file. Import a .json file to create a new dashboard or update an existing one. Export the .json file to share the dashboard configuration with others.

For an example of the .json definition, see Dashboard schema.

To monitor your data items, you must add them to a dashboard. The graphs on the Data tab only indicate whether recent data is available.
You can add any data item of a device type to a dashboard.
To see the raw or input value of a data item, do not apply an aggregator in the dataSource array of the dashboard .json file. The summary dashboard builder forces you to specify an aggregator. You can remove the aggregator from the JSON configuration.

Time range

You can set the time range of the whole dashboard and individual cards. You can select from predefined ranges or you can create a custom range.

For relative range, you can set the range relative to a specific time and day. For absolute range, you set the start and end dates.

Tip: The date range that you select might impact the time grain that you specify. If you choose to apply a daily grain to your card but you change the time range to monthly using the range picker, to limit the number of data points shown, the dashboard changes the time grain to monthly.

Icons

On value and image cards, you can specify which icons to use for thresholds from the UI. If you are using the .json configuration to configure the card, choose icons from the UI icons library in the Carbon Design System. For example, you might choose to use some of the status icons, which include:

Information icons ( Information, Information filled)
Check mark icons ( Checkmark, Checkmark filled, Checkmark outline)
Warning icons ( Warning, Warning filled)
Error icons ( Error, Error filled, Error outine)

A subset of the icons from the library are supported.


            Help24,
            Checkmark24,
            CheckmarkFilled24,
            CheckmarkOutline24,
            Error24,
            ErrorFilled24,
            ErrorOutline24,
            HelpFilled24,
            Information24,
            InformationFilled24,
            Misuse24,
            MisuseOutline24,
            Undefined24,
            UndefinedFilled24,
            Unknown24,
            UnknownFilled24,
            Warning24,
            WarningAlt24,
            WarningAltFilled24,
            WarningAltInverted24,
            WarningAltInvertedFilled24,
            WarningFilled24,
            WarningSquare24,
            WarningSquareFilled24,
            User24,
            Location24,
            Temperature24,
            Flag24,
            Tag24,
            Alarm24,
            Idea24,
            BatteryFull24,
            BatteryEmpty24,
            FlashFilled24,
            UserFilled24,
            LightFilled24,
            IbmSecurity24
            Idea24,
            BatteryFull24,
            BatteryEmpty24,
            FlashFilled24,
            UserFilled24,
            LightFilled24,
            IbmSecurity24

On image cards, you can also specify which icons to use for hotspots through the UI. In the card configuration, you can choose an icon from the subset of supported icons.

Note: In the .json configuration, to specify an icon, enter the icon name. For example, to use the Warning filled icon, enter: "icon": "Warning filled". For backward compatibility, you can continue to specify the Carbon ID for the icon instead of the icon name. For example,: "icon": "icon--warning".

Variables in attribute values

For all card types, you can use variables in attributes values in the .json configuration of device dashboards. Specify the variable by using the format {dataSourceId}. You can reference any data item that is available for a device type. A corresponding dataSourceId must be configured for the data item in the cards.dataSource.attributes section of the .json configuration. Data must be available for the data item within the time range of the card.

Examples:

A table card key and value pair "title": "Mean flow rate - firmware {firmware_ID}" uses the dimension firmware as a variable. On the dashboard, the title is displayed as Mean flow rate - firmware 2.1.
A threshold configuration on a value card uses a metric ' monthly_avg_temp' as a variable in the value attribute. The value card is configured to display a warning icon on temperature when the temperature value exceeds the monthly average temperature.


            "content": {
                        "attributes": [
                            {
                                "dataSourceId": "temperature_ID",
                                "precision": 3,
                                "label": "Temperature",
                                "thresholds": [
                                    {
                                        "color": "#ffa500",
                                        "comparison": ">",
                                        "icon": "Warning filled",
                                        "value": "{monthly_avg_temp}"
                                    }
                                ]
                            }
                        ]
                    }

Restrictions: The following restrictions apply to summary dashboards:

Do not use variables in card titles.
Do not use variables in line graph cards and alert cards.
On value cards, you must specify dataFilter in cards.content.attributes.dataFilter and groupBy in card.dataSource.Attributes for variables to work.
On image cards and table cards, you must specify groupBy in card.dataSource.Attributes for variables to work.