> For the complete documentation index, see [llms.txt](https://docs.valtimo.nl/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://docs.valtimo.nl/configuration-guides/cases/case-groups.md).

# Case groups

{% hint style="success" %}
Available since Valtimo `13.53.0`
{% endhint %}

A case group combines several case definitions into one shared case list, so users can work on related cases from a single place.

Each case group has its own list columns and search fields. Because every case definition has its own document structure, a column or search field in a group is mapped to a path per case definition. For example, the applicant name can be stored in `doc:achternaam` in one case definition and in `doc:aanvrager.naam` in another, and still be shown in one **Applicant** column.

This includes:

* [**General**](https://docs.valtimo.nl/configuration-guides/cases/case-groups/configuration.md) — Creating a case group, choosing its color, and adding case definitions
* [**List columns**](https://docs.valtimo.nl/configuration-guides/cases/case-groups/list-columns.md) — Columns displayed in the case list of the group
* [**Search fields**](https://docs.valtimo.nl/configuration-guides/cases/case-groups/search-fields.md) — Search fields available for filtering the case list of the group

***

## Configuring case groups

{% stepper %}
{% step %}
Expand **Admin** in the left sidebar
{% endstep %}

{% step %}
Click **Cases** under the Configuration section
{% endstep %}

{% step %}
Click the **Case groups** tab

<figure><img src="https://3330064618-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2Fq5dx9HWFJGshztp4binE%2Fuploads%2Fgit-blob-8378b015883f2576762413620fee10424eb7bc3b%2F01-case-groups-overview.png?alt=media" alt=""><figcaption><p>Case groups tab</p></figcaption></figure>
{% endstep %}

{% step %}
Click a case group to open it, or click **Create** to add a new one
{% endstep %}
{% endstepper %}

The list shows all case groups with their name, key, and the number of case definitions in each group.

The detail page of a case group has three tabs: **General**, **List columns**, and **Search fields**. The **Edit** and **Export** buttons in the header are available on every tab.

{% hint style="info" %}
Case groups are not versioned. A case group refers to case definitions by key, so its configuration applies to all versions of those case definitions.
{% endhint %}

### Exporting a case group

A case group can be exported to a ZIP file and imported in another environment, for example to move a configuration from a test environment to production. The export contains the complete configuration of the case group:

| Included         | Description                                                 |
| ---------------- | ----------------------------------------------------------- |
| General          | Key, name, description, and color                           |
| Case definitions | The keys of the case definitions in the group               |
| List columns     | All columns, including their path per case definition       |
| Search fields    | All search fields, including their path per case definition |

Cases are not part of the export.

{% stepper %}
{% step %}
Click a case group to open it
{% endstep %}

{% step %}
Click **Export** in the header

<figure><img src="https://3330064618-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2Fq5dx9HWFJGshztp4binE%2Fuploads%2Fgit-blob-06bf73986579f0c649d275aa998c793fd4966932%2F10-group-detail-header.png?alt=media" alt=""><figcaption><p>Export button</p></figcaption></figure>
{% endstep %}
{% endstepper %}

The browser downloads a ZIP file with the configuration of the case group.

### Uploading a case group

{% stepper %}
{% step %}
Click **Upload** in the toolbar
{% endstep %}

{% step %}
Click **Select file**
{% endstep %}

{% step %}
Select a ZIP file exported from a case group
{% endstep %}

{% step %}
Read the warning and select **I understand that an existing case group with the same key will be overwritten**

<figure><img src="https://3330064618-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2Fq5dx9HWFJGshztp4binE%2Fuploads%2Fgit-blob-f81655016fad8dd5f0e3f4521a111d45c3f52698%2F11-import-group-modal.png?alt=media" alt=""><figcaption><p>Import case group</p></figcaption></figure>
{% endstep %}

{% step %}
Click **Import**
{% endstep %}
{% endstepper %}

{% hint style="warning" %}
If a case group with the same key already exists, it is overwritten, including its case definitions, list columns, and search fields.
{% endhint %}

{% hint style="info" %}
Case definitions that do not exist in the target environment are skipped. Import or create these case definitions first, then import the case group again.
{% endhint %}

***

## Access for end users

Case groups have no separate permissions. Visibility follows the existing `view_list` permission on case definitions (see [Access control](https://docs.valtimo.nl/configuration-guides/access-control.md)):

* A user sees a case group when they are allowed to view the case list of at least one case definition in the group.
* The case list of a group only shows cases of the case definitions the user is allowed to view.
* When starting a case from a group, the user can only choose case definitions they are allowed to start.
