Skip to main content
Version: 🚧 Next

Document Management in the flow

🎯 Functional documentation​

To configure which documents should be triggered in the flow based on specific rules, Harmoney supports document management in the flow steps related to documents:

  • PARTY_IDENTITY_DOCUMENTS
  • PARTY_DOCUMENTS
  • DOSSIER_DOCUMENTS

The documents of these flow steps can also be previewed alongside the flow steps through the split view, scoped to the responsibility the active step belongs to.

⚙️ Configuration​

The following settings can be applied for the flow steps as defined above:

Basic settings​

Settings Configuration

Examples

Dynamic card configuration​

Settings Configuration

Examples

optionalWhen, requiredWhen and readOnlyWhen take a condition. Pick its operator based on the type of the field path: see Choosing an operator.

Use contains for MULTIPLESELECT questions

The answer of a MULTIPLESELECT question is a list, even when only one option is selected. equals and in never match it, so a card configured with them is silently never shown or required. Use contains, and combine several contains with or (any of the options) or and (all of the options).

Require a payslip when SALARY is one of the selected sources of funds
{
  "cards": {
    "PAYSLIP": {
      "requiredWhen": {
        "contains": { "fieldPath": "dossier.questions.SOURCES_OF_FUNDS", "value": "SALARY" }
      }
    }
  }
}

Assessment​

  • assessment: defines the assessment coming from the document assessment provider.
    • enabled: true/false
    • types: defines the document types.
    • defaultValue: defines the value of the system assessment when there is no assessment value available yet.
    • positiveAssessments: defines a list of assessment values that can be declared as ‘positive’/'valid'.
    • statusMap: defines the status of the document based on the assessment value. Depending on the status (DONE, WARNING, ISSUE) a warning or blocking message will be shown.
    • providerIdentifier: the identifier of the document assessment provider. Example
{
 "assessment": {
  "defaultValue": "TO_REVIEW",
  "enabled": true,
  "positiveAssessments": [
    "VALID"
  ],
  "providerIdentifier": "Provider - Document Assessment",
  "statusMap": {
   "NON_VALID": "ISSUE",
   "TO_REVIEW": "WARNING",
   "VALID": "DONE"
  },
  "types": {
   "DOCUMENT_TYPE_ID": { }
    }
  }
}