Actions
Business goal​
Actions are used to trigger specific behavior in the system. Actions are triggered by certain triggers. A trigger can be a dossier that is created, a dossier that has changed statuses, a document that is created, etc.
Configuration​
Each action has the following properties:
type: See Action types .value: This defines the automation identifier (depending on the chosen type).className: The class that contains the implementation. See also Action classes.synchronous:true→ Immediately execute the action(s) as soon as the event is thrownfalse→ Put the action(s) in the queue to be processed asynchronously
remove: Only useful to remove an existing (eg hardcoded) action → use with caution, because it will be removed in future versions!settings: See Action Settings.
Action types​
Each action has a specific type. Each type has it's corresponding enum value. The enum value is used as an initial filter on when an action is triggered.
| Type | Abbreviation | Description | Enum value |
|---|---|---|---|
| Event | EVENT | Triggered when an event occurs. | The event type that triggers the action. |
| Dossier status transition | DST | Triggered when the dossier status changes. | The status a dossier is transitioned to on which the action is triggered. Preferably use the EVENT action type if possible |
| Ubo status transition | UST | Triggered when the UBO status changes. | The status a UBO is transitioned to on which the action is triggered. |
| Identity status transition | IDT | Triggered when the identity status changes. | The status an identity is transitioned to on which the action is triggered. |
Action Settings​
Each action has a set of general settings that can be configured. However, not every setting is applicable to every action.
dossierFilter: The action will only be executed when the dossier matches this filter , see Dossier FilterdossierFilterRbaResults: Additional filter on the RBA results of the dossier.invertDossierFilter: Inverts the dossier filter
Following settings are only available for actions of type EVENT:
failOnError: Used to define the error handling when an exception occurs during execution of an action (true/false)reportFailure: Used to define if an error should be reported (mail) when an exception occurs (true/false)retryFailure: Used to define if an action should be retried when it fails. If not specified, the retry mechanism depends on the type of error. For internal errors it isfalse, for otherstrue
FYI The retry mechanism in using a standard back off interval of 30/60/120 seconds with an additional randomness between 1 and 1.2 (so 100% to 120%).
Action Settings - schema​
Settings Configuration
Examples
Event types​
The application has some predefined event types that can be used to trigger actions. Here is a list of the available event types:
| Type | Description |
|---|---|
| GATEWAY_DOSSIER_CREATED | Trigger actions (most likely in the background) after a dossier is created via the GATEWAY. |
| GATEWAY_DOSSIER_UPDATED | Trigger actions (most likely in the background) after a dossier is updated via the GATEWAY. |
| UI_DOSSIER_CREATED | Trigger actions (most likely in the background) after a dossier is created. |
| CSV_DOSSIER_CREATED | Trigger actions (most likely in the background) after a dossier is created via CSV. |
| CSV_DOSSIER_UPDATED | Trigger actions (most likely in the background) after a dossier is updated via CSV. |
| DOCUMENT_CREATED | Trigger actions (most likely in the background) after a document is created. |
| DOCUMENT_UPDATED | Trigger actions (most likely in the background) after a document is updated. |
| DOCUMENT_ASSESSED | Trigger actions (most likely in the background) after a document is assessed. |
| DOSSIER_STATUS_CHANGED | Trigger actions (most likely in the background) after a dossier status changed. |
| DOSSIER_OPEN | Trigger actions (most likely in the background) after a dossier is opened. |
| DOSSIER_REVIEW_DATA | Trigger actions (most likely in the background) after a dossier's review data is updated. |
| DOSSIER_IN_PROGRESS | Trigger actions (most likely in the background) after a dossier is in progress. |
| DOSSIER_PENDING_INFORMATION_EXCHANGE | Trigger actions (most likely in the background) after a dossier is pending information exchange. |
| DOSSIER_SUBMITTED | Trigger actions (most likely in the background) after a dossier is submitted. |
| DOSSIER_INVESTOR_REJECTED | Trigger actions (most likely in the background) after a dossier is rejected by an investor. |
| DOSSIER_READY_FOR_REVIEW | Trigger actions (most likely in the background) after a dossier is ready for review. |
| DOSSIER_REVIEWED | Trigger actions (most likely in the background) after a dossier is reviewed. |
| DOSSIER_AT_BACK_OFFICE | Trigger actions (most likely in the background) after a dossier is sent to back-office (at back office). |
| DOSSIER_ACCEPTED | Trigger actions (most likely in the background) after a dossier is accepted. |
| DOSSIER_INPUT_NEEDED | Trigger actions (most likely in the background) after a dossier is set in the corresponding status. |
| DOSSIER_READY_FOR_COMPLIANCE_REVIEW | Trigger actions (most likely in the background) after a dossier is set in the corresponding status. |
| DOSSIER_REVIEWED_BY_COMPLIANCE | Trigger actions (most likely in the background) after a dossier is set in the corresponding status. |
| DOSSIER_TO_ANALYZE | Trigger actions (most likely in the background) after a dossier is set in the corresponding status. |
| DOSSIER_ANALYZED | Trigger actions (most likely in the background) after a dossier is set in the corresponding status. |
| DOSSIER_TO_VERIFY_BY_ANALYST | Trigger actions (most likely in the background) after a dossier is set in the corresponding status. |
| DOSSIER_TO_REWORK | Trigger actions (most likely in the background) after a dossier is set in the corresponding status. |
| DOSSIER_VERIFIED_BY_ANALYST | Trigger actions (most likely in the background) after a dossier is set in the corresponding status. |
| DOSSIER_TO_VERIFY_BY_COMPLIANCE | Trigger actions (most likely in the background) after a dossier is set in the corresponding status. |
| DOSSIER_VERIFIED_BY_COMPLIANCE | Trigger actions (most likely in the background) after a dossier is set in the corresponding status. |
| DOSSIER_ON_HOLD | Trigger actions (most likely in the background) after a dossier is set in the corresponding status. |
| DOSSIER_ASSIGNED | Trigger actions (most likely in the background) after a dossier is set in the corresponding status. |
| DOSSIER_PRE_ANALYZED | Trigger actions (most likely in the background) after a dossier is set in the corresponding status. |
| DOSSIER_SENT_TO_CLIENT | Trigger actions (most likely in the background) after a dossier is set in the corresponding status. |
| DOSSIER_ANALYSIS | Trigger actions (most likely in the background) after a dossier is set in the corresponding status. |
| DOSSIER_READY_FOR_4EYES | Trigger actions (most likely in the background) after a dossier is set in the corresponding status. |
| DOSSIER_REVIEWED_BY_4EYES | Trigger actions (most likely in the background) after a dossier is set in the corresponding status. |
| DOSSIER_APPROVED | Trigger actions (most likely in the background) after a dossier is approved by the back-office. |
| DOSSIER_DONE | Trigger actions (most likely in the background) after a dossier is moved to done. |
| DOSSIER_REJECTED | Trigger actions (most likely in the background) after a dossier is rejected by the back-office. |
| DOSSIER_CLOSED | Trigger actions (most likely in the background) after a dossier is closed. |
| DOSSIER_ARCHIVED | Trigger actions (most likely in the background) after a dossier is archived. |
| DOSSIER_COUNTERPARTY_INVITED | Trigger actions (most likely in the background) after a counterparty is invited to complete the information exchange (responsible / intermediary). |
| DOSSIER_INFORMATION_EXCHANGE_COMPLETION_REMINDER | Trigger actions (most likely in the background) at a certain point in time (based on a timestamp defined in the event itself). Triggers a reminder to the counterparty for the information exchange completion. |
| DOSSIER_INFORMATION_EXCHANGE_COMPLETION_REMINDER_SENT | Trigger actions (most likely in the background) at a certain point in time (based on a timestamp defined in the event itself). Triggers a mail to the invitor if a reminder for the information exchange completion is sent. |
| DOSSIER_DOCUMENT_ADDED | Trigger actions (most likely in the background) at a certain point in time (based on a timestamp defined in the event itself). Triggered when a document is added to a dossier. |
| DOSSIER_ASSIGNEE_CHANGED | Trigger actions (most likely in the background) after a dossier's assignee is changed. |
| FRONT_OFFICE_AUTOMATION_FINISHED | The front office automation is finished. |
| BACK_OFFICE_AUTOMATION_FINISHED | The back office automation is finished. |
| FAILED | Thrown when a job for event handling fails. |
| SEND_CALLBACK | Sends a callback |
| API_BALANCE_UPDATE | Request for an update of the dossier balance. |
| FILE_BALANCE_UPDATE (Deprecated) | Should be removed as an option |
| DOSSIER_FILE_UPLOADED | Thrown when a dossier file is uploaded to a file server. Can be used for testing purposes to retrieve and verify the uploaded dossier file. |
| RESCREENING_AUTOMATION | Generic event to define customer-specific logic by linking actions to this event. |
| DUE_DILIGENCE_CHECK | Thrown at the end of a due diligence check or when a parameter result has been updated so additional action can be executed. |
| GENERATE_REPORT_ASYNC | Thrown by a scheduled provider to indicate that a report should be generated asynchronously. |
| REPORT_GENERATED | Thrown when a report is generated (either asynchronously through automation or synchronously through UI). Used to automatically upload the generated report to an SFTP server. |
| ANNUAL_STATEMENT (Deprecated) | Request for fetching the annual statement(s). |
| ADVICE_REQUIRED | Thrown when Advice is required (when submissions are confirmed for all responsibles). |
| FLOW_FINISHED | Thrown when all submissions of a submission group have been signed. |
| DELETE_DOSSIER | Thrown to asynchronously remove a dossier. |
| DELETE_PARTY | Thrown to asynchronously remove a party. |
| EXPORT_DATA | Thrown to asynchronously export data such as dossiers or parties for archival/migration purposes. |