Skip to main content
Version: 🚧 Next

Dossiers (FSP)

Business goal​

Expose the dossier list to front-office users and let administrators configure custom bulk actions that operate on the dossiers the user has selected.

Functional documentation​

Bulk actions​

A bulk action is a configurable operation that runs against the dossiers a front-office user selected on the dossier list. Each configured action shows up as a menu item in the dossier list UI for users holding the bulk-action permission, and for a role-restricted action only for users holding one of its roles.

Three action types are supported:

TypeWhat it does
STATUS_UPDATEMoves every selected dossier to a target status. Configured pre-validations and post-transition actions always run.
FIELD_UPDATEUpdates a configured set of dossier fields with values entered by the user before triggering.
TRIGGER_EVENTFires a configured event type per selected dossier so downstream automation can take over.

Each action emits one back-end event per dossier and the events are processed asynchronously. Progress is reported to the user over a WebSocket: one step per dossier with per-dossier success or failure information.

Common settings​

  • identifier — required, unique within the module. Used as the translation key suffix (BACK_END.VALUES.BULK_ACTIONS.<identifier>.label) and to reference the action when triggering.
  • forRoles — optional set of role identifiers this action is restricted to. Every identifier must exist and hold the bulk-action permission, otherwise the settings are rejected. Omit to allow every role holding that permission. Not supported on TRIGGER_EVENT.

Restricting an action to roles also restricts which dossiers it runs on: each dossier is checked against what those roles grant when the action is processed, so dossiers outside their scope are skipped and reported as failed. This is re-checked while the action runs, so revoking a role in the meantime takes effect immediately.

Status update​

{
  "type": "STATUS_UPDATE",
  "identifier": "close-dossiers",
  "forRoles": ["PARTNER_MANAGER"],
  "allowedStatuses": ["CLOSED"]
}

allowedStatuses constrains which target statuses the user can pick. When omitted, the user can pick any status the configured dossier-status transitions allow.

Field update​

{
  "type": "FIELD_UPDATE",
  "identifier": "reassign-owner",
  "fields": [
    { "path": "owner" },
    { "path": "assignee" }
  ]
}

fields lists the field paths the user is allowed to update for each selected dossier. The schema-driven editor in the admin UI auto-completes valid paths.

Trigger event​

{
  "type": "TRIGGER_EVENT",
  "identifier": "force-re-run-checks",
  "event": "DOSSIER_RBA_RECALCULATE_REQUESTED"
}

event is the name of the EventType fired per selected dossier. Any event handler configured for that type runs as part of the per-dossier job. This type does not support forRoles, since the actions handling the event are unaware of the bulk action they were triggered by.

Status transition confirmation​

By default the user confirms every dossier status transition in a modal before it runs. Set skipStatusTransitionConfirmation to true to run a transition as soon as the user picks it, which saves a click per transition for FSPs handling many dossiers.

The optional status comment (externalDescription) is skipped along with the modal. Only when that comment is required does the modal stay, since submitting it is already the explicit confirmation. On the back office, the setting of the back office's own FSP applies.

{
  "skipStatusTransitionConfirmation": true
}

Configuration​

Enable the FINANCIAL_SP_DOSSIERS module on the FSP definition, then add bulk actions under the bulkActions list in the module settings.

Settings Configuration

Examples