File Transformers
The File Transformer Services are standalone services that transform plans and assets into file formats that users can download.
Three file transformer services are available:
| Service | Supported Schema Version(s) | Docker Image | Notes |
|---|---|---|---|
| DOCX File Transformer | - | opencdmp/file-transformer-docx | PDF files and Word documents, laid out by a Word template and export settings. See managing templates. |
| RDA File Transformer | 1.2 | opencdmp/file-transformer-rda-json | JSON files following the RDA specification. See the semantics reference. |
| RAiD File Transformer | 1.6 – 1.6.3 | opencdmp/file-transformer-raid-json | JSON files following the RAiD specification. See the semantics reference. |
note
You can create your own file transformer; see File transformer plugin development.
Plugin reference
Each file transformer maps plan and asset data to its output in its own way:
- DOCX — managing templates: where templates apply, starting from the built-in template, uploading and previewing
- DOCX — export settings: layout, references, cover facts, wording and watermark settings
- DOCX — template reference: tags, data and styles for writing a custom template
- RDA maDMP JSON — semantics reference: field semantics used by the RDA JSON export
- RAiD JSON — semantics reference: field semantics used by the RAiD JSON export
See also
- File Transformer Configuration - Environment variable reference for deploying file transformer services
- Registering plugin services - Running a file transformer and registering it for the installation or an organisation