Bosch IoT Insights

Creating a query template

Query templates can be created in the Template Designer to query the data in the Data Explorer. A query template mainly consists of a MongoDB query and input parameters.

Also consult the official MongoDB documentation, e.g.:

Note that the above links to the MongoDB documentation point to the latest MongoDB version. Bosch IoT Insights always uses the version prior to the latest version.

Example MongoDB query templates are located in the Query templates chapter.

Prerequisites

  • You are assigned to the Admin role or have dedicated rights to create new query templates.

  • MongoDB queries must comply with the MongoDB extended JSON format, refer to the MongoDB extended JSON chapter.

Proceed as follows

  1. Click the Add Query Template button.
    → The Template Designer is displayed.

    images/confluence/download/attachments/1096710254/explore_data_explorer_template_designer_2021_03_12.png
  2. Click the Access rights button to define the access rights of the query template.

    For more information on how to set access rights, refer to the Managing query template access rights chapter.

  3. In the Basic Details pane, provide general information on the query template.

    1. In the Name field, enter a name for the query template.

    2. In the Collection drop-down list, select a collection that shall be queried.

    3. In the Description field, add a description for the query template.

  4. In the Parameters pane, optionally add parameters to receive data for a specific value with the query template.

    1. Click the Add parameter button.
      → The Edit Parameter dialog is displayed.

      images/confluence/download/attachments/1096710254/explore_data_explorer_add_parameters_2020_10_27.png
    2. In the Technical Name field, enter the technical name of the parameter.

    3. In the Data type drop-down list, select the data type of the parameter.

      • STRING: a simple text value

      • TIMESTAMP: an ISO 8601 string, for example 2017-07-08T12:00:00.000Z (in absolute time or relative time)

      • BOOLEAN: adds a checkbox with the technical name of the parameter that can be activated or deactivated

      • INT: an integer value

      • FLOAT: a floating point value

      • DEVICE: an already configured device

    4. In the Parameter Type drop-down list, select a parameter type.

      • SCALAR: a single parameter value

      • RANGE: a from-to value range

      • LIST: a series of parameter values

      • MAP: a key-value mapping while the key is always a string and the value is of the given data type

    5. Activate the Optional checkbox to define the parameter as optional.

    6. Activate the Nullable checkbox to search for null values.

    7. In the Display Name field, enter a name that shall be displayed in the parameter table instead of the technical name.

    8. In the Description box, enter a description for the parameter.

    9. Activate the Define Default Value checkbox to set a default value.

      The default value settings depend on the data type and parameter type you selected in step c and d.

      • SCALAR: Enter or select the value.

      • RANGE: Enter a Start Value and an End Value.

      • LIST: Enter an Entry 0. Click the Add New Entry button to add more entries.

      • MAP: Add a key-value pair to create a mapping. Click the Add New Key-Value Pair button to add more key-value pairs.

    10. Activate the Define Validation Pattern checkbox to define a regular expression that validates the parameter.

    11. If you selected SCALAR as parameter type, activate the Provide Choices checkbox to add more values.

    12. Click the Add choice button to add a label and the value.

    13. Click the Save button to save the parameter.

  5. In the Custom Endpoint pane, activate the Enable custom endpoint switch to execute the query template by calling the customized URL.

    For more information on how to configure a custom endpoint, refer to the Configuring a custom endpoint and Data Explorer: Configuring a custom endpoint chapters.

  6. In the Template Definition pane, enter the query.

  7. In the Advanced Settings pane, define an index.

    1. In the Run Settings > Index drop-down list, select an index.

      • Automatic Index Detection: indices stored in MongoDB are automatically selected

      • Collection Scan Ascending: the collection is scanned from top to bottom

      • Collection Scan Descending: the collection is scanned from bottom to top

  8. Click the Create New Query Template button.
    → The query template has been created.