Skip to main content
Version: 19

Update Dossier and Client Metadata

Business goal​

This action allows you to programmatically update metadata (key-value pairs) on a dossier and/or its main client.

Configuration​

  1. Add the action UpdateDossierClientData.
  2. Link this action to an appropriate event or status transition (e.g., a specific dossier status change).
  3. Configure the settings (see below) to define which metadata keys to update and their corresponding values.

Settings​

Required Settings​

  • metadataUpdates : The list of metadata updates to apply. Each entry defines how a specific piece of metadata should be updated and requires the following properties:
    • target: Specifies the target of the update (DOSSIER or CLIENT).
    • key: The case-sensitive string representing the metadata field key to update.
    • value: The new value to set.
    • type: The data type to cast the value to before storing it. Supported types are STRING, BOOLEAN, DECIMAL, and DATE.
info

When defining the metadataUpdates, ensure that the value can be successfully converted to the selected type. For BOOLEAN, use 'true' or 'false'. For DECIMAL, use a valid number format (e.g., '123.45'). For DATE, use the standard ISO format (e.g., '2024-12-31'). If a value cannot be converted, the settings will be considered invalid.

Optional Settings​

  • dossierFilter: (Optional) If provided, the metadata updates will be applied only if the dossier satisfies the filter criteria.
  • associatedPartyFilter : Defines an additional optional filter that must match before the metadata updates are applied. This allows you to apply updates only when there are associated parties matching specific criteria.
  • failOnError : Marks the event as failed and stops subsequent actions when an exception occurs.
  • reportFailure : Sends an error report (e.g., email) when the action ends in failure.
  • retryFailure : Retries the action automatically when it fails.

Settings Configuration

Examples