Bosch IoT Insights

Filter widget

Using the Filter widget, you can configure a search option using the given values.

Use cases:

  • You want to search for any value within the view. The Text filter with a free text search option can be configured.

  • You know that some of your users are not that experienced. The Selection filter offering suggestions can be configured.

  • You want to search for specific devices. The Device filter parameter type can be configured.

  • You want to have a list of devices returned that match specific criteria. The Device filter type can be configured.

  • You want to share your filter with other users of the same project. The different sharing options can be used.

This is only a basic filter definition. A filter must be connected to parameters from a template or to templates for collecting the data.

Only one Filter widget can be created per dashboard.

Global filters can be defined and shared across multiple dashboards. That way, you can view data in the same context for individual or multiple devices. An element can be selected in a global filter of one dashboard and the information related to that filter can be also seen in a different dashboard. A filter parameter that is defined as a global filter is highlighted in blue and the globe icon images/confluence/download/thumbnails/1083888350/icon_global_filter-version-1-modificationdate-1703176616000-api-v2.png is added to it.

The following filter configurations are provided:

  • Text
    Provides a text field for arbitrary text

  • Number
    Provides fields for adding minimum and maximum values

  • Date Time Range
    Provides a date/date time picker

  • Checkbox
    Provides a checkbox

  • Selection
    Provides a drop-down list of configurable items

  • Device
    Provides a drop-down list of devices

  • Query Condition
    Provides conditions to filter the data

Example

images/confluence/download/attachments/1083888350/filters_example-version-1-modificationdate-1740471301000-api-v2.png

Proceed as follows

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

    images/confluence/download/attachments/1083888350/filter-widget-configurator-version-1-modificationdate-1738601286000-api-v2.png

  2. Configure the settings as described below.

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

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.

      images/confluence/download/attachments/1083888350/filter_widget_title-version-1-modificationdate-1738601286000-api-v2.png

    • 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 images/confluence/download/thumbnails/1083888350/link-version-1-modificationdate-1740471301000-api-v2.png 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.

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

The configured date time range parameter can be combined with the Playback widget.

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.

Sharing the filter widget

Refer to General widgets > Additional functions of filter widgets.