File Transformers
The File Transformer Services are standalone services responsible to provide a way for users to download plans and descriptions in various file formats. So, their role is to "transform" these data structures to these formats.
There are currently three file transformer services implemented and integrated:
| Service | Supported Schema Version(s) | Docker Image | Notes |
|---|---|---|---|
| DOCX File Transformer | - | file-transformer-docx | PDF files and Word documents. Uses DOCX template placeholders — see the template reference. |
| RDA File Transformer | 1.2 | file-transformer-rda-json | JSON files following the RDA specification. See the semantics reference. |
| RAiD File Transformer | 1.6 – 1.6.3 | file-transformer-raid-json | JSON files following the RAiD specification. See the semantics reference. |
note
You can create your own file transformer. More details here.
Plugin Reference
Each file transformer resolves output fields in its own way. The following pages document, for each plugin, what inputs map to what outputs:
- DOCX — template reference — placeholder codes recognised in a custom DOCX 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