Skip to main content
Version: 🚧 Next

PerformClientOutreachV2

Business goal​

This action automatically invites the counterparties of a dossier to provide their information, using a configured flow option. It works with both the INVESTOR_FLOW and the DOSSIER_INFORMATION_EXCHANGE module: the module configured for the FSP determines which counterparties are invited.

PerformClientOutreachV2 supersedes PerformClientOutreach, which only works with the INVESTOR_FLOW module.

Behaviour per module​

Module INVESTOR_FLOW​

  • All responsibles of the dossier (the parties in its responsibility matrix) are invited.
  • The dossier must be in the pending status of its flow configuration. Otherwise the action fails and nobody is invited.
  • The information request is initiated for each responsible: a submission group is created when there is none yet, and the invitation is sent.

This is the same behaviour as PerformClientOutreach.

Module DOSSIER_INFORMATION_EXCHANGE​

  • The information exchange must already exist when the action runs, for example created from the dossier page, through the gateway or by a CSV import. The action only invites; it never creates an information exchange.
  • When the dossier has no pending information exchange, the action fails.
  • All individual counterparties of the current information exchange are invited: the counterparty the exchange was created for, and every other individual counterparty in its flow. Intermediary counterparties are not invited.
  • The dossier does not need to be in its pending status yet. Inviting opens the information exchange: the dossier moves to the pending status of its flow configuration and the information exchange becomes pending.
  • The additional information given when the information exchange was created is kept and included in the invitation.

Both modules​

  • The flow option must be allowed for every counterparty, evaluated with the PARTNER_ADVISOR_RBAC role. When it is not allowed for one of them, or a counterparty lacks the data the flow option needs (such as an e-mail address), the action fails and nobody is invited.
  • A counterparty without a language receives the invitation in the language of the FSP, or the default language of the white label when the FSP has none.

Configuration​

  1. Add the action eu.myharmoney.app.bll.executors.events.ie.PerformClientOutreachV2.
  2. Link this action to the event after which the counterparties should be invited.
  3. Configure the flowOption. The flow option must be configured on the dossier definition. The supported flow option is DIRECT_INVESTOR_MAIL.

Example​

{
  "type": "EVENT",
  "value": "DOSSIER_IN_PROGRESS",
  "className": "eu.myharmoney.app.bll.executors.events.ie.PerformClientOutreachV2",
  "synchronous": false,
  "enabled": true,
  "settings": {
    "flowOption": "DIRECT_INVESTOR_MAIL"
  }
}

Settings​

Settings Configuration

Examples

Migrating from PerformClientOutreach​

The settings of both actions are identical, so the migration only changes the class name.

  1. While the FSP still uses the INVESTOR_FLOW module, replace the className eu.myharmoney.app.bll.executors.events.PerformClientOutreach by eu.myharmoney.app.bll.executors.events.ie.PerformClientOutreachV2. The settings stay unchanged and the behaviour is the same.
  2. Switch the FSP from the INVESTOR_FLOW module to the DOSSIER_INFORMATION_EXCHANGE module. The action needs no further change.
  3. Make sure the information exchange is created before the event that triggers the action is fired.