Bosch IoT Insights

Configuring the Table Settings

Open the Table Settings pane of the widget's configuration editor and use the dedicated tabs, namely Options, Custom Columns, and Batch Processing, to configure the table view.

images/confluence/download/attachments/5657678363/table_settings_tabs-version-1-modificationdate-1746606783944-api-v2.png

Options

In the Options tab, which opens by default:

  1. Deactivate the Show table header checkbox to hide the table header in the widget.

    If you have created query templates, the data will be taken for the table header.

  2. Activate the Show horizontal grid lines checkbox to add grid lines after each row.

  3. Activate the Show vertical grid lines checkbox to add grid lines after each column.

  4. Deactivate the Add zebra-striping to any table row checkbox to display every row in the same color.

  5. Activate the Set fixed column width checkbox to prevent the column width from adjusting when the content changes.

  6. Activate the Show global table filter checkbox to add a search field to the table with which you can search all columns.

  7. Activate the Show column filter checkbox to filter each column using the added filter icon.

  8. In the Entries per page field, specify the number of rows that shall be displayed per page.

    The number you define will be the first entry in the Settings drop-down list above the table.

  9. In the Table height in rows field, specify the number of rows to set the height of the table.

    The number cannot be higher than the number specified in the Entries per page field.

  10. In the Footer content field, select a footer content to add the summary or average of all numerical values for a column.

    Non-numerical values will be ignored.

Custom Columns

In the Custom Columns tab, you can configure the content of each table column as a JSON property, an action button, a hyperlink, an image or rich text.

If no custom column configuration is provided, the table will display all available properties of the provided data object.

images/confluence/download/attachments/5657678363/custom_columns_tab-version-1-modificationdate-1746606783888-api-v2.png

Proceed as follows:

  1. In the Column used for sorting drop-down list, select the column for the initial sorting.

    This field is displayed only after at least one column has been added.

  2. In the Sorting order drop-down list, select the way the column selected above shall be sorted.

  3. This field is displayed only after at least one column has been added.

  4. In the Clickable row drop-down list, select one of the following options:

    1. Inactive - the table rows are not highlighted when you hover the mouse over them and are not clickable

    2. Highlight - the table rows are highlighted when you hover the mouse over them but are not clickable

    3. Hyperlink / Action - the list also displays all defined columns which contain a hyperlink or an action button

      Such columns can be made clickable, which means that when you click anywhere on a table's row, this column's action will be triggered or its hyperlink will be opened. The mouse cursor will indicate if a row is clickable.

      If other columns of the table also contain action buttons or hyperlinks, these can be clicked directly in the table. Clickable rows are highlighted by default upon mouse hover.

      If you have selected an action button column with multiple action buttons, the first defined action button in the column will be executed.

  5. Activate the Enable column selection checkbox to be able to select and unselect columns of the table and thus to show and hide them in the table, respectively.

    This field becomes active when you have added at least one column.

  6. In the Test Parameters pane, enter filter parameters to test it.

    This pane can be used if a filter widget is configured for the dashboard.

    Independently from the test parameters, user-specific information can be referenced.

Adding, rearranging, and removing a column

  1. To add a new column, click the Add Column button.

    Admin users can add up to 50 columns. Please, be aware that when adding more than 25 columns, you may experience slower rendering of the widget, depending on the total number of columns and on the number of columns with rich text content.

  2. From the button's dropdown options, select the column's type.
    You can choose between: Action Button, Hyperlink, Image, JSON Property, and Rich Text.
    images/confluence/download/thumbnails/5657678363/add_column_dropdown-version-1-modificationdate-1746606784279-api-v2.png

  3. When you have added multiple columns, use the Collapse all and respectively Expand all options to navigate more easily to the respective column configuration editor.
    images/confluence/download/attachments/5657678363/column_types_collapsed-version-1-modificationdate-1746606782765-api-v2.png

  4. To rearrange the columns, drag and drop them to the relevant position.

  5. To remove a column, expand it and click the images/confluence/download/thumbnails/5657678363/delete-version-1-modificationdate-1746606783835-api-v2.png Remove icon on the bottom.

Configuring an Action Button column type

For the Action Button column type, the configuration options are grouped into the following sections:

  • Column Configuration,

  • HTTP Method,

  • Response Trigger,

  • Disable on Condition, and

  • Styling.

    The styling section provides the same configuration options for all column types besides JSON, which has an additional option for color range definition.

Expand and collapse each section for easier navigation to the relevant configuration fields.

images/confluence/download/attachments/5657678363/action_button_column_sections-version-1-modificationdate-1746606782822-api-v2.png

The sections are explained in more details below.

Column Configuration

Expand the Column Configuration section.
→ The available configuration options are displayed.

images/confluence/download/attachments/5657678363/action_button_column_type_with_buttons_and_type-version-1-modificationdate-1746606783490-api-v2.png

Proceed as follows:

  1. In the Column Name field, enter a name for the column.

  2. Click the EN drop-down list and select Add DE: German to add the German equivalent for the label.

  3. In the Button Name field, enter text that shall be displayed on the button.

  4. If you need to define multiple action buttons in this column, click the images/confluence/download/thumbnails/5657678363/add-version-1-modificationdate-1746606783546-api-v2.png Add Action option on the right, under the language option. Then for each button, enter a unique name in the Button Name field and repeat the steps described below.

  5. In the Action Type field, define whether the action button will be primary (default) or secondary. Primary actions will be displayed directly in the table, whereas secondary actions will be hidden in a context menu.

  6. In the icon area:

    1. Click the Select Icon button to select an icon different from the default one.

    2. Click the Reset to Default button to reset to the default icon.

    3. In the Type drop-down list on the right, select how the icon should be displayed:

      1. Only icon - with this option, only the icon will be displayed on the button, whereas the label defined for the button will be displayed only as a tooltip

      2. Only label - with this option, only the label defined for the button will be displayed, whereas the selected icon will not be displayed

      3. Icon and label - with this option, the button will display both the icon and the defined label

  7. In the Request timeout in seconds field, specify the maximum time in seconds that the system will wait for a response from the REST API before timing out.

    This helps in managing the duration of the API request and handling potential delays.

  8. In the Queuing timeout in seconds field, specify the maximum time in seconds that the system will wait to acquire a read ticket before timing out. This can be individually overridden if needed.

  9. In the Duration in seconds field, define the caching duration in seconds, which must be at least 5 seconds. A value of 0 deactivates the cache explicitly.

    This option helps in optimizing the performance by storing the API response for a specific period, and thus reducing the need for repeated API calls.

  10. In the Tooltip text field, specify the text that will be displayed as a tooltip when hovering over the values in this column.

    You can use placeholders to enrich the tooltip text with data, e.g. 'My Tooltip value ${[i].payload.value}'.

HTTP Method

Expand the HTTP Method section.
→ The available configuration options are displayed.

images/confluence/download/attachments/5657678363/http_method_section_action_button_column-version-1-modificationdate-1746606783998-api-v2.png

Proceed as follows:

  1. Select the relevant HTTP Method.

  2. In the Request URL field, enter the Request URL to the third-party system.

    In the URL, you can refer to entries from the data source, with a path to the data element in the nested structure.

  3. In the Body tab:

    1. In the Body Type field, select the relevant body type: Raw Data, Form Data, or Document.

      The Body type option allows you to specify the format of the request body when making requests to the REST API. It is not available for the GET and DELETE HTTP methods.

      1. For Raw Data, enter the request body.

      2. For Form Data, enter a key-value pair.

      3. For Document, the system will send the matched document (defined in the data source) to the HTTP endpoint.

    2. In the Authorization Type drop-down list, select the type of authorization to be used when making requests to the REST API.

      1. The default option is Without Authentication.

      2. For Basic Auth:

        1. In the Username field, enter the username.

        2. In the Password field, enter the password.

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

      4. For OAuth 2.0 Bearer Token, enter the token.

      5. For Current User Session, be aware that this option only works for service domains that belong to the current project and not 3rd party applications.

  4. In the Headers tab:

    1. Enter a Key and a Value.

    2. Activate the Secret Header checkbox to flag the header as secret.

      When editing the REST request, the header information has to be provided.

    3. Click the + Add Header button to add another row.

      To remove a row, click the the Remove icon images/confluence/download/thumbnails/5657678363/delete-version-1-modificationdate-1746606783835-api-v2.png .

  5. In the Test Parameters tab, enter a filter parameter to test it.

    This pane can be used if a filter widget is configured for the dashboard.

    Independently from the test parameters, user-specific information can be referenced.

Response Trigger

Expand the Response Trigger section.
→ The available configuration options are displayed.

images/confluence/download/attachments/5657678363/response_trigger_action_button_column-version-1-modificationdate-1746606784222-api-v2.png

Proceed as follows:

  1. In the Default Trigger URL field, configure a URL that will be triggered if no other trigger matches the response from the REST API.
    This provides a fallback action in case no specific triggers are met.

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

  3. In the Response Code field, enter a response code.

  4. In the Trigger URL field, enter a URL that will be opened automatically upon receiving the respective response code from the REST API.

    This can be used to initiate additional actions or processes based on the API response.

  5. In the Action drop-down list, select whether the link shall be opened in the same tab or in a new tab.

  6. Тo add a trigger for another response code, click the Add Trigger button.

  7. To configure the newly added trigger, repeat the steps from 3 to 5.

Disable on Condition

Expand the Disable on Condition section.
→ The available configuration options are displayed.

images/confluence/download/attachments/5657678363/disable_on_condition_action_button_column-version-1-modificationdate-1746606784163-api-v2.png

Proceed as follows:

If you need to disable the button when the configured conditions apply:

  1. In the Property Path field, enter a property path where a condition shall be set.

    The property can be a data or context path (e.g. 0.device.color or filterParams.url or inputFields.id). The value can be any string; if it is left empty or set to undefined, then the action will be disabled if no value is found for the property.

  2. In the operator area, click the operator icon to select from the available operator options.

  3. From the Data Type drop-down list, select the relevant data type.

  4. In the Value field, enter any value at which the button shall be disabled.

    This field can be left empty or set to undefined to disable the button if there is no value available.

  5. To add the condition, click the Add button.

Styling

Expand the Styling section.
→ The available configuration options are displayed.

images/confluence/download/attachments/5657678363/styling_action_button_column-version-1-modificationdate-1746606784108-api-v2.png

Proceed as follows:

  1. Activate the Hide column checkbox if you need to hide the column in the table.

    Even if you choose to hide this column, the Enable column selection option described earlier will still allow you to select and unselect the column and thus to show and hide it in the table, respectively.

  2. Activate the Stick column horizontally checkbox if you need to fix the column in a horizontal position while scrolling through the table.
    When the box is checked, the column will be kept in place. When the box is not checked, the column will scroll horizontally with the rest of the table.

  3. Activate the Hide column name in table header checkbox to not display the column name in the table.

  4. Activate the Hide cell values checkbox to hide the cells text, for example to only show a background color.

  5. In the Minimal column width in px field, you can manually set the minimal column width to avoid word breaks in the column, ensuring that the column does not become narrower than the specified value. This can help maintain readability and prevent excessive compression of the column.

  6. From the Apply background as drop down list, select one of the following options:

    • Chip (default) - applies color to a chip around the value only

    • Cell - applies color to the entire cell
      If a cell has no value, then the entire cell will be colored, regardless of the choice.

  7. In the Background color field, click on the default color icon to configure the background color of the column.

    1. In the drop-down list next to the Color field, select one of the following options:

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

      • Data Source
        Select a parameter path from the drop-down list.

      • User Context
        Select user information to be displayed, e.g., User ID, User Email, or the time zone.

      • Filter Widget
        Select a filter from the Filter widget you added to the dashboard.

      • Input Widget
        Select the input field from the Input widget you added to the dashboard.

  8. In the Text color field, define the text color as described above for Background color.

Configuring a Hyperlink column type

For a Hyperlink column type, the configuration options are grouped into the following sections:

  • Column Configuration and

  • Styling.

    The Styling options configuration is the same as described above in Configuring an Action button column type.

Column Configuration

Expand the Column Configuration section.
→ The available configuration options are displayed.

images/confluence/download/attachments/5657678363/hyperlink_column_general-version-1-modificationdate-1746606782706-api-v2.png

Proceed as follows:

  1. In the Column Name field, enter a name for the column.

  2. Click the EN drop-down list and select Add DE: German to add the German equivalent for the label.

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

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

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

  • In the Tooltip text field, specify the text that will be displayed as a tooltip when hovering over the values in this column.

    You can use placeholders to enrich the tooltip text with data, e.g. 'My Tooltip value ${[i].payload.value}'.

Configuring an Image column type

For an Image column type, the configuration options are grouped into the following sections:

  • Column Configuration,

  • Image Source, and

  • Styling.

    The Styling options configuration is the same as described above in Configuring an Action button column type.

Column Configuration

Expand the Column Configuration section.
→ The available configuration options are displayed.

images/confluence/download/attachments/5657678363/image_column_general-version-1-modificationdate-1746606782573-api-v2.png

Proceed as follows:

  1. In the Column Name field, enter a name for the column.

  2. Click the EN drop-down list and select Add DE: German to add the German equivalent for the label.

  3. In the Tooltip text field, specify the text that will be displayed as a tooltip when hovering over the values in this column.

    You can use placeholders to enrich the tooltip text with data, e.g. 'My Tooltip value ${[i].payload.value}'.

Image Source

Expand the Image Source section (also visible on the screenshot above).
→ The available configuration options are displayed.

Proceed as follows:

  1. For the source type, activate one of the radio buttons:

    1. Device image

    2. Base 64 image

    3. From URL

  2. For the option Device image, the Device property path field allows you to specify the path to the image within the device data that should be displayed in the corresponding column of the table.

  3. For the option Base 64 image, the Base 64 property path field allows you to specify the path to the image base 64 within the data source that should be displayed in the corresponding column of the table.

  4. For the option From URL, the URL field allows you to specify the url to the image that should be displayed in the corresponding column of the table.

  5. In the fields Image max height and Image max width, enter values for the maximum image size in pixels.

Configuring a JSON Property column type

For a JSON Property column type, the configuration options are grouped into the following sections:

  • Column Configuration,

  • Data Type Handling, and

  • Styling.

    As the styling section offers an additional option compared to the other column types, it is described separately below.

Column Configuration

Expand the Column Configuration section.
→ The available configuration options are displayed.

images/confluence/download/attachments/5657678363/JSON_property_general-version-1-modificationdate-1746606783048-api-v2.png

Proceed as follows:

  1. In the Column Name field, enter a name for the column.

  2. Click the EN drop-down list and select Add DE: German to add the German equivalent for the label.

  3. In the Values data path drop-down list, select or enter the iterator.

  4. Select the Multiple values (array) checkbox to have all values of an array displayed in a table row.

  5. When the Multiple values (array) checkbox is selected, the Array value separator field is displayed.
    Use its drop-down list to specify how the values in that table row shall be separated from each other, e.g. Line break, Comma, Semicolon, White space, or List based.

  6. In the drop-down list next to the Prefix field, select one of the following options:

    • Value
      Enter any value as a prefix, e.g., €.

    • Data Source
      Select a parameter path from the drop-down list.

    • User Context
      Select user information to be displayed as prefix, e.g., User ID, User Email, or the time zone.

    • Filter Widget
      Select a filter from the Filter widget you added to the dashboard.

    • Input Widget
      Select the input field from the Input widget you added to the dashboard.

  7. In the drop-down list next to the Suffix field, select one of the following options:

    • Value
      Enter any value as a suffix, e.g., %.

    • Data Source
      Select a parameter path from the drop-down list.

    • User Context
      Select user information to be displayed as suffix, e.g., User ID, User Email, or the time zone.

    • Filter Widget
      Select a filter from the Filter widget you added to the dashboard.

    • Input Widget
      Select the input field from the Input widget you added to the dashboard.

  8. In the Tooltip text field, specify the text that will be displayed as a tooltip when hovering over the values in this column.

    You can use placeholders to enrich the tooltip text with data, e.g. 'My Tooltip value ${[i].payload.value}'.

Data Type Handling

Expand the Data Type Handling section.
→ The available configuration options are displayed.

images/confluence/download/attachments/5657678363/JSON_value_type-version-1-modificationdate-1746606783658-api-v2.png

Proceed as follows:

The Value Type option allows you to specify the data type of the values in the corresponding column of the table. This lets you define how the data will be displayed on the basis of its type.

  1. In the Value Type drop-down list, select one of the available options:

    • Boolean,

    • Number,

    • String,

    • Date/Time,

    • JSON

  2. Depending on the data type you selected, define the following:

    1. For Boolean:

      1. In the Enter text to be shown instead of "true" field, enter a value that is displayed instead of true.

      2. In the Enter text to be shown instead of "false" field, enter a value that is displayed instead of false.

    2. For Number:

      1. Activate the Thousands separator checkbox to format numbers.

      2. Select the number of Decimal Digits for behind the comma.

    3. For String, activate the Wrap text checkbox to add line breaks.
      Checking the box will wrap the text within the column, while unchecking it will display the text on a single line without wrapping.

    4. For Date/Time:

      1. Activate the Disable time zone conversion (Date and time is shown as UTC) checkbox to use UTC.

      2. In the Time format drop-down list, select a format in which the date and time shall be displayed.

    5. For JSON:

      1. Activate the Autoformat checkbox to automatically indent the formatting of the JSON.

      2. Activate the Show in popover checkbox to activate the inline view which provides the first 50 characters of the JSON in the form of a hyperlink.

      3. In the Maximum lines of JSON editor field, define the number of rows to be displayed before scrolling is necessary.

Styling

Expand the Styling section.
→ The available configuration options are displayed.

Proceed as follows:

  1. Activate the Hide column checkbox if you need to hide the column in the table.

    Even if you choose to hide this column, the Enable column selection option described earlier will still allow you to select and unselect the column and thus to show and hide it in the table, respectively.

  2. Activate the Stick column horizontally checkbox if you need to fix the column in a horizontal position while scrolling through the table.
    When the box is checked, the column will be kept in place. When the box is not checked, the column will scroll horizontally with the rest of the table.

  3. Activate the Hide column name in table header checkbox to not display the column name in the table.

  4. Activate the Hide cell values checkbox to hide the cells text, for example to only show a background color.

  5. In the Minimal column width in px field, you can manually set the minimal column width to avoid word breaks in the column, ensuring that the column does not become narrower than the specified value. This can help maintain readability and prevent excessive compression of the column.

  6. From the Apply background as drop down list, select one of the following options:

    • Chip (default) - applies color to a chip around the value only

    • Cell - applies color to the entire cell
      If a cell has no value, then the entire cell will be colored, regardless of the choice.

  7. In the Background color field, configure the background color of the column.
    You can choose between a Default color and a Conditional color by means of the square icon and the plus icon in the field, respectively.
    You can define different rules based on which different colors can be displayed.

    images/confluence/download/attachments/5657678363/background_color_default_conditional-version-1-modificationdate-1746606783334-api-v2.png
  8. If you selected the Default color icon, the Default color dialog is displayed, where you can proceed as follows:

    1. In the drop-down list next to the Color field, select one of the following options:

      1. Value
        Enter your color value manually by using a HEX code or use the color picker.

      2. Data Source
        Select a parameter path from the drop-down list.

      3. User Context
        Select user information to be displayed, e.g., User ID, User Email, or the time zone.

      4. Filter Widget
        Select a filter from the Filter widget you added to the dashboard.

      5. Input Widget
        Select the input field from the Input widget you added to the dashboard.

    2. Click the Apply button.

  9. If you selected the Conditional color icon, the Conditional color dialog is displayed, where you can proceed as follows:

    1. In the drop-down list next to the Color field, select one of the following options:

        1. Value
          Enter your color value manually by using a HEX code or use the color picker.

        2. Data Source
          Select a parameter path from the drop-down list.

        3. User Context
          Select user information to be displayed, e.g., User ID, User Email, or the time zone.

        4. Filter Widget
          Select a filter from the Filter widget you added to the dashboard.

        5. Input Widget
          Select the input field from the Input widget you added to the dashboard.

    2. In the drop-down list next to the condition field, which depends on the value type (see below), select one of the following options:

      1. Value
        You can enter your condition manually depending on the value type, as described in point c. below.

      2. Data Source
        Select a parameter path from the drop-down list referring to this condition.

      3. User Context
        Select user information to be referred, e.g., User ID, User Email, or the time zone.

      4. Filter Widget
        Select a filter from the Filter widget you added to the dashboard.

      5. Input Widget
        Select the input field from the Input widget you added to the dashboard.

    3. Click the condition field and fill in the condition based on which the specified color shall be displayed, as follows:

      1. If you have selected Boolean as Value Type in Data Type Handling section, select either true or false. You can define another conditional color for the other value as well.

        images/confluence/download/attachments/5657678363/boolean_value_type_color_condition-version-1-modificationdate-1746606783275-api-v2.png
      2. If you have selected Number as Value Type in Data Type Handling section, add values to the From and To fields.

      3. If you have selected String as Value Type in Data Type Handling section, set a dynamic background color with regular expressions to have the color of the row depend on the result of the regular expressions.

      4. If you have selected Date/Time as Value Type in Data Type Handling section, choose between the options in the Absolute, Relative, and Presets tabs.

        images/confluence/download/attachments/5657678363/date_time_value_type-version-1-modificationdate-1746606783215-api-v2.png
    4. Confirm by clicking the Apply button.

  10. In the Text color field, define the text color.
    Follow the same steps as described for Background color above.

Configuring a Rich Text column type

For a Rich Text column type, the configuration options are grouped into the following sections:

  • Column Configuration,

  • Data Type Handling, and

  • Styling.

The Styling options configuration is the same as described above in Configuring an Action button column type.

Column Configuration

Expand the Column Configuration section.
→ The available configuration options are displayed.

images/confluence/download/attachments/5657678363/rich_text_column_general-version-1-modificationdate-1746606782993-api-v2.png

Proceed as follows:

  1. In the Column Name field, enter a name for the column.

  2. Click the EN drop-down list and select Add DE: German to add the German equivalent for the label.

  3. Enter the text to be displayed in the text box.

  4. Format the text as desired.

  5. Insert ${ to add references to data paths. A drop-down list with all possible references is displayed.

Data Type Handling

Expand the Data Type Handling section (as on the screenshot above).

  1. Activate the Wrap text checkbox to add line breaks.
    Checking the box will wrap the text within the column, while unchecking it will display the text on a single line without wrapping.

Batch Processing

In the Batch Processing tab, you can add one or more batch buttons to the table which will trigger actions for multiple rows.

images/confluence/download/attachments/5657678363/batch_processing_tab-version-1-modificationdate-1746606783777-api-v2.png

Proceed as follows:

  1. Click Add Button for every button that you wish to add, and then fill in the following configuration details for each button separately.

  2. To navigate more easily to the relevant button, use the Collapse all and Expand all options.

  3. Configure each button through the relevant sections:

    • Column Configuration,

    • HTTP Method,

    • Response Trigger,

    • Disable on Condition.

  4. To navigate more easily to the relevant configuration fields, you can expand and collapse each section.

Column Configuration

  1. In the Button Name field, enter text that shall be displayed on the button.

  2. In the icon area:

    1. Click the Select Icon button to select an icon different from the default one.

    2. Click the Reset to default button to reset to the default icon.

    3. In the Type drop-down list on the right, select how the icon should be displayed:

      1. Only icon - with this option, only the icon will be displayed on the button, whereas the label defined for the button will be displayed only as a tooltip

      2. Only label - with this option, only the label defined for the button will be displayed, whereas the selected icon will not be displayed

      3. Icon and label - with this option, the button will display both the icon and the defined label

  3. In the Path to the action data context field, define the exact path to the data element from the data source, in order to use it later in the Request URL field below.

    Since the action is executed outside of the table context, the exact path to the data element needs to be defined separately. The default case is: [i].

  4. In the Request timeout in seconds field, specify the maximum time in seconds that the system will wait for a response from the REST API before timing out.

    This helps in managing the duration of the API request and handling potential delays.

  5. In the Queuing timeout in seconds field, specify the maximum time in seconds that the system will wait to acquire a read ticket before timing out. This can be individually overridden if needed.

  6. In the Duration in seconds field, define the caching duration in seconds, which must be at least 5 seconds. A value of 0 deactivates the cache explicitly.

    This option helps in optimizing the performance by storing the API response for a specific period, and thus reducing the need for repeated API calls.

HTTP Method

  1. Select the relevant HTTP Method.

  2. In the Request URL field, enter the request URL to the third-party system. In the URL, you can refer to entries from the data source, with a path to the data element in the nested structure.

    See the following example of a configured path and URL:

    images/confluence/download/attachments/5657678363/request_url_example-version-1-modificationdate-1746606783718-api-v2.png

  3. In the Body tab:

    1. In the Body Type field, select the relevant body type: Raw Data, Form Data, or Document.

      The Body type option allows you to specify the format of the request body when making requests to the REST API. It is not available for the GET and DELETE HTTP methods.

      1. For Raw Data, enter the request body.

      2. For Form Data, enter a key-value pair.

      3. For Document, the system will send the matched document (defined in the data source) to the HTTP endpoint.

    2. In the Authorization Type drop-down list, select the type of authorization to be used when making requests to the REST API.

      1. The default option is Without Authentication.

      2. For Basic Auth:

        1. In the Username field, enter the username.

        2. In the Password field, enter the password.

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

      4. For OAuth 2.0 Bearer Token, enter the token.

      5. For Current User Session, be aware that this option only works for service domains that belong to the current project and not 3rd Party applications.

  4. In the Headers tab:

    1. Enter a Key and a Value.

    2. Activate the Secret Header checkbox to flag the header as secret.

      When editing the REST request, the header information has to be provided.

    3. Click the + Add Header button to add another row.

      To remove a row, click the the Remove icon images/confluence/download/thumbnails/5657678363/delete-version-1-modificationdate-1746606783835-api-v2.png .

  5. In the Test Parameters tab, enter a filter parameter to test it.

    This tab can be used if a filter widget is configured for the dashboard.

    Independently from the test parameters, user-specific information can be referenced.

Response Trigger

  1. In the Default Trigger URL field, configure a URL that will be triggered if no other trigger matches the response from the REST API.

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

  3. In the Response Code field, enter a response code.

  4. In the Trigger URL field, enter a URL that will be opened for the response code which you will enter in the Response Code field.

  5. In the Action drop-down list, select whether the link shall be opened in the same tab or in a new tab.

    This can be used to initiate additional actions or processes based on the API response.

  6. Тo add a trigger for another response code, click the Add Trigger button.

  7. To configure the newly added trigger, repeat the steps from 3 to 5.

Disable on condition

To disable the button if the configured conditions apply:

  1. In the Property Path field, enter a property path where a condition shall be set.

    The property can be a data or context path (e.g. 0.device.color or filterParams.url or inputFields.id). The value can be any string; if it is left empty or set to undefined, then the action will be disabled if no value is found for the property.

  2. In the operator area, click the operator icon to select from the available operator options.

  3. From the Data Type drop-down list, select the relevant data type.

  4. In the Value field, enter any value at which the button shall be disabled.

    This field can be left empty or set to undefined to disable the button if there is no value available.

  5. To add the condition, click the Add button.