Bosch IoT Insights

Pie Chart widget

Using the Pie Chart widget, data can be displayed in a pie for absolute values and percentage.

Example

images/confluence/download/attachments/1083888419/widget_pie_chart_example_2020_09_15.png

Proceed as follows

  1. Select the Pie Chart widget in the widget list.
    → The widget configuration page is displayed.

    images/confluence/download/attachments/1083888419/widget_bar_chart_configuration_2020_09_14.png
  2. Configure the settings as described below.

  3. Click the Add button.
    → The widget is added to the dashboard.

To create this widget, the following settings are mandatory to be configured:

  • Data Source

  • Values

All other settings are optional.

Dashboard Settings

Open the Dashboard Settings pane to set how the widget is displayed in the dashboard.

  1. In the Size drop-down list, decide how much space the widget should take in the form of columns.

  2. In the Visibility drop-down list, decide whether the widget should be shown or hidden in the dashboard.

  3. In the Title field, enter a title for the widget.

General Settings

Open the General Settings pane to configure some general aspects for the widget.

  1. In the Widget Refresh Interval in Seconds field, enter a value in seconds after which the widget should be refreshed.

Data Sources

Open the Data Sources pane to configure the data source for the widget.

You can select a maximum of three data sources.

  1. Click the + Add Source button to add a data source.

  2. Select any of the following options further explained underneath:

Query Template

  1. In the Query Template drop-down list, select a query template that you configured under Explore > Data Explorer, refer to Creating a query template.

    A query template is a template that has been created, parameterized, and provided for others. It is similar to an SQL View and shows data in a table view.

    To connect the widget with the Filter Panel widget you created for this dashboard, click the Available references icon images/confluence/download/thumbnails/1083888325/icon_reference.png and select the Filter Panel.

    If you have a time parameter, you can choose between absolute time, relative time, and a preset by clicking the time icon images/confluence/download/thumbnails/1083888325/icon_absolute_relative_time.png .

  2. Click the Source data preview icon images/confluence/download/thumbnails/1083888325/icon_widget_refresh.png to open a preview.

  3. Click the Save Data Source button.

Single Device

  1. In the Default Device ID drop-down list, select a Device ID.

    To connect the widget with the Filter Panel widget you created for this dashboard, click the Available references icon images/confluence/download/thumbnails/1083888325/icon_reference.png and select the Filter Panel.

  2. Click the Source data preview icon images/confluence/download/thumbnails/1083888325/icon_widget_refresh.png to open a preview.

  3. Click the Update Source button.

Multiple Devices

  1. In the Select Device Types drop-down list, select a device type.

  2. Click the Advanced Settings button to narrow down the output.

  3. In the Start field, enter a value to specify the device to start with.

    Example: If you select 3, the first two devices are skipped.

  4. In the Limit field, enter a value to specify the last device.

    The maximum is 200 devices.

  5. In the Fields field, enter the fields whose information shall be retrieved from Bosch IoT Things.

  6. In the Sort field, enter a field configured in Bosch IoT Things according to which the data shall be sorted.

  7. In the Namespaces field, add namespaces separated by a comma.

  8. In the DefaultFilter field, add a filter to narrow down the search results.

    To connect the widget with the Filter Panel widget you created for this dashboard, click the Available references icon images/confluence/download/thumbnails/1083888325/icon_reference.png and select the Filter Panel.

  9. Click the Source data preview icon images/confluence/download/thumbnails/1083888325/icon_widget_refresh.png to open a preview.

  10. Click the Update Source button.

Device Count

The Device Count data source is based on the counting functionality in Bosch IoT Things and is used to count things.

  1. In the Select Device Type drop-down list, select the device types/devices to be used as data source.

    • All Devices: Counts all devices regardless of the fact that they have a device type or not

    • All Device Types: Counts the devices that have the thing attribute type which means that the device belongs to a device type

    • Without Device Type: Counts the devices without the thing attribute type

    • Device Type xy: Counts the devices of the selected device types

  2. Click the Advanced Settings button to narrow down the output.

  3. In the Namespaces field, add namespaces separated by a comma.

  4. In the DefaultFilter field, add a filter to narrow down the search results.

    To connect the widget with the Filter Panel widget you created for this dashboard, click the Available references icon images/confluence/download/thumbnails/1083888325/icon_reference.png and select the Filter Panel.

  5. Click the Source data preview icon images/confluence/download/thumbnails/1083888325/icon_widget_refresh.png to open a preview.

  6. Click the Update Source button.

Devices from Filter Selection

Devices will be loaded that match the Device filter type configured in the Filter Panel widget.

  1. In the Pagination Limit field, enter a limit of devices that shall be displayed per page.

  2. In the Sort field, enter a property according to which the devices shall be sorted.

  3. Click the Source data preview icon images/confluence/download/thumbnails/1083888325/icon_widget_refresh.png to open a preview.

  4. Click the Update Source button.

Playback: All Frames

The Playback widget must have been configured for your dashboard.

  1. Select Playback: All Frames to display all data that has been recorded.

Playback: Current Frame

The Playback widget must have been configured for your dashboard.

  1. Select Playback: Current Frame to display the data that is just being recorded.

External Data Source

Using the external data source, an external endpoint can be specified to reference data.

  1. Select an HTTP method.

  2. In the Request URL field, enter the URL of the request.

  3. If you selected the GET HTTP method:

    1. In the Headers pane, enter a key and a value to specify the header information of the external system.

    2. Activate the Secret Header checkbox to flag the header as secret.

      When editing the data source, the header information has to be provided.

    3. In the Test Parameters pane, enter a filter parameter to test it.

      This pane can be used if a filter widget is configured for the dashboard. The filter values can be referenced as described in this pane within the URL and Headers.

      Modifiers can be used to manipulate referenced filter values. The following modifiers are available:

      • noencode: Only used in URLs. The value is not encoded as it is done by default.

      • join: Concatenates multiple values in one string separating them with the provided separator.

      • queryParams: Creates an entry with the provided parameterName for each value.

      Usage examples:

      Example filter context:

      {

      "multi": ["v1", "v2"]

      }

      join:

      ${filterParams.multi | join: ','} will result in v1,v2

      queryParams:

      ${filterParams.multi | queryParams: 'multiParam'} will result in multiParam=v1&multiParam=v2

      Independently from the test parameters, user-specific information can be referenced.

  4. If you selected the PUT HTTP method:

    1. In the Body pane, select the type of data in the Type drop-down list.

    2. Activate the Secret Header checkbox to flag the header as secret.

      When editing the data source, the header information has to be provided.

    3. In the Test Parameters pane, enter a filter parameter to test it.

      This pane can be used if a filter widget is configured for the dashboard. The filter values can be referenced as described in this pane within the URL, Headers and the Body.

      Modifiers can be used to manipulate referenced filter values. The following modifiers are available:

      • noencode: Only used in URLs. The value is not encoded as it is done by default.

      • join: Concatenates multiple values in one string separating them with the provided separator.

      • queryParams: Creates an entry with the provided parameterName for each value.

      Usage examples:

      Example filter context:

      {

      "multi": ["v1", "v2"]

      }

      join:

      ${filterParams.multi | join: ','} will result in v1,v2

      queryParams:

      ${filterParams.multi | queryParams: 'multiParam'} will result in multiParam=v1&multiParam=v2

      Independently from the test parameters, user-specific information can be referenced.

  5. If you selected the POST HTTP method:

    1. In the Body pane, select the type of data in the Type drop-down list.

    2. Activate the Secret Header checkbox to flag the header as secret.

      When editing the data source, the header information has to be provided.

    3. In the Test Parameters pane, enter a filter parameter to test it.

      This pane can be used if a filter widget is configured for the dashboard. The filter values can be referenced as described in this pane within the URL, Headers and the Body.

      Modifiers can be used to manipulate referenced filter values. The following modifiers are available:

      • noencode: Only used in URLs. The value is not encoded as it is done by default.

      • join: Concatenate multiple values in one string separating them with the provided separator.

      • queryParams: Creates an entry with the provided parameterName for each value.

      Usage examples:

      Example filter context:

      {

      "multi": ["v1", "v2"]

      }

      join:

      ${filterParams.multi | join: ','} will result in v1,v2

      queryParams:

      ${filterParams.multi | queryParams: 'multiParam'} will result in multiParam=v1&multiParam=v2

      Independently from the test parameters, user-specific information can be referenced.

  6. Click the Source data preview icon images/confluence/download/thumbnails/1083888325/icon_widget_refresh.png to open a preview.

  7. Click the Save Data Source button.

Chart Settings

Open the Chart Settings pane to define layout of the chart.

  1. In the Chart Height field, enter a value for the height of the chart.

  2. Activate the Support Playback Cursor checkbox to load the data from the Playback widget that you configured before.

  3. Click the Advanced Settings drop-down menu to further configure the chart widget.

    1. In the Chart Margin Left field, enter a value to define the margin for the left side.

    2. In the Chart Margin Right field, enter a value to define the margin for the right side.

    3. In the Chart Margin Top field, enter a value to define the margin for the top.

    4. In the Chart Margin Bottom field, enter a value to define the margin for the bottom.

    5. In the Bar Mode drop-down list, decide how multiple bars shall be displayed in one chart.

      This only applies to two or more bar chart traces in one coordinate system.

    6. In the Bar Normalization drop-down list, select a normalization type.

Trace: Pie Chart

  1. In the Labels drop-down list, select the parameter that will be displayed in the legend.

  2. In the Values drop-down list, select the parameter that will be displayed in the pie chart.

  3. In the Hole drop-down list, select a value to define the size of the pie chart hole.

  4. Click the Advanced Settings drop-down menu to further configure the pie chart.

    1. Deactivate the Show in Legend checkbox to hide the legend.

    2. In the Text Content drop-down list, decide whether absolute or relative values shall be displayed.

    3. In the Text Position drop-down list, decide where text shall be displayed in the pie chart.