Skip to content

Cases

By default, recordings are persisted for a limited amount of time. Within Hub you define a retention period per subscription and assign it to a user. The retention period can be set to 30, 60, 90 days or any custom value. It determines how many days of footage are visible to the end-user after login, and controls when the associated recordings metadata are removed from the database.

There are many situations where you may want to retain specific recordings for future inspection, or simply because an event is important. By archiving a recording, it is copied to a separate storage provider in Vault with a longer or non-expiring retention period — for example, 3 years or more.

Cases are the mechanism in Hub to trigger this archiving process. Once a case is created, the associated recording is copied from the current storage provider to the designated archive storage provider in Vault.

Note: The current archiving feature is designed for individual recordings only. It is not suitable for bulk exports or archiving large volumes of data (e.g. terabytes). We are aware of this limitation and are actively working on a solution to support large-scale archiving and export in a future release.

Introduction

The cases page is reachable from the main sidebar, under Cases. It lists every case in your account together with the recordings attached to it, the assignee, and any labels.

The cases overview lists every case in your account.

The cases overview lists every case in your account.

Selecting a row expands the case in place so you can review the attached recording, edit the title and description, manage labels, and add comments without leaving the page.

An expanded case shows the recording, details, and comments.

Open a case from the list to inspect the recording and follow up on it.

Creating a case

Cases are always created from a recording. The fastest way is to start from the Recordings page (/media) and create the case directly from the recording you want to archive.

  1. Open Recordings in the sidebar.
  2. Click on a recording to open its side panel on the right.
  3. In the panel header, open the Actions dropdown (top-right).
  4. Choose New case to open the New case modal.
The New case modal opened from the Actions menu of a recording's side panel.

The New case modal, opened from the Actions menu of a recording.

The modal has two tabs — Details and Media — and the following fields:

Details

  • Case name (required) — a short, descriptive title for the case. This is the title shown in the cases overview and in any notification sent to assignees.
  • Notes — free-form description used to capture context about why the recording is being archived (incident reference, observations, follow-up actions, …).

Settings

  • Notify assignees — when enabled, the assignees you select below receive a notification as soon as the case is created.
  • Keep this case private — restricts visibility of the case to its assignees only. Other users in the account will not see the case in the overview.

Labels

  • Labels — pick one or more labels to categorise the case (for example intrusion, false alarm, insurance). Labels can be filtered on from the cases overview.

Assignees

  • Assignees (required) — the users responsible for following up on the case. The current user is selected automatically; add or remove members as needed.

Media

The Media tab shows the recordings that will be attached to the case. When the modal is opened from a recording’s side panel, that recording is pre-selected. You can review the preview and remove individual recordings before creating the case.

Once all required fields are filled in and at least one recording is attached, click New case in the bottom-right of the modal to create it. The recording is then queued for archiving to the Vault archive provider you configured below.

There are also two other entry points to the same modal:

  • From the Recordings page header, the Create case button creates a case from the currently active filters — see Creating a case in bulk from the Recordings page below.
  • From the Watchlist, every notification row exposes an Add Case action that pre-fills the modal with the notification’s recording.

Creating a case in bulk from the Recordings page

The single-recording flow above is convenient when you already know which recording you want to archive. When the event of interest covers a longer time window — or when you want to archive every recording from a given device on a specific day — the Recordings page lets you create a case in bulk from the active filters.

  1. Open Recordings in the sidebar.
  2. Pick a date in the date picker.
  3. Optionally narrow down by device or site in the filter bar.
  4. Drag the timeline at the bottom to the time window you want to archive (the from and to selection updates the URL — for example /media?date=2026-05-07&from=1262&to=2574&devices=camera2).
  5. Click the Create case button in the page header (next to Clear filter and Refresh).

The same New case modal opens, with every recording matching the active filters pre-attached on the Media tab. Fill in the case details as usual and confirm with New case in the bottom-right.

The Create case modal opened from the Recordings page header with a date, device and time range pre-applied via the page filters.

The Create case modal opened from the Recordings page header. Every recording matching the active filters (date, device, time range) is attached to the new case in one go.

Note: To keep cases manageable, the Create case button is disabled when more than 1000 recordings match the current filters. Refine the date, device or time range before retrying.

Creating a case from the context overlay

Sometimes a single recording is not enough — you may want to archive the moments leading up to and following an event. The View Context action, also available from the Actions dropdown of a recording’s side panel, opens a wider time window of recordings around the selected one.

The Context overlay shows recordings around the selected one on a timeline.

The Context overlay loads recordings before and after the selected one on a shared timeline.

In the overlay you can:

  • Pan and zoom the timeline at the bottom to navigate the surrounding recordings.
  • Use the filters (time offset, site, group) to broaden or narrow the set of recordings shown.
  • Click Create case in the bottom-right of the overlay to open the same New case modal described above, pre-filled with the recordings currently in scope. The fields and validation rules are identical to the standard flow.

This is the recommended way to create a case when the event you want to archive spans multiple recordings or you need extra context before and after it.

Adding a recording to an existing case

Instead of creating a brand-new case, you can attach a recording to a case that already exists. From the same Actions dropdown of a recording’s side panel, choose Add to case.

The Add to case modal lists all accessible cases so you can attach a recording to one.

The Add to case modal lists every case you have access to and lets you filter by site, device, assignee, label or status.

The modal lists every case you have access to. To find the right one, you can:

  • Search by case title in the search field at the top.
  • Filter by Sites, Devices, Assignees, Labels or Status using the dropdowns on the filter row.

Click a case in the list to select it (the row becomes highlighted), then press Add to case in the bottom-right of the modal. The recording is appended to the selected case and queued for archiving alongside the recordings already attached to it.

Configuration

To start using cases some configurations need to be enabled on Vault and Hub, before you can use it.

Create archive storage provider in Vault

To use cases and the archiving process, an additional storage provider must be created in Vault.

Create a new storage provider for archiving in Vault.

Create a new storage provider for archiving in Vault.

To set the archiving retention period, a new Vault account must be created, since the retention period is defined at the account level. Recordings copied to the archive storage provider will inherit the retention period from this account.

Define a retention period in a new Vault account.

Define a retention period in a new Vault account.

Define archive provider and account in Hub

Now that your Vault instance is configured for archiving, you need to tell Hub where to archive recordings — which provider and account to use. Open the values.yaml and locate the kerberosvault section. Here you will find the archive property.

# We have a Vault component installed which contains all the
# recordings. Vault is queried to retrieve the recordings
# from the appropriate provider.
kerberosvault:
uri: "https://api.storage.yourdomain.com"
accesskey: "xxx"
secretkey: "xxx"
provider: "a-provider"

# Archiving is used when creating a case. The underlying recording of the case will be copied from its
# existing provider to the below archived provider. Seperate credentials are used, as it makes possible to
# specify another retention period.
archive:
    accesskey: "xxx"
    secretkey: "xxx"
    provider: "an-archive-provider"

Set the accesskey and secretkey of your newly created Vault account, and specify the name of the archive provider. Then apply the updated helm chart.