Export a dossier or a party

Business goal

This action writes a full export of a single dossier or a single party as a JSON file to the platform's own document storage. It is the counterpart of the Data Export scheduled provider, which selects the dossiers and parties to export and raises one event per object; this action performs the export itself.

Use it to hand over a complete data set, for example when a financial service provider leaves the platform or needs its data in a portable format.

note

This action writes to the platform's storage, not to an external file server. To deliver a dossier to a file server, use UploadDossierToFileServer.

Configuration

• Add the action ExportData.
• Link it to the event raised by the Data Export scheduled provider (EXPORT_DATA by default).
• Configure it as an asynchronous EVENT action ("synchronous": false). The action is triggered in bulk and can produce missing PDF renders, so it should never run inline.
• The action must be configured for every FSP definition whose data has to be exported.

Settings

This action has no settings. What ends up in the export is fixed, so the export is always complete and identical in shape for every FSP.

Example

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

Result

Each event exports exactly one object. The payload of the event determines whether a dossier or a party is exported; any other entity type fails the action.

Files are written under the export area of the FSP's document storage:

Content	Location	Filename
Dossier	.../export/dossiers/	D_<identifier>.json
Party	.../export/parties/	P_<identifier>.json

<identifier> is the external identifier of the object when one is set, and its internal identifier otherwise. The export area receives one JSON file per object and nothing else.

A dossier export can produce one thing outside the export area: when a summary snapshot has no stored PDF render for a language of the white label, that render is produced and stored as a document of the snapshot itself, so the exported links cover every language. Those renders stay available afterwards, so a later export of the same dossier does not produce them again.

Signed URLs

The exported JSON does not embed file content. Documents and snapshot PDFs are represented by a contentURL instead: a signed link that is only valid for a limited time (120 minutes).

Make sure the process that collects the export fetches the linked files within that window. Once a link has expired it cannot be refreshed — the object has to be exported again.

Failure handling

The action fails when the dossier or party in the event no longer exists, when the event carries an unsupported entity type, or when a missing snapshot PDF cannot be produced at execution time.

When a snapshot PDF cannot be produced - a PDF service or storage problem - the export is retried by the job mechanism with an increasing delay, and reported as a failed job if the retries run out.

The objects that did export successfully are unaffected, because every object is exported by its own event.