Columns

Task list columns can be configured to change the visible columns in the task list.

Via UI

• Go to the Admin menu

• Go to the Tasks menu

• Select the case to configure task list columns for

The configured task list columns will only be available for the selected case.

From here, it is possible to:

• Add columns

• Edit columns

• Sort columns

• Delete columns

Adding a column

A column can be added by clicking on the Add column button. This will open the following modal:

Add task list column

• Title If this field is filled in, this title will display as the column header, overriding any available translations.

• Key A unique key by which the column is identified. If the key is not unique, you will not be able to save the column.

• Path A path which leads to the property you want to show. For the document's JSON schema, follow this example: doc:customer.firstName. For document properties, follow these examples: case:createdBy, or case:sequence, or case:assigneeFullName.

Note

When there are special characters in a property, the property must be enclosed in quotes. For example: case:"loan-accepted".

• Display type This option decides how the data is eventually displayed in the table.

• Sortable Whether the column will be sortable by the user

• Default Sort If this field has a value, the table will be sorted by default on this property, in the direction specified. Only one column at a time can have this property. On creating a new column, if another column already has a default sort specified, this input field will be disabled.

Via IDE

Task list columns can be autodeployed by adding json files on the classpath. These files should end with .case-task-list.json to be eligible for autodeployment.

Every deployment file represents a changeset. These files are required to contain a changesetId that should be unique over all deployment files that use changesets. When starting up, changesets that have already been executed will be ignored. A checksum of the changeset is created when it is executed. Changesets that have already been deployed should not change. Changesets that have been changed since a previous time will result in an error and failure to start the application.

All changesets can be executed again, even when the content has changed, by setting the valtimo.changelog.case-task-list.clear-tables property to true. By default, this setting is disabled.

my-case.case-task-list.json

{
  "changesetId": "my-case.case-task-list",
  "case-definitions": [
    {
      "key": "my-case",
      "columns": [
        {
          "title": "First name",
          "key": "first-name",
          "path": "doc:first-name",
          "displayType": {
            "type": "text",
            "displayTypeParameters": {}
          },
          "sortable": false
        },
        {
          "title": "Last name",
          "key": "last-name",
          "path": "doc:last-name",
          "displayType": {
            "type": "text",
            "displayTypeParameters": {}
          },
          "sortable": true,
          "defaultSort": "ASC"
        }
      ]
    }
  ]
}

Available properties

The following properties can be shown in the task list:

• Properties from the document, with the 'doc:' prefix. E.g.: doc:first-name

• Properties from the task, with the task: prefix. The following properties are available:

  • createTime

  • name

  • assignee

  • dueDate

Starting Valtimo 12.6.0 the 'variable' property can be used in the task list. Using the variable property, process variables that exist in the process instance of the task can be shown. A variable property can be configured using the task:variable.firstName notation.

Import and export

The configuration task list columns is included in the case definition import and export by default.