PublishedDocument Object

PublishedDocument Object

This object represents a published document. It is used in export handling scripts. With the help of this object you can use document type and attributes, job properties, and recognition statistics to determine appropriate destination for the document.

Properties

Name Type Description
Attributes Attributes, read-only Document attributes. Attribute values can be used for output file naming. You can include an attribute value to the output file name using the attribute name in angle brackets.
BarcodeText String

Text of the separation barcode. The first found barcode of the specified type is assigned to the variable.

This property value is filled automatically if the "Use barcodes to separate documents" separation method is selected in the settings of the workflow that triggered the script. During separation, the document inherits the property value from the first page. Property values from the rest of the pages will be lost. The text can be used for output file naming. You can include this text in the output file naming scheme using the <Barcode> tag.

The value of this property can be changed using a document separation script.

CustomText String, read-only Custom text assigned to the document during document separation or indexing. The text can be used for output file naming. You can include this text to the output file name using the <CustomText> tag.
DocumentType String, read-only Document type. The document type can be used for output file naming. You can include the document type to the output file name using the <DocumentType> tag.
InputFiles InputFiles, read-only All input files which contain images of the published document.
IsMailAttachedMessageFile Boolean, read-only Indicates that the document contains the body of an attached e-mail message or its attachment.
IsMailBodyFile Boolean, read-only Indicates if the document contains the body of a main e-mail message
JobProperties JobProperties, read-only Represents the job containing the current document.
OutputFormats OutputFormatSettingsCollection, read-only Represents a set of output formats settings.
Statistics Statistics, read-only Document processing statistics.
XmlResultLocation String, read-only Contains the full path to the XML result file.
PagesCount Long, read-only The number of pages in the document.

Methods

Name Parameters Description
LogMessage [in] String - the message which should be written into the Application log. Writes a string into the Application log of the machine where the script is executed.
See also

Creating a Script for Export Handling

20.09.2022 9:27:51

Please leave your feedback about this article

Usage of Cookies. In order to optimize the website functionality and improve your online experience ABBYY uses cookies. You agree to the usage of cookies when you continue using this site. Further details can be found in our Privacy Notice.