Skip to main content

Documentation Index

Fetch the complete documentation index at: https://docs.abbyy.com/llms.txt

Use this file to discover all available pages before exploring further.

DocumentExportResult is a JavaScript object that provides access to document export results. Before a Custom activity runs — or before an Output (External system) script runs — Vantage exports each document to the formats configured on the activity (for example, JSON or PDF). Access these exported files via Document.Exports to send them to third-party systems.

​
Properties

NameTypeAccessDescription
FileNamestringRead-onlyThe name of the file.
ExportFormatExportFormatRead-onlyThe export format.
Properties["PageIndex"]stringRead-onlyPage sequence number (JPG export only).

​
Methods

​
ToJson

string ToJson();
Returns the export results as a JSON-formatted string. Only works for JSON formats (JSON, FieldsJson, OcrJson).

​
ResultFiles

A read-only collection of DocumentExportResult objects. Filter results by export format.

​
Methods

​
GetByFormat

DocumentExportResult GetByFormat(ExportFormat format);
Returns the DocumentExportResult for the specified export format.

Document

The document currently being processed by the Custom activity.

ExportFormat

Formats available for files exported from a Custom or Output activity.

Custom activity

Extend skills with scripted logic and third-party integrations.

Export to an external system

Send transaction results to a third-party system via a custom script.

Object model

Full JavaScript object reference for Custom activity scripts.