Bosch IoT Insights

Retention

In Retention, the system collections, thing history collection, and conditional actions, you configured in Services > Conditional Actions, as well as their retention times are displayed.

Proceed as follows

Click the Retention menu item.
→ The Retention menu item is displayed and shows the conditional actions with their retention times.
images/confluence/download/attachments/1169667769/Admin_Views_Dashboard_Overview-version-1-modificationdate-1695901714000-api-v2.png

Prerequisites

  • To execute the following action, you have to be assigned to the Admin role or higher.

  • For the Conditional Actions section, you have configured at least one conditional action, refer to Conditional Actions.

Configuring a processed data retention time

You can configure the retention time for processed data collections in days for a specific time property path.

You can only configure one retention time for a processed data collection.

Proceed as follows

  1. Click the edit icon images/confluence/download/thumbnails/1169667769/edit_icon_light_blue-version-1-modificationdate-1671533560000-api-v2.png in the line of the collection you want to change the retention time of.
    → The corresponding dialog opens.

  2. In the Time Property Path field, enter the path of the time property for which you want to set the retention time, e.g. metaData.receivedAt.

  3. In the Days field, enter, decrease, or increase the number of days.

    The minimum retention time is one day.

  4. Click the Save changes button.
    → The retention time has been saved.

To change the time property path, delete the existing retention time index and add a new retention time.

The time property path cannot be changed for time series collections.

If you adjust a retention time, the change is applied with delay.

Deleting a processed data retention time

When deleting the retention time of a processed data collection, the whole index will be deleted. An exception are time series collections, where only the retention time will be deleted.

Proceed as follows

  1. Click the delete icon images/confluence/download/thumbnails/1169667769/icon_delete_light_blue-version-1-modificationdate-1671533560000-api-v2.png in the line of the collection you want to remove the retention time of.
    → The corresponding dialog is displayed.

  2. Click the Delete button.

    If you remove a retention time, the change is applied with delay.

Configuring a system collection retention time

You can configure the retention time for a system collection, such as calendar events or query history in days.

Proceed as follows

  1. Click the edit icon images/confluence/download/thumbnails/1169667769/edit_icon_light_blue-version-1-modificationdate-1671533560000-api-v2.png in the line of the collection you want to change the retention time of.

    The timestamp property for this collection is pre-defined. The t ime property stands for the value, part of the data, which identifies the timestamp used as reference for the retention time.

    → The corresponding dialog opens.

  2. In the Days field, enter, decrease, or increase the number of days.

    The minimum retention time is one day.

  3. Click the Save changes button.
    → The retention time has been saved.

    If you adjust a retention time, the change is applied with delay.

Configuring a thing history retention time

You can configure the retention time for the thing history in days. To add a retention time, the devices must have been already deleted.

Proceed as follows

  1. Click the edit icon images/confluence/download/thumbnails/1169667769/edit_icon_light_blue-version-1-modificationdate-1671533560000-api-v2.png in the line of the collection you want to change the retention time of.

    The timestamp property for this collection is pre-defined. The t ime property stands for the value, part of the data, which identifies the timestamp used as reference for the retention time.

    → The corresponding dialog opens.

  2. In the Days field, enter, decrease, or increase the number of days.

    The minimum retention time is one day.

  3. Click the Save changes button.
    → The retention time has been saved.

If you adjust a retention time, the change is applied with delay.

Deleting a thing history retention time

Proceed as follows

    1. Click the delete icon images/confluence/download/thumbnails/1169667769/icon_delete_light_blue-version-1-modificationdate-1671533560000-api-v2.png in the line of the collection you want to remove the retention time of.
      → The corresponding dialog is displayed.

    2. Click the Delete button.

      If you remove a retention time, the change is applied with delay.

Configuring a user retention time

You can configure the expiration time for users, personal accounts, and technical clients.

Proceed as follows

  1. Click the edit icon images/confluence/download/thumbnails/1169667769/edit_icon_light_blue-version-1-modificationdate-1671533560000-api-v2.png in the line of the user type you want to change the retention time of.

    If the retention time is changed, all users who were inactive during that period will be removed.

    → The corresponding dialog is displayed.

  2. Enter, decrease, or increase the number of days.

    The minimum retention time is one day.

  3. Click the Save changes button.
    → The retention time has been saved.

    If you adjust a retention time, the expired users will be removed within one day. Admins are informed about the removed users by email.

Deleting a user retention time

Proceed as follows

  1. Click the delete icon images/confluence/download/thumbnails/1169667769/icon_delete_light_blue-version-1-modificationdate-1671533560000-api-v2.png in the line of the user type you want to remove the retention time of.
    → The corresponding dialog is displayed.

  2. Click the Delete button.
    → The user retention time is deleted.

Configuring a conditional action retention time

You can configure the retention time for log entries of the executed conditional actions in days.

Proceed as follows

  1. Click the edit icon images/confluence/download/thumbnails/1169667769/edit_icon_light_blue-version-1-modificationdate-1671533560000-api-v2.png in the line of the conditional action you want to change the retention time of.

    When changing the retention times, already existing log entries and their retention times will not be affected. Only future entries will receive the new retention time. Therefore, the existing entries are not automatically deleted.

  2. Enter the number of days in the corresponding line of the Retention time of resulting log entries in days column.

    The minimum retention time is one day. 30 days is the default value.

  3. Click the Save button.
    → The retention time has been saved.

General functions

Paging

Proceed as follows

Use the images/confluence/download/thumbnails/1169667769/icon_page_beginning-version-1-modificationdate-1618841394000-api-v2.png and images/confluence/download/thumbnails/1169667769/icon_page_end-version-1-modificationdate-1618841394000-api-v2.png icons to jump to either the first page or the last page of entries.

Use the images/confluence/download/thumbnails/1169667769/icon_page_back-version-1-modificationdate-1618841394000-api-v2.png and images/confluence/download/thumbnails/1169667769/icon_page_next-version-1-modificationdate-1618841395000-api-v2.png icons to go back a page or forward.

Refreshing the conditional actions

Proceed as follows

Click the refresh icon images/confluence/download/thumbnails/1169667769/icon_refresh-version-1-modificationdate-1618841395000-api-v2.png to refresh the list of conditional actions.