Bosch IoT Insights

Illustration widget

Using the Illustration widget, an image can be uploaded. Values from your data can be provided with the image.

The maximum file size of an image is 1MB.

Example

images/confluence/download/attachments/1083888363/widget_illustration_example_2020_08_25-version-1-modificationdate-1604330164000-api-v2.png

Proceed as follows

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

    images/confluence/download/attachments/1083888363/widget_illustration_configuration-version-1-modificationdate-1675333762000-api-v2.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

  • Image

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 Layout behavior drop-down list, decide how the size of the widget should be adapted in the dashboard.

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

    For a dynamic title, you can add placeholders with the ${...} notation. Possible placeholder sources are filterParams (if a filter widget exists on the dashboard, e.g. ${filterParams.paramName}) or data from the data source (if source is specified, e.g. ${[0].payload.value}), insights (user context), dashboardName or widgetId.

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.

  2. In the Lazy Loading drop-down list, select whether you want to enable or disable lazy loading.

    Lazy loading is enabled by default. That way, widgets are only loaded when they are visible on screen. This prevents slower loading of the dashboard and performance issues.

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-version-1-modificationdate-1616506558000-api-v2.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-version-1-modificationdate-1616506558000-api-v2.png .

  2. For Caching, add the Duration in seconds to load existing cache entries that match your parameters during that time frame.

    The default cache time of 30 minutes is set automatically.

  3. Click the Source data preview icon images/confluence/download/thumbnails/1083888325/icon_widget_refresh-version-1-modificationdate-1602594207000-api-v2.png to open a preview.

  4. 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-version-1-modificationdate-1616506558000-api-v2.png and select the Filter Panel.

  2. Click the Source data preview icon images/confluence/download/thumbnails/1083888325/icon_widget_refresh-version-1-modificationdate-1602594207000-api-v2.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 Filter field, add a filter to narrow down the search results. Placeholders are also supported.

  9. Click the Source data preview icon images/confluence/download/thumbnails/1083888325/icon_widget_refresh-version-1-modificationdate-1602594207000-api-v2.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-version-1-modificationdate-1616506558000-api-v2.png and select the Filter Panel.

  5. Click the Source data preview icon images/confluence/download/thumbnails/1083888325/icon_widget_refresh-version-1-modificationdate-1602594207000-api-v2.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-version-1-modificationdate-1602594207000-api-v2.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. In the Type drop-down list, select the type of authorization.

  4. Click the Set Configuration button to set up the selected authorization.

    1. For Basic Auth:

      1. In the Username field, enter the username.

      2. In the Password field, enter the password.

    2. For OAuth 2.0

      1. In the Grant Type drop-down list, select the type of credentials.

      2. Enter the Access Token URL.

      3. Enter the Client ID.

      4. Enter the Client Secret.

      5. If you selected Password Credentials as Grant Type, also enter the Username and the Password .

    3. For OAuth 2.0 (On-behalf grant type)

      1. In the Grant Type drop-down list, select Azure AD On-Behalf.

      2. Configure the scopes of your application API as described in External data source: on-behalf-of (OBO) flow.

  5. 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.

      • replace: Replace multiple occurrences of a search pattern with a specified replacement pattern.

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

      • relativeTimestamp: Calculates a relative time according to the current time. It offers a way to dynamically change the time range with the use of the Filter Panel widget, e.g. gt{$filterParams.dateTime.from | relativeTimestamp}

      • addTime:<insert number in milliseconds>: Calculates the relative time according to the given time from insights.timestamp and using the number from addTime, e.g. gt{insights.timestamp | addTime:-300000}. This modifier is designed for static usage so that a Filter Panel widget is not required. A positive number is also allowed if relevant.

      Usage examples:

      Example filter context:

      {

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

      "mixedValues": ["v1", undefined, "v2"]

      }

      join:

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

      replace:

      ${filterParams.mixedValues | replace: 'undefined','N/A'} will result in ["v1","N/A","v2"]

      queryParams:

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

      Independently from the test parameters, user-specific information and randomly generated sequences (UUID v4, alphanumeric or hex string) can be referenced.

  6. 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.

      • replace: Replace multiple occurrences of a search pattern with a specified replacement pattern.

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

      • relativeTimestamp: Calculates a relative time according to the current time. It offers a way to dynamically change the time range with the use of the Filter Panel widget, e.g. gt{$filterParams.dateTime.from | relativeTimestamp}

      • addTime:<insert number in milliseconds>: Calculates the relative time according to the given time from insights.timestamp and using the number from addTime, e.g. gt{insights.timestamp | addTime:-300000}. This modifier is designed for static usage so that a Filter Panel widget is not required. A positive number is also allowed if relevant.

      Usage examples:

      Example filter context:

      {

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

      "mixedValues": ["v1", undefined, "v2"]

      }

      join:

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

      replace:

      ${filterParams.mixedValues | replace: 'undefined','N/A'} will result in ["v1","N/A","v2"]

      queryParams:

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

      Independently from the test parameters, user-specific information and randomly generated sequences (UUID v4, alphanumeric or hex string) can be referenced.

  7. 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: Concatenates multiple values in one string separating them with the provided separator.

      • replace: Replace multiple occurrences of a search pattern with a specified replacement pattern.

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

      • relativeTimestamp: Calculates a relative time according to the current time. It offers a way to dynamically change the time range with the use of the Filter Panel widget, e.g. gt{$filterParams.dateTime.from | relativeTimestamp}

      • addTime:<insert number in milliseconds>: Calculates the relative time according to the given time from insights.timestamp and using the number from addTime, e.g. gt{insights.timestamp | addTime:-300000}. This modifier is designed for static usage so that a Filter Panel widget is not required. A positive number is also allowed if relevant.

      Usage examples:

      Example filter context:

      {

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

      "mixedValues": ["v1", undefined, "v2"]

      }

      join:

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

      replace:

      ${filterParams.mixedValues | replace: 'undefined','N/A'} will result in ["v1","N/A","v2"]

      queryParams:

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

      Independently from the test parameters, user-specific information and randomly generated sequences (UUID v4, alphanumeric or hex string) can be referenced.

  8. In the Duration in seconds field under Caching, specify the caching duration in seconds.

  9. Click the Source data preview icon images/confluence/download/thumbnails/1083888325/icon_widget_refresh-version-1-modificationdate-1602594207000-api-v2.png to open a preview.

  10. Click the Save Data Source button.

Data Transformation

With the data transformation activated, you can select entries from arrays in arrays or a specific range of arrays.

Also refer to the JMESPath documentation.

Open the Data Transformation pane to activate the data transformation to JMES.

  1. Activate the toggle switch.

  2. In the Filter field, add a string to filter the data, e.g. [0] to display only the first item or [?contains(thingId,'yourThingName')] to filter by contains in the thingId property.

  3. Click the Transformed data preview icon images/confluence/download/thumbnails/1081316247/icon_widget_refresh-version-1-modificationdate-1675069110000-api-v2.png to open a preview.
    → The data transformation is activated for the widget.

If you selected more than one data source, the Data Aggregator pane is displayed.

  1. Activate the toggle switch.

  2. In the Data Aggregator drop-down list, select an aggregation method with which each entry of the same index is merged into one result.

  3. Activate the Merge Properties checkbox to merge the properties of the index.

  4. In the Filter field, add a string to filter the data, e.g. [0] to display only the first item or [?contains(thingId,'yourThingName')] to filter by contains in the thingId property.

  5. Click the Transformed data preview icon images/confluence/download/thumbnails/1081316247/icon_widget_refresh-version-1-modificationdate-1675069110000-api-v2.png to open a preview.
    → The data transformation is activated for the widget.

Data Output Settings

Open the Data Output Settings pane to upload an image and add values.

  1. Click the Upload Image field to select an image.

    The following image formats are supported: PNG and JPG.

    → The selected image is displayed.

  2. Click the Upload Image button to upload the image.
    → The image is uploaded and displayed in the image container.

  3. Activate the Fill the missing value with the last known value checkbox to have missing values filled with the last known values until new values are available.

    When using the Manual frame back button of the Playback widget, data may be displayed incorrectly as the direction in which the time series data is iterated cannot be altered.

  4. Activate the Fit to Container checkbox to have the whole image displayed in the center of the image container. The image is refactored to fit the image container.

  5. In the Container Height field, enter a value for the height of the image container.

    The default value is 500.

  6. Click the Add Data Layer button to add an extra layer with data to the image.
    → The Layer Configuration dialog is displayed.

    1. In the Path field, select the path for the value to be displayed.

    2. In the Format Options drop-down list, select the format that fits best to the value to be added.

    3. Click the color square to select another Text Color or enter a color code.

    4. Click the color square to select another Background Color or enter a color code.

    5. In the Font Size (px) field, enter the font size for the value.

    6. In the Text field, enter a label for the value.

    7. In the Text field, click the EN drop-down list and select Add DE: German to add the German equivalent.

    8. In the Unit field, enter the unit for the value.

    9. In the Unit field, click the EN drop-down list and select Add DE: German to add the German equivalent.

    10. In the Rotation (deg) field, enter a value in degrees to rotate the data layer.

    11. Click the Save button to add the data layer to the image.
      → The data layer is added to the image and can be dragged and dropped to the desired location in the image.

  7. Click the Add Text Layer button to add an extra layer with text to the image.
    → The Layer Configuration dialog is displayed.

    1. In the Label field, enter text that will be displayed.

    2. In the Label field, click the EN drop-down list and select Add DE: German to add the German equivalent.

    3. Click the color square to select another Text Color or enter a color code.

    4. Click the color square to select another Background Color or enter a color code.

    5. In the Font Size (px) field, enter the font size for the value.

    6. In the Rotation (deg) field, enter a value in degrees to rotate the data layer.

    7. Click the Save button to add the text layer to the image.
      → The text layer is added to the image and can be dragged and dropped to the desired location in the image.

  8. Click the Preview icon images/confluence/download/thumbnails/1083888363/icon_preview-version-1-modificationdate-1604330164000-api-v2.png to view a preview with the values for the selected data layer.

  9. Click the Default icon images/confluence/download/thumbnails/1083888363/reprocess_icon-version-1-modificationdate-1604330164000-api-v2.png to set the image back to default.

  10. Click the Zoom in icon images/confluence/download/thumbnails/1083888363/icon_zoom_in-version-1-modificationdate-1604330164000-api-v2.png to zoom in.

  11. Click the Zoom out icon images/confluence/download/thumbnails/1083888363/icon_zoom_out-version-1-modificationdate-1604330164000-api-v2.png to zoom out.