Information Request Scheduled Provider

Latest

🎯 Functional documentation

This provider is designed to periodically request additional information for a selection of dossiers.

This V4 version supports both module INVESTOR_FLOW and module DOSSIER_INFORMATION_EXCHANGE. Its settings and the generated CSV are the same as V3, so switching from V3 only requires changing the implementation class.

Functionally, the provider performs the following steps:

1. It retrieves dossiers belonging to the configured Financial Service Providers (SUPPORTED_FSP). The selection can be further refined using an optional dossier filter (DOSSIER_FILTER). By default, it retrieves dossiers with the status OPEN.
2. Then based on the configured flow option (FLOW_OPTION), it generates a unique, secure invitation URL or Code for each counterparty to invite. Who is invited depends on the module that applies to the dossier (see below).
3. A CSV file is generated containing the columns listed in COLUMNS, in the configured order, for the selected dossiers and their invited counterparties.
4. Finally, this CSV file is uploaded using a pre-configured ftp provider.

Module INVESTOR_FLOW

Every responsible person associated with the dossier is invited.

Module DOSSIER_INFORMATION_EXCHANGE

The provider invites the counterparty of the current information exchange of the dossier.

• The information exchange must already exist before the provider runs. The provider never creates or recreates an information exchange, and never cancels one.
• Only an information exchange with status CREATED or PENDING is invited. Its counterparty must be an individual.
• For an information exchange in a final state (e.g. COMPLETED), or when the dossier has no current information exchange, nothing happens: the dossier is exported without invitation URL or Code. To start a new round, create a new information exchange first.
• The additional information of the information exchange is kept.

⚙️ Configuration

• Implementation class: InformationRequestV4ScheduledProvider

Settings Configuration

Examples

Version 3

🎯 Functional documentation

This provider is designed to periodically request additional information for a selection of dossiers.

Note: This version only supports module INVESTOR_FLOW. Use the V4 version: InformationRequestV4ScheduledProvider.

This V3 version builds on V2 by exposing the CSV column set as a configurable, ordered list, so each client can tailor the export to its own consumer.

Functionally, the provider performs the following steps:

1. It retrieves dossiers belonging to the configured Financial Service Providers (SUPPORTED_FSP). The selection can be further refined using an optional dossier filter (DOSSIER_FILTER). By default, it retrieves dossiers with the status OPEN.
2. Then based on the configured flow option (FLOW_OPTION), it generates a unique, secure invitation URL or Code for each responsible person associated with the dossier.
3. A CSV file is generated containing the columns listed in COLUMNS, in the configured order, for the selected dossiers and their responsible parties.
4. Finally, this CSV file is uploaded using a pre-configured ftp provider.

⚙️ Configuration

• Implementation class: InformationRequestV3ScheduledProvider

Settings Configuration

Examples

Version 2

🎯 Functional documentation

This provider is designed to periodically request additional information for a selection of dossiers.

This V2 version has been introduced to support a configurable flow option for the client outreach process.

Functionally, the provider performs the following steps:

1. It retrieves dossiers belonging to the configured Financial Service Providers (SUPPORTED_FSP). The selection can be further refined using an optional dossier filter (DOSSIER_FILTER). By default, it retrieves dossiers with the status OPEN.
2. Then based on configured flow option via setting, it generates a unique, secure invitation URL or Code for each responsible person associated with the dossier.
3. A CSV file is generated containing the details of the selected dossiers and the unique outreach URLs or Codes for their responsible parties.
4. Finally, this CSV file is uploaded using a pre-configured ftp provider.

Note: For configurable CSV columns and module DOSSIER_INFORMATION_EXCHANGE, use the V4 version: InformationRequestV4ScheduledProvider.

⚙️ Configuration

• Implementation class: InformationRequestV2ScheduledProvider

Settings

Required parameters:

• ABSTRACT_FILE_TRANSFER_PROVIDER: The identifier of an existing FTP Provider configuration. This provider will be used to handle the upload of the generated CSV file.
• SUPPORTED_FSP: A comma-separated list of Financial Service Provider (FSP) IDs for which the information request needs to be executed.
• SYSTEM_USER: The ID of the system user that will be linked to the performed actions, such as changing the dossier status and logging events.
• FLOW_OPTION : Configures the flow option used for client outreach. Currently, GENERATE_URL, GENERATE_CODE options are supported.

Optional parameters

• CRON_SCHEDULE: Determines the periodic interval to run the provider. When not provided, the provider can only be triggered manually via the admin UI: organizations > org x > triggers.
• DOSSIER_FILTER: A JSON object that specifies filter criteria to select a specific subset of dossiers. If omitted, the provider will select all dossiers with the status OPEN.
• CSV_DELIMITER : Configures the CSV delimiter used for CSV file generation.

Example

Automation Provider

{
    "ABSTRACT_FILE_TRANSFER_PROVIDER": "FILE_TRANSFER - Generated Reports - <client>",
    "CRON_SCHEDULE": "0 16 * * 7",
    "CSV_DELIMITER": "COMMA",
    "DOSSIER_FILTER": {
        "status": [
            "OPEN"
        ]
    },
    "SUPPORTED_FSP": "$vault{<client>_SUPPORTED_FSP}",
    "SYSTEM_USER": "$vault{<client>_SYSTEM_USER}",
    "FLOW_OPTION": "GENERATE_URL"
}