IDocumentAttributes Object

IDocumentAttributes Object

This object can be used to access a document's attribute collection in indexing scripts and scripts that process export results.

Properties

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

Text of the separation barcode. The first detected 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. The property values from the rest of the pages will be lost. The text can be used for naming output files. 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.

DocumentCustomText String Used to register any custom text. The property value can be filled with a document separation script and a document indexing script. If the value is filled with a document separation script, the property will contain custom text assigned to the first page of the document. The value of the property can be used for naming output files. You can include the text in the output file naming scheme using the <CustomText> tag.
DocumentPages DocumentToIndexPages, read-only Pages of the document.
DocumentStatistics Statistics, read-only Document processing statistics.
DocumentType String Document type. The document type can be used for naming output files. You can include the document type to the output file naming scheme using the <DocumentType> tag.
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.
JobInputFiles InputFiles, read-only All input files which contain images of document pages.
JobProperties JobProperties, read-only Represents the job containing the current document.
VerificationUserName String, read-only Returns the name of a Verification Station operator.
WorkflowName String, read-only Returns the name of a workflow.

Methods

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

Attribute

11/29/2022 5:26:42 PM

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.