Report Generation

Latest

🎯 Functional documentation

A report generation provider can be used to periodically generate a report. After generation, the report can be downloaded via the UI.

In essence, the provider triggers an event GENERATE_REPORT_ASYNC for the configured FSPs which contains the configured report identifier. An action to actually generate the report should be configured to listen to this event. The action will then generate the report and store it in the database.

As mentioned here, an event REPORT_GENERATED is thrown when the report is successfully generated. This event can be used to trigger yet other actions, such as an upload of the report to an FTP server.

⚙️ Configuration

Settings Configuration

Examples

Configuring the Custom Action

The actions need to be configured for every FSP definition! See GenerateReportV2

Version 1

🎯 Functional documentation

A report generation provider can be used to periodically generate a report. After generation, the report can be downloaded via the UI.

In essence, the provider triggers an event GENERATE_REPORT_ASYNC for the configured FSPs which contains the configured report identifier. An action to actually generate the report should be configured to listen to this event. The action will then generate the report and store it in the database.

As mentioned here, an event REPORT_GENERATED is thrown when the report is successfully generated. This event can be used to trigger yet other actions, such as an upload of the report to an FTP server.

⚙️ Configuration

Required parameters:

• SUPPORTED_FSP: A comma-separated list of Financial Service Provider (FSP) IDs for which the report must be generated.
• SYSTEM_USER: The user that will be linked to the report creation.
• REPORT_IDENTIFIER: Identifier of the report that needs to be generated.

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.

Example

{
    "identifier": "Scheduled - Report Generation",
    "state": "ACTIVE",
    "healthCheckLevel": 4,
    "implementationClass": "eu.myharmoney.app.providers.scheduled.ReportGenerationV2ScheduledProvider",
    "settings": {
    "CRON_SCHEDULE": "0 16 * * 7",
    "SUPPORTED_FSP": "20,27",
    "REPORT_IDENTIFIER": "Example Dossier Data Report",
    "SYSTEM_USER": "$vault{<client>_SYSTEM_USER}"
}
}

Configuring the Custom Action

The actions need to be configured for every FSP definition!

[
{
    "type": "EVENT",
    "value": "GENERATE_REPORT_ASYNC",
    "className": "eu.myharmoney.app.bll.executors.events.GenerateReport",
    "synchronous": false,
    "remove": false,
    "settings": {
    "delimiter": "COMMA"
}
}
]

Settings Configuration