Skip to main content
DocumentExportResult is a JavaScript object that provides access to the document export results. Before a Custom activity is run or before the script in Output (External system) is executed, documents received by the activity for processing are exported to formats like JSON or PDF. Access to these exported documents can be obtained by using the Exports property of the Document object. Exported documents can be used in requests sent to third-party systems.

Properties

NameTypeDescription
FileNamestring, read-onlyThe name of the file.
ExportFormatExportFormat, read-onlyAn available file export format.
`Properties[“PageIndex”]string, read-onlyPage sequence number (for exporting files in JPG format).

Methods

NameDescription
ToJson();Returns the export results in string format. Works only for JSON formats (JSON, FieldsJson, OcrJson).

ResultFiles

The read-only collection of DocumentExportResult objects that allows the result files to be filtered by format.

Methods

NameDescription
GetByFormat(ExportFormat format);Returns the DocumentExportResult object that contains only the document in the specified export format.