List

To configure the columns of the case list overview the same prefixes can be used as described for the search fields configuration.

In the List tab of the Case Definition, the columns displayed in the list of cases for end users in the Valtimo UI can be configured. When a case type is selected from the Cases menu, the list screen opens and displays all cases of that type in accordance with this configuration.

If no configuration exists for a case, Valtimo defaults to the following list of case metadata:

• Reference number

• Created by

• Created on

• Last modified

• Assignee (only if configured)

• Status (only if configured)

Configuring a case list

To configure the columns of the case list overview the same type of prefixes can be used as for the search fields configuration.

Via UI

• Go to the Admin menu

• Go to the Cases menu

• Select the List tab

• Click on Add column

• Configure a new column

With help from the List field types information on the top of this page each column can be configured. The Save button becomes available once all mandatory fields are configured.

The first column added to a configuration immediately disables all default metadata columns. As a result, only the configured column will be displayed in the user interface.

Via IDE

A case list configuration file can be added to the resource folder. These configuration files are automatically deployed when the application starts. List configuration files are only automatically deployed when they are located on this path: /resource/config/case/list

The name of the configuration file must match the name of the document definition. This ensures that the list configuration is linked to the correct document definition.

Example If the name of the document definition is profile, the configuration path and file name must be: /resource/config/case/list/profile.json

The content of a list configuration file can look like this:

[
    {
        "key": "createdOn",
        "title": "Created on",
        "path": "case:createdOn",
        "displayType": {
            "type": "date",
            "displayTypeParameters": {
                "dateFormat": "yyyy-MM-dd"
            }
        },
        "sortable": false,
        "defaultSort": "DESC",
        "order": 0
    }
]

List field types

Overview of available configuration fields and the corresponding field types.

• Title The title is an optional field that appears as the label in the search field case list UI. This field is not mandatory and if left blank a translation of the Key will be shown. If no translation for the Key is set, the Key will be shown.

• Key This field needs to be unique within this case, submission will be prevented if duplicates are found.

• Path The path input gives access to the data fields and meta data of the case. These can easily be identified by there prefix. Case data can be targeted by using the doc: prefix. Use the case: prefix to target the case meta data.

Prefix examples Path: case:assigneeFullname This path targets the assigned case handlers full name. Path: doc:request.budget This path targets the case data itself. The doc: prefix directs to the content object of the case document so the same JSON paths that where used in the Form.io forms to store the data.

• Display Type With this setting the behavior of the UI in the list overview can be set. Data can be displayed as normal text, but also as dates, booleans, or tags for example. Try out the types to see what works for each case.

• Sortable and Default Sort If set the header column will have the sort options available for this column, default sort setting is executed on page enter. A default sort order can be selected when Sortable is checked.