NiFi Ingest 25.3
NiFi Ingest

# WriteDocument

Generates new FlowFiles with the document in IDX, XML, or JSON format. The processor can optionally write documents to a file on disk.

## Properties

Name | Default Value | Description
--- | --- | ---
IDOL License Service |  | An IdolLicenseServiceImpl that provides a way to communicate with a Knowledge Discovery License Server.
Format | IDX | The format in which to write the document. Specify IDX, XML, or JSON.
IDX - Write XML Safe Field Values | false | Some control characters cannot be represented in XML format because they are forbidden by the XML specification. When you set this parameter to `TRUE`, characters in document fields that are forbidden in XML are replaced with spaces. This parameter applies only when you write documents in IDX format. When you write documents in XML format, the forbidden characters are always replaced by spaces.
File in which to write the document |  | The path of the file in which to write the document.
Archive Directory |  | The directory in which to save archived files (when the file you specify reaches the maximum size it is archived).
Max file size in bytes before archiving |  | The size above which the file is archived.

## Relationships

Name | Description
--- | ---
failure | FlowFiles from which there were errors.
original | FlowFiles that were processed successfully.
written | New FlowFiles with a representation of the document in the chosen format.

Copyright 2018-2025 Open Text
Version 25.3 | Last updated July 2025

Send documentation feedback

Close

Send documentation feedback

To send feedback using your default email client, open an email window.

Otherwise, send your feedback and the information below to MFI-swpdl.idoldocsfeedback@opentext.com.

We appreciate your feedback!

Product: Knowledge Discovery NiFi Ingest 25.3

Topic Title: WriteDocument