Skip to content

Commit 0f7175a

Browse files
authored
Update README.md
1 parent 0bcd799 commit 0f7175a

File tree

1 file changed

+11
-0
lines changed

1 file changed

+11
-0
lines changed

README.md

Lines changed: 11 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -155,3 +155,14 @@ print('Unix time from Java: ' + str(System.currentTimeMillis()))
155155
```
156156

157157
See also the documentation from [Jython](https://www.jython.org/) and the [DDI-PDF](/examples/ddi-pdf/transformer.py) example for how it is used in practice.
158+
159+
## Configuration
160+
161+
The configuration file (config.json) for the exporter can contain the following fields:
162+
- `formatName` (default: **transformer_json**): The name of the format it creates. If this format is already provided by a built-in exporter, this Exporter will override the built-in one. (Note that exports are cached, so existing metadata export files are not updated immediately.)
163+
- `displayName` (default: **Transformer example**): The display name shown in the UI.
164+
- `harvestable` (default: **false**): Whether the exported format should be available as an option for Harvesting.
165+
- `availableToUsers` (default: **true**): Whether the exported format should be available for download in the UI and API.
166+
- `mediaType` (default: **transformer_json**): Defines the mime type of the exported format - used when metadata is downloaded, i.e. to trigger an appropriate viewer in the user's browser.
167+
- `prerequisiteFormatName` (default: **null**): Defines the name of the export format that will be used as input for this exporter (if left null or omitted, the default input will be used).
168+
- `includeDefaultInputWithPrerequisiteInput` (default: **false**): Whether the default input should be included when prerequisite input is requested. When set to yes, the default input will be added in `defaultInputFromDataProvider` field inside the prerequisite input JSON that is specified as input for this transformer.

0 commit comments

Comments
 (0)