Adding custom record export to Boomega

May 13, 2022 ยท View on GitHub

The Record Export API is unstable and a lot of refactoring needs to be done. For this reason, this guide is not finished.

Boomega allows users to export their Records into some output formats (like JSON and Excel spreadsheet). The options are expandable by contributing your own record-exporters to the project or by writing plugins.

Prerequisites

These apply to you only if you're contributing to the core project:

The RecordExporter interface

The entities directly responsible for exporting records into a specific format are RecordExporters.

Register your RecordExporter

This section applies to you only if you contribute to the core project.

After you've created your record-exporter implementation you have to register it's full class-name in the internal_exporters.json config file.

Like this:

[
  ...,
  "com.dansoftware.boomega.export.MyExporter"
]

See the plugin guide if you want to write record exporter plugins.