This chapter describes the common Capture classes that pertain to the Recognition Processor and the Import Processor.
This is in addition to the classes that you can use to design the Recognition Processor scripts and the Import Processor scripts. For more information on the Recognition Processor and Import Processor classes, see Section 4.2 and Section 5.5.
The following are the classes that pertain to the Recognition Processor and the Import Processor:
The BatchEntity class represents a batch within a Capture Workspace. A batch is a collection of batch items and documents.
| Property | Type | Description |
|---|---|---|
| itemID | String | The unique batch item identifier. |
| id | Integer | The unique batch ID. |
| state | Integer | The current state of the batch, which will be one of the following values:
|
| errorMessage | String | An error message related to processing failure. |
| status | BatchStatusEntity | A reference to a BatchStatusEntity that represents the current status of the batch. |
| priority | Integer | The current priority value of the batch. |
| itemCount | Integer | The number of items in the batch. |
| userID | String | The user id of the user that created the batch. |
| workstationID | String | The host name of the system that created the batch. |
| comment | byte[] | A comment or note regarding the batch. |
| dateTime | Date | The date and time the batch was created. |
| workspace | CaptureWorkspaceEntity | A reference to the workspace to which the batch belongs. |
| documents | List<DocumentEntity> | A list of DocumentEntity references that exist in the batch. |
| items | List<BatchItemEntity> | A list of batch items associated with the batch. |
| lastModifiedDateTime | Date | The date and time the batch was last modified. |
| lastModifiedUserID | String | The ID of the user that last modified the batch. |
| batchName | String | The name of the batch. |
The BatchItemEntity class represents a batch item within a batch. BatchItemEntities are associated with DocumentPageEntities that are used to form documents within a batch.
| Property | Type | Description |
|---|---|---|
| itemID | String | The unique batch item identifier. |
| sourceFileName | String | The original file name of the item. Useful if the item is an imported file. |
| sourceFormat | String | For non–image files this is generally the file extension (DOC, XLS, PDF). For image files, the value will be empty. |
| patchCode | Integer | A patch code value if a patch code was read. |
| barcodeCount | Integer | The number of barcodes that were read during barcode detection. |
| linkCount | Integer | The number of documents the item is linked to. |
| fileLength | Long | The size of the item in bytes. |
| barcodes | String[] | An array of strings that represent barcode values that were read during barcode recognition. |
The BatchLockEntity class represents a lock on a batch. The lock is used to prevent users and processors from accessing the same batch simultaneously.
| Property | Type | Description |
|---|---|---|
| id | String | The unique batch lock ID. |
| batch | BatchEntity | A reference to the locked batch. |
| batchName | String | The name of the batch to which the batch lock is applied. |
| workspace | CaptureWorkspaceEntity | A reference to the workspace to which the batch belongs. |
| workspaceName | String | The name of the workspace to which the batch belongs. |
| lockDate | Date | The date that the batch lock was created. |
| userID | String | The ID of the user who locked the batch. |
| computerName | String | The name of the computer used to lock the batch. |
| processID | String | The process ID used to lock the batch. |
The BatchStatusEntity class defines a batch status within a Capture Workspace. Batch statuses may be associated with batches within a Capture Workspace.
| Property | Type | Description |
|---|---|---|
| statusID | String | The unique identifier of the status. |
| value | String | The text value of the status. |
| workspaceEntity | CaptureWorkspaceEntity | A reference to the workspace where the status is defined. |
The CaptureWorkspaceEntity class represents a workspace in the Capture system. A workspace defines metadata, document profiles, and batch statuses.
| Property | Type | Description |
|---|---|---|
| workspaceID | String | The unique workspace identifier. |
| workspaceName | String | The name of the workspace. |
| description | String | A description of the workspace. |
| dateCreated | Date | The date the workspace was created. |
| dateLastModified | Date | The date the workspace was last modified. |
| createdBy | String | The user ID of the user that created the workspace. |
| lastModifiedBy | String | The user ID of the user that last modified the workspace. |
| indexDefinitions | List<IndexDefinitionEntity> | A list of index definition entities that have been defined in the workspace. |
| statuses | List<BatchStatusEntity> | A list of batch statuses defined in the workspace. |
| documentTypes | List<DocumentTypeEntity> | A list of document profiles that have been defined in the workspace. |
The DBSearchResults class contains information returned from executing a database lookup. It contains a list of the rows returned as well as a list of the search field information describing the columns of the rows.
| Property | Type | Description |
|---|---|---|
| resultsList | List<DbSearchResultRow> | A list of rows from the database lookup. |
| fieldInfoList | List<DbSearchFieldInfo> | A list of search field information describing the columns used in the database lookup. |
The DbSearchResultRow class represents one row result returned from a database lookup.
| Property | Type | Description |
|---|---|---|
| results | List<String> | A list of string values associated with one search result. The values in the list will be in the same order in which the return fields are defined. |
The DbSearchFieldInfo class represents the field information describing the results of a database lookup.
| Property | Type | Description |
|---|---|---|
| captureIndexDefID | String | The metadata field ID. |
| dbColumnName | String | The name of the database column. |
| dbColumnType | Integer | The type of the database column. |
| captureFieldType | Integer | The data type of the metadata field. |
The DocumentEntity class represents a document within a batch. A document consists of a collection of DocumentPageEntity references which refer to BatchItemEntity references.
| Property | Type | Description |
|---|---|---|
| documentID | String | A value that uniquely identifies the document. |
| documentTitle | String | The document title. |
| documentNumber | Integer | The document's position within the batch. |
| batchEntity | BatchEntity | A reference to the batch to which the document belongs. |
| documentPages | List<DocumentPageEntity> | A list of document page entity references that make up the document. |
| documentType | DocumentTypeEntity | A reference to the documentType associated with the document. |
| indexes | List<IndexValue> | A list of index values for the document. |
| documentState | Integer | The current state of the document which will be one of the following values:
|
| lastModifiedDateTime | Date | The date and time the document was last modified. |
| lastModifiedUserID | String | The ID of the user that last modified the document. |
The DocumentPageEntity class represents a page within a document. It refers to a BatchItemEntity within a batch and contains a page number that represents the page's position within the parent document.
| Property | Type | Description |
|---|---|---|
| docPageID | String | A value that uniquely identifies the document page. |
| batchItemEntity | BatchItemEntity | A reference to the BatchItemEntity associated with the document page. |
| documentEntity | DocumentEntity | A reference to the DocumentEntity to which the page belongs. |
| pageNumber | int | The position of the page within a document. |
The DocumentTypeEntity class defines a document profile within a Capture Workspace. A DocumentTypeEntity consists of a name, description, and list of index definition fields that pertain to the document profile.
| Property | Type | Description |
|---|---|---|
| docTypeID | String | The unique identifier of the document profile. |
| docTypeName | String | The name of the document profile. |
| description | String | The description of the document type. |
| workspaceEntity | CaptureWorkspaceEntity | The parent workspace to which the document profile belongs. |
| fields | List<IndexDefinitionEntity> | A list of IndexFieldDefinitionEntity object references that are associated with the document profile. |
The IndexDefinitionEntity represents an index definition defined in a workspace. An index definition defines a metadata field that can be used for input.
| Property | Type | Description |
|---|---|---|
| indexFieldID | String | The unique identifier of the index definition. |
| fieldName | String | The name of the field. |
| workspaceEntity | CaptureWorkspaceEntity | A reference to the parent workspace where the field is defined. |
| dataType | Integer | The data type of the field.
|
| maxLength | Integer | The maximum number of characters the field will hold. |
| minValue | Float | The minimum value allowed. |
| maxValue | Float | The maximum value allowed. |
| required | Boolean | True if the field is required to have a value at commit time, false if it is not. The default value is False. |
| defaultValue | String | A default value for the field. |
| inputMask | String | The input mask defined for the field. |
| displayFormat | String | The field's display format. |
| locked | Boolean | Indicates if the field is locked for input. |
| autoPopulate | Integer | Includes the following:
|
| validationExpression | String | The regular expression string used to validate the field value. |
The IndexValue class represents the value of an index field for a metadata field in a document. It contains a display value that is presented to the user as well as a fieldValue which will be used at commit time.
| Property | Type | Description |
|---|---|---|
| fieldID | String | The unique identifier of the IndexDefinitionEntity that is associated with the index value. |
| fieldValue | String | The value of the field that will be used when the document is committed. |
| displayValue | String | A value that is presented to the user. This value will not be used at commit time. |