Skip to main content
Version: 17

Field Definition

🎯 Functional documentation​

A field definition provider is an on-demand implementation by the Harmoney team that defines the visibility and behavior of the fields of the Harmoney data-model. For example:

  • Certain fields are by default not visible and can be made visible
  • Fields can be made required
    • Always
    • In certain contexts such as in the information exchange
    • Based on certain conditions such as the value of another field or related data point
    • ...
  • Fields can be made read-only
  • Fields can be restricted to certain values. Most fields in the data-model are free-text fields, but it's often desired to have a drop-down with a limited set of values.
  • ...

Additionally, a field-definition provider also defines custom fields, which are called meta-data fields. Metadata fields are supported in the following entities:

  • Dossier
  • Party
  • External dossier information
  • External party information
  • Ubo
  • Party related parties
  • Dossier related parties
  • FSP

⚙️ Configuration​

A default field definition provider is available if none is configured. If a provider is configured on organization-level, it will be used in all white labels. It's also possible to configure a field-definition provider on white label-level, which will override the organization-level provider.

A template is available to provide the field definition requirements.

Field definitions per associated party type​

Field definitions can be made dependent on a party's associated party type within a dossier — that is, the party's role in the dossier (client, owner, dossier related party, signatory, …) — and not only on its base PartyType (individual, company, …). This makes it possible to apply different visibility, requirement or read-only rules to parties that share the same base type depending on the role they fulfil. For example:

  • industrySector is required for the client party, but optional for a dossier related party;
  • nationality is required for a dossier related party only;
  • certain fields are read-only for owners with a specific uboType.
Where this is configured

This behaviour is configured centrally in the field-definition provider (implemented by the Harmoney team on request) — it is not configured on the flow step or in the flow definition. It applies in the flow context only, and when a party holds multiple roles every matching field definition is applied.

To request it, describe the desired per-role behaviour in the field definitions template. See Field definitions per associated party type for the available filtering granularity (association types, party types, association attributes such as relationType, …) and the scoping and merging rules.