Skip to main content
Version: 🚧 Next

Data Export

🎯 Functional documentation​

A data export provider can be used to bulk export dossiers and parties. For each data object (dossier, party, …) that is eligible for export, the provider will create an event.

The export itself is handled by configuring a custom action linked to this export event.

For dossier exports, existing dossier summary snapshots are also included. The exported dossier JSON contains the snapshot metadata together with a signed link per stored PDF render, one per language of the white label. When a snapshot has no stored render yet, it is produced during the export.

⚙️ Configuration​

Required parameters:​

  • SUPPORTED_FSP: Only data from these FSP's will be eligible for export.
  • SYSTEM_USER: The user that will be linked to the data export.

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 - Data Export",
    "state": "ACTIVE",
    "healthCheckLevel": 4,
    "implementationClass": "eu.myharmoney.app.providers.scheduled.DataExportScheduledProvider",
    "settings": {
        "CRON_SCHEDULE": "0 16 * * 7",
        "SUPPORTED_FSP": "$vault{<client>_SUPPORTED_FSP}",
        "SYSTEM_USER": "$vault{<client>_SYSTEM_USER}"
    }
}

Configuring the Custom Action​

A custom action needs to be configured to perform the actual export, see ExportData.

The action needs to be configured for every FSP definition!

[
    {
        "type": "EVENT",
        "value": "EXPORT_DATA",
        "className": "eu.myharmoney.app.bll.executors.events.ExportData",
        "synchronous": false,
        "remove": false
    }
]