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, set whether the widget should be visible or hidden. You can also define for which specific roles the widget will be shown or not. This setting allows you to customize dashboards for specific user groups that have a certain role.

   Visible: The widget is visible for all (default)
   Visible for roles: The widget is visible if any of the selected roles matches one of the user's project role
   Hidden: The widget is hidden for all
   Hidden for roles: The widget is hidden if any of the selected roles matches one of the user's project role

   The filter widget can be easily edited on the dashboard through the Edit Filters option in the dashboard actions menu. This is especially convenient when the widget is Hidden or Hidden for roles. Refer to Editing a widget.

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. The placeholder source is filterParams (if a filter widget exists on the dashboard, e.g. ${filterParams.paramName}).

   The title will not be displayed if the widget is Sticky, as described in Display mode in the General Settings below.

General Settings

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

1. In the Display mode drop-down list, define how the widget will behave on the dashboard:
   

   • Sticky (default): the filter widget will be attached to the top of the dashboard and will always stay there even when you scroll
     

     The Sticky display mode will hide the widget's Title, as well as the Last update property.

     

   • Draggable: the filter widget will be displayed on the dashboard just like a normal widget

2. In the Store Values in User Settings drop-down list, define whether the filter settings shall be stored:
   

   • Yes: The local filter settings are stored until the next session.

   • Yes, reset storage (default): The local filter settings are reset once the web browser is closed.

   • Disable: The local filter settings are not stored for next.

3. In the Share button available drop-down list, define whether you want to display a Share filter url icon in the widget's header bar.

   • No: This is the default option. Despite the lack of a dedicated button, users can still share the widget/dashboard by copying the dashboard url.

   • Yes: When you select this option, you will make the widget's, and respectively the dashboard's, sharing easier for other project members, however, you need to consider your project's data privacy regulations.
     → For details about this option, refer to General widgets > Additional functions of filter widgets.

Data Sources

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

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

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

   • New data source:
     

     • Query Template

     • Single Device

     • Multiple Devices

     • Device Count

     • Devices from Filter Selection

     • Playback: All Frames

     • Playback: Current Frame

     • External Data Source

   • Existing data source:

     • The list in this group displays all shared data sources from other widgets on the dashboard

Query Template

1. Click the edit icon next to the data source label to define a unique label within the dashboard, if needed.
   

2. 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 widget you created for this dashboard, click the Available references icon  and select the Filter.

   If you have a time parameter, you can choose between absolute time, relative time, and a preset by clicking the time icon .

   There is a Target collection parameter, if the selected query template allows multiple target collections. Select one of the allowed collections from the drop-down list, or select a dynamic reference using the Available references icon .

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

4. Click the Source data preview icon to open a preview.

5. Click the Save Data Source button.

Single Device

1. Click the edit icon next to the data source label to define a unique label within the dashboard, if needed.

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

   To connect the widget with the Filter widget you created for this dashboard, click the Available references icon  and select the Filter.

3. Click the Source data preview icon to open a preview.

4. Click the Update Source button.

Multiple Devices

1. Click the edit icon next to the data source label to define a unique label within the dashboard, if needed.

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

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

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

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

   The maximum is 200 devices.

6. In the Fields field, enter the fields whose information shall be retrieved from Device Management.

7. In the Sort field, enter a field configured in Device Management according to which the data shall be sorted.

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

9. In the Filter field, add a filter to narrow down the search results. Placeholders are also supported.

10. Click the Source data preview icon to open a preview.

11. Click the Update Source button.

Device Count

1. Click the edit icon next to the data source label to define a unique label within the dashboard, if needed.

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

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

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

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

   To connect the widget with the Filter widget you created for this dashboard, click the Available references icon  and select the Filter.

6. Click the Source data preview icon to open a preview.

7. Click the Update Source button.

Devices from Filter Selection

1. Click the edit icon next to the data source label to define a unique label within the dashboard, if needed.

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

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

4. Click the Source data preview icon to open a preview.

5. Click the Update Source button.

Playback: All Frames

1. Click the edit icon next to the data source label to define a unique label within the dashboard, if needed.

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

Playback: Current Frame

1. Click the edit icon next to the data source label to define a unique label within the dashboard, if needed.

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

External Data Source

1. Click the edit icon next to the data source label to define a unique label within the dashboard, if needed.

2. Select an HTTP method.

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

4. In the Type drop-down list, select the type of authorization.

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

6. 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 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 widget is not required. A positive number is also allowed if relevant.

      • prefix: Allows to dynamically add parameters to a value, by means of a prefix, e.g. ${parameter2 | prefix: '&qp1='}. This modifier can also be used as part of an external data source. Undefined parameters will not resolve as "undefined" but will be omitted.

      • suffix: Allows to dynamically add parameters to a value, by means of a suffix, e.g. ${parameter2 | suffix: '&_qp1'}. This modifier can also be used as part of an external data source. Undefined parameters will not resolve as "undefined" but will be omitted.

      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

      prefix:

      ${filterParams.multi | prefix: 'pre='} will result in pre=v1,pre=v2

      suffix:

      ${filterParams.multi | suffix: '_suffix'} will result in v1_suffix,v2_suffix

      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 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 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 widget is not required. A positive number is also allowed if relevant.

      • prefix: Allows to dynamically add parameters to a value, by means of a prefix, e.g. ${parameter2 | prefix: '&qp1='}. This modifier can also be used as part of an external data source. Undefined parameters will not resolve as "undefined" but will be omitted.

      • suffix: Allows to dynamically add parameters to a value, by means of a suffix, e.g. ${parameter2 | suffix: '&_qp1'}. This modifier can also be used as part of an external data source. Undefined parameters will not resolve as "undefined" but will be omitted.

      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

      prefix:

      ${filterParams.multi | prefix: 'pre='} will result in pre=v1,pre=v2

      suffix:

      ${filterParams.multi | suffix: '_suffix'} will result in v1_suffix,v2_suffix

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

8. 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 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 widget is not required. A positive number is also allowed if relevant.

      • prefix: Allows to dynamically add parameters to a value, by means of a prefix, e.g. ${parameter2 | prefix: '&qp1='}. This modifier can also be used as part of an external data source. Undefined parameters will not resolve as "undefined" but will be omitted.

      • suffix: Allows to dynamically add parameters to a value, by means of a suffix, e.g. ${parameter2 | suffix: '&_qp1'}. This modifier can also be used as part of an external data source. Undefined parameters will not resolve as "undefined" but will be omitted.

      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

      prefix:

      ${filterParams.multi | prefix: 'pre='} will result in pre=v1,pre=v2

      suffix:

      ${filterParams.multi | suffix: '_suffix'} will result in v1_suffix,v2_suffix

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

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

10. Click the Source data preview icon to open a preview.

11. Click the Save Data Source button.

Filter Types

Open the Filter Types pane to configure general and device filters.

1. Click the Add Global Filter drop-down list and select a global filter that was added in another dashboard.

2. Activate the Device Filters switch to configure a filter for the properties of a device type.

   For information on how to configure information blocks and properties of device types, refer to Managing information blocks.

   This device filter can be used as data source for multiple widgets. Select the Devices from Filter Selection option from the Add source drop-down list.

   1. 1. In the Type drop-down field, select a device type.

      2. In the Search Properties field, enter or select the desired properties.
         → Each property is added below and can be further configured.

      3. In the Display Name field, change the name that will be displayed.

      4. Activate the Allow multiple filter values checkbox to provide a multi-selection for the filter.
         → You will be able to choose several filtering criteria from a pick list. If you do not activate Allow multiple filter values checkbox, you will be able to select the criteria from a dropdown menu.

      5. Activate the Mark as required checkbox to have the user fill out this filter parameter.

      6. Activate the Default Value checkbox or enter a default value in the field.

      7. Open the Advanced Settings pane to further configure the filter parameter.

         1. Activate the Hide filter parameter in dashboard checkbox to hide the filter option in the widget.

         2. In the Technical Name field, enter a technical name.

3. Activate the General Filters switch.

   1. Click the Add filter drop-down list and select a filter parameter.
      → The filter parameter is added and can be configured as described in the Filter <selected filter option> sections.

      To remove a parameter, click the Remove Parameter button at the bottom of the corresponding filter parameter.

Text parameter

1. In the Display Name field, enter a name that will be displayed.

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

3. Activate the Allow multiple filter values checkbox to provide a multi-selection for the filter.
   → You will be able to enter multiple text values.

4. Activate the Mark as required checkbox to have the user enter text in the search box.

5. Activate the Mark as Global Filter checkbox to make this filter parameter globally available for other dashboards.

6. In the Text Default Value field, enter any text that gives the user an idea of what to search for.

7. Open the Advanced Settings pane to further configure the filter parameter.

   1. Activate the Hide filter parameter in dashboard checkbox to hide the filter option in the widget.

   2. In the Technical Name field, enter a technical name.

Number parameter

1. In the Display Name field, enter a name that will be displayed.

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

3. Activate the Mark as required checkbox to have the user enter text in the search box.

4. Activate the Mark as Global Filter checkbox to make this filter parameter globally available for other dashboards.

5. Open the Advanced Settings pane to further configure the filter parameter.

   1. Activate the Hide filter parameter in dashboard checkbox to hide the filter option in the widget.

   2. In the Technical Name field, enter a technical name.

Date Time Range parameter

1. In the Display Name field, enter a name that will be displayed.

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

3. Activate the Allow multiple filter values checkbox to provide a multi-selection for the filter.
   → You will be able to choose several date time ranges.

4. Activate the Mark as required checkbox to have the user select the time.

5. Activate the Mark as Global Filter checkbox to make this filter parameter globally available for other dashboards.

6. Activate the Enable Time Selection checkbox to also filter the time.

7. Activate the Allow Relative Time checkbox to define a duration of time relative to the current time.

8. Click the Default Value field to define the range.
   

   • Absolute: Select the exact date (and time).

   • Relative: Select the duration of the time relative to the current time.

   • Presets: Select a preconfigured time filter.

9. Open the Advanced Settings pane to further configure the filter parameter.

   1. Activate the Hide filter parameter in dashboard checkbox to hide the filter option in the widget.

   2. In the Technical Name field, enter a technical name.

Checkbox parameter

1. In the Display Name field, enter a name that will be displayed.

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

3. Activate the Mark as required checkbox to have the user activate the checkbox.

4. Activate the Mark as Global Filter checkbox to make this filter parameter globally available for other dashboards.

5. Activate the Default Value checkbox to set this checkbox as default.

6. Open the Advanced Settings pane to further configure the filter parameter.

   1. Activate the Hide filter parameter in dashboard checkbox to hide the filter option in the widget.

   2. In the Technical Name field, enter a technical name.

Selection parameter

1. In the Display Name field, enter a name that will be displayed.

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

3. Activate the Allow multiple filter values checkbox to provide a multi-selection for the filter.
   → You will be able to choose several filtering criteria from a pick list. If you do not activate Allow multiple filter values checkbox, you will be able to select the criteria from a dropdown menu.

4. Activate the Mark as required checkbox to have the user select something.

5. Activate the Mark as Global Filter checkbox to make this filter parameter globally available for other dashboards.

6. In the Label - Value table, add a label and a value that will be displayed in the widget.

7. Click the Add row button to add another row to the selection. Repeat this step until you have all desired values.

8. In the Default Value drop-down list, select one of the added values to be the default value.

9. Open the Advanced Settings pane to further configure the filter parameter.

   1. Activate the Hide filter parameter in dashboard checkbox to hide the filter option in the widget.

   2. In the Technical Name field, enter a technical name.

Device parameter

1. In the Display Name field, enter a name that will be displayed.

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

3. Activate the Allow multiple filter values checkbox to provide a multi-selection for the filter.
   → You will be able to choose several filtering criteria from a pick list. If you do not activate Allow multiple filter values checkbox, you will be able to select the criteria from a dropdown menu.

4. Activate the Mark as required checkbox to have the user enter text in the search box.

5. Activate the Mark as Global Filter checkbox to make this filter parameter globally available for other dashboards.

6. In the Value Path field, enter the path to a specific device property from your connected Bosch IoT Things service instance.

7. In the Device types to be visible drop-down list, select the device types that will be displayed in the widget.

8. In the Filter filed, add a filter to narrow down the search results. Placeholders are also supported for referencing dynamic data from another filter, or Insights context, etc.

9. Open the Advanced Settings pane to further configure the filter parameter.

   1. Activate the Hide filter parameter in dashboard checkbox to hide the filter option in the widget.

   2. In the Technical Name field, enter a technical name.

Query Condition parameter

1. In the Display Name field, enter a name that will be displayed.

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

3. Activate the Mark as required checkbox to have the user enter text in the search box.

4. Activate the Mark as Global Filter checkbox to make this filter parameter globally available for other dashboards.

5. In the Path field, enter a path that you want to search.

6. Select an operator.

7. In the Data Type drop-down list, select a data type which matches your data type of the path.

   • String: a simple text value

   • Number: an integer value

   • Object ID: an ID of an object stored in the database

   • Date: a date value

   • Date Range: a from-to value range

8. In the Value field, enter any value you want to search for.

9. Click the Add Condition button to add another condition.

10. Open the Advanced Settings pane to further configure the filter parameter.

    1. Activate the Hide filter parameter in dashboard checkbox to hide the filter option in the widget.

    2. In the Technical Name field, enter a technical name.