Bosch IoT Insights

Friction Map widget

Using the Friction Map widget, colored squares can be displayed on a map. The color of the squares is determined by the additional friction signal.

Example

images/confluence/download/attachments/1141611578/widget_map_friction_map_2020_08_25-version-1-modificationdate-1604330157000-api-v2.png

Proceed as follows

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

    images/confluence/download/attachments/1141611578/widget_friction_map_configuration_2021_06_01-version-71-modificationdate-1708535968000-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

  • Latitude

  • Longitude

  • Friction data path

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.

      • 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"]

      }

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

      • 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"]

      }

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

      • 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"]

      }

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

Map Traces

Open the Map Traces pane to select one or multiple additional map traces that can be added to the map.

The following map traces can be added:

  1. Click the button of any map trace.

    A maximum of five map traces can be added to the map.

    → The map trace is added and can be configured as described in the corresponding chapters.

To remove a map trace, click the Remove Trace button at the bottom of the corresponding map trace configuration.

Map Options

Open the Map Options pane to to configure the layout of the map.

  1. In the Map Height field, enter a value for the height of the location map.

    The default value is 400.

  2. In the Map Style drop-down list, select the mode for the map view.

  3. Activate the Limit Initial Zoom to checkbox to set an initial zoom level of the map.

  4. In the Level field, enter the value of the initial zoom level.

Trace: Friction Map

  1. In the Latitude drop-down list, filter for or enter the coordinate for the latitude of the location.

  2. In the Longitude drop-down list, filter for or enter the coordinate for the longitude of the location.

  3. In the Friction data path drop-down list, select a data path.

  4. In the Section Length (m) field, enter a value to define the size of a square.

  5. Click the Advanced Settings drop-down menu to further configure the friction map.

    Optionally, activate the Absolute mode checkbox to define dynamic color ranges, refer to Absolute Mode.

    1. Click the color square to select another Color for Min. Value or enter a color code.

    2. In the Minimum Value field, enter a value for the minimum value.

    3. Click the color square to select another Color for Max. Value or enter a color code.

    4. In the Maximum Value field, enter a value for the maximum value.

    5. In the Range value label field, enter a name for the range.

  6. Click the Tooltip settings drop-down menu to configure tooltips. Tooltips are displayed in the order they were added in the table.

    1. Click the Add Tooltip Row button.
      → A new tooltip row is added.

    2. In the Type drop-down list, select a type for the tooltip.

      • If you selected JSON Property:

        1. Add a Label.

        2. Add a Value.

      • If you selected Hyperlink:

        1. In the URL field, enter a URL or a file link.

          As opening a file link is considered a potential security risk, it is restricted by modern web clients.

          Therefore, in order to open this link from the widget later on, you can copy it from the dialog which appears when the link is clicked, and then paste it into your file explorer.

          Make sure that the link is trustable and correct before using it.

        2. In the Hyperlink Display Text field, enter the text that shall be displayed for the hyperlink.

        3. In the Action drop-down list, select whether the hyperlink shall be opened in the same tab, opened in a new tab, or copied to clipboard.

      • If you selected Text:

        1. Add Text.

          To add another tooltip, click the Add Tooltip Row button.

          To reorder the columns, drag and drop the column using the Move icon images/confluence/download/thumbnails/1141611578/icon_move-version-1-modificationdate-1679390532000-api-v2.png .

          To remove a tooltip, click the Delete button.

Absolute Mode

  1. Click the color square to select another Default color or enter a color code.

  2. Click the Add color range button to add a color range.
    → A new line to define the color range has been added.

    1. Click the color square to select another color or enter a color code.

    2. In the From field, enter a value that acts as the starting point of the color range.

    3. In the To field, enter a value that acts as the endpoint of the color range.

    4. Click the Add icon images/confluence/download/thumbnails/1141611578/icon_add-version-1-modificationdate-1604330157000-api-v2.png to add another line.

    5. Repeat the steps a to c.

      To remove a color range, click the Remove icon images/confluence/download/thumbnails/1141611578/icon_remove-version-1-modificationdate-1604330156000-api-v2.png .

    6. In the Range Value Label field, enter a name for the range.

Trace: GPX Layer

The GPX layer is an additional representation of tours or 3D objects that can be added to your map. For example, a tour on roads that are not visible on public maps can be plotted.

  1. In the GPX file drop-down list, select a GPX file.

    The GPX extension must have been configured under Admin > Project > Map Extension, refer to Map Extensions.

  2. Click the color square to select another color for the tour line or enter a color code.

  3. In the Line Width field, enter a value to define the width of the tour line.

Example:

images/confluence/download/attachments/1141611578/widget_map_gpx_layer_2020_08_25-version-1-modificationdate-1604330157000-api-v2.png