Skip to main content
Version: 🚧 Next

Tasks

🎯 Functional documentation​

Tasks on a dossier enable the FSP-user to have an overview of the necessary tasks to complete on the dossier.

Preconditions​

  • TASKS module is enabled.

⚙️ Configuration​

Tasks are bundled in sections aka task list definitions. The tasks landing page provides an overview of all task list definitions.

  1. Add and/or click on the task list definition you want to configure.
    • in the settings of the definition, you can provide the translation you want the section to have in the UI.
    • under Task definitions we will add the actual task to be completed.
  2. Add and/or click on the task definition you want to configure.
    • in the settings of the definition, you can provide the translation you want the task to have in the UI.
  3. Add the task list definitions to the dossier definition you want to link it to.

Metadata fields​

A task can hold metadata fields (custom fields) on top of its standard fields. Configure them through the field-definition provider of the task. On the tasks card of a dossier, they are shown on the task itself when the FSP user expands it, and they can be filled in when the user edits the task. All field types are supported, and field-level interdependencies apply as they do elsewhere: a metadata field can be made visible/hidden or required/optional based on the value of another field on the task.

Task metadata is also available on the API Gateway, on the tasks of a dossier.

note

Task metadata is not available in the PDF documents, in the flow, or through the CSV import.

Additional️ configuration options​

You can configure actions for tasks to appear in a dedicated status. Example

{
  "type": "EVENT",
  "value": "DOSSIER_SUBMITTED",
  "className": "eu.myharmoney.app.bll.executors.events.AddTaskToDossier",
  "synchronous": false,
  "enabled": true,
  "remove": false,
  "settings": {
    "tasks": [
       "TASK_IDENTIFIER"
   ]
  }
}

You can also enable validations to require certain tasks to be completed before a specific status transition. Example

{
  "SUBMITTED": [
   {
    "to": "READY_FOR_REVIEW",
    "validations": [
      {
        "className": "eu.myharmoney.app.bll.validators.dossierstatustransition.DossierTasksCompleted",
        "enabled": true
      }
    ]
   }
 ]
}

Reference​

The import envelope of a task list definition. This is the shape of the JSON file that importing a task list definition accepts and that exporting one produces.

TaskListDefinitionExportDTO​

Settings Configuration

Examples