Enumerations

Enumerations assign meaningful names to numeric flags. For example, if you want to check if a barcode type is “Code 39”, the code to use should be “BarcodeTypes.Code39” instead of “16” (the numeric flag that signals a barcode 39 type):

if(document.DocumentBarcodes.First().Type == BarcodeTypes.Code39) . . .

The following page describes all enumerations used in the scripting environment.

AlertTypes

These are the alert types that can be assigned for batches, folders, documents, pages and index field values.

NumberNameDescription
0NoneNo alerts apply to the currently selected object.
1DataValidationFailedAlert applied to a data record or data field when data validation fails.
2ExpectedCountIncorrectAlert applied to a batch, folder or document when an expected count validation rule exists and was not successfully validated.
3EmptyBatchItemAlert applied to a batch, folder or document when the object in question contains no children.
4ImageFileMissingAlert applied to a page object when its associated image file does not exist.
5LookupFailedAlert applied to a batch, folder or document when the object in question fails a lookup operation.
6ReIndexValidationFailedAlert applied to a folder or document when one or more fields require a re-index step and the data from the initial and secondary index steps do not match.
7AutoIndexingFailedAlert applied to a batch, folder or document when any auto indexing operation fails to complete successfully.
8QAAutoProcessingValidationFailedAlert applied to a batch, folder, or document when an index data or batch structure validation error occurs during any QA auto processing action.
9MigrationFailedAlert applied to a batch, folder or document when a migration fails while processing the associated object.
10FullTextOCRFailedAlert applied to a document when a full text OCR operation fails on the associated object.
11ClassificationFailed

Alert applied to a document when a classification fails on the associated object.


BarcodeType

This defines barcode types currently supported by PSIcapture.

NumberNameDescription
 ALLAll known barcode types (excepting reserved values and none)
0NoneLogical type used to identify an invalid barcode data structure
1CodabarCodabar
2Reserved1Reserved for future use
4Code128Code 128
8Code32Code 32
16Code39Code 3 of 9
32Code93Code 93
64DataMatrixDataMatrix (2D)
128EAN13EAN-13
256EAN8EAN-8
512Interleaved2of5Interleaved 2 of 5
1024PatchCodePatch Code
2048PDF417PDF-417 (2D)
4096Plus2

Plus 2

8192Plus5Plus 5
16384QRQR Code (2D)
32768Reserved2Reserved for future use
65536Reserved3Reserved for future use
131072Reserved4Reserved for future use
262144UPCAUPC-A
524288UPCEUPC-E
1048576AustralianPostAustralia Post Code
2097152IntelligentMailIntelligent Mail
4194304Reserved5Reserved for future use
8388608Reserved6Reserved for future use
16777216Reserved7Reserved for future use
33554432PostnetPostnet
67108864Rm4sccRoyalMail/UK Post Code/Delivery Point Suffixes
134217728Matrix2Of5Matrix 2 of 5
268435456Datalogic2Of5Datalogic 2 of 5
536870912Industrial2Of5Industrial 2 of 5
1073741824IATA2Of5IATA 2 of 5
2147483648Code2Of5InvertedCode 2 of 5 (Inverted)
4294967296GS1_128GS1-128
8589934592BCD_MatrixBCD Matrix
17179869184AztecAztec (2D)

BatchRestructureActions

Defines the actions that can be taken by a batch restructuring script.

NumberNameDescription
0NoAction 
1

AppendDocument

Append page to document
2NewDocumentCreate a new document
3NewFolderCreate a new folder
4NewFolderAndDocumentCreate a new folder and document
5DropPageRemove the page from the document

DataFieldDataTypes

Defines data field types that are used throughout the application.

NumberName

Description

-1UnknownUnknown type used to identify an invalid data structure.
0TextText field suitable for storing character data up to 255 characters. Values longer than 255 characters may function successfully however it is recommended to use memo fields for values of this length.
1Number

Whole or floating point numbers

2CurrencyLocale specific currency values
3IntegerWhole numbers
4DecimalFloating point numbers
5DateTimeDate/Time values
6BooleanBoolean or yes/no values
7MemoLarge text fields

DataFieldTypes

Defines the types of data fields used by the application.

NumberNameDescription
0BatchDataFieldBatch data field
1DocumentDataFieldDocument data field, which optionally tracks field data across multiple records per document.
2FolderDataFieldFolder data field
3SystemDataFieldValue used to identify internal field types and values.

DataFieldZoneActions

Defines recognition actions used to attach zones to data fields.

NumberNameDescription
-1NoneNo attachment is made between the current data field and an existing zone.
0OCRThe data field will receive the results of an OCR operation on the attached zone.
1ZoomOnlyWhen the data field receives focus, the active viewer (if any) will zoom to the attached zone.
2OMRThe data field will receive the results of an OMR operation on the attached zone.
3ICRThe data field will receive the results of an ICR operation on the attached zone.
4OnDemandOCRICROnlyThe settings on the current data field will not be automatically applied to any zone recognition operation, however they will be used whenever a manual recognition operation is activated.
5MICRThe data field will receive the results of a MICR operation on the attached zone.

DocumentFileSource

Defines values that identify the source of a file added to the document files collection of a document object.

NumberNameDescription
0NotSpecifiedThe source of the file was not specified.
1CaptureThe file was created by the Capture or Auto Import modules.
2OCRThe file was created by an OCR operation.
3Classification

The file was created by the Classification module.


ExpectedCountOperators

Defines operators that can be used when configuring an expected count validation rule.

NumberNameDescription
0EqualsEqual to operator
1LessThanLess than operator
2GreaterThanGreater than operator

ExpectedCountValidationTypes

Defines values that determine how expected count validation rules are applied.

NumberNameDescription
0NoValidationExpected count validation is not enabled.
1ValidateTotalsExpected counts will be validated by totals across the entire batch.
2ValidateByLevelExpected counts will be validated at each level, folder, document, etc.

FlagTypes

Defines flag types that can be applied to batches, folders, documents, pages, etc.

NumberNameDescription
0NoFlagNo flag is applied to the current object.
1ReviewReview flag, typically used to indicate a page, document, folder, etc., that requires additional review before further processing.
2RejectReject flag, used to mark documents or folders for mass reject operations in modules where supported, such as Index or QA.
3DeleteDelete flag, used to mark documents or folders for mass delete operations in modules where supported, such as Index or QA.
4ProcessProcess flag, typically used to mark batch objects for filtering in various operations in QA auto processing.
5SkipSkip flag, used by multiple features in the product to filter out batch objects that should not be processed by the current operation.
6CustomFlag1Custom Flag 1, user definable flag.
7CustomFlag2Custom Flag 2, user definable flag.
8CustomFlag3Custom Flag 3, user definable flag.
9CustomFlag4Custom Flag 4, user definable flag.
10CustomFlag5Custom Flag 5, user definable flag.
99AnyFlagUsed for selection option of Any Flag.

ImageColorTypes

This defines values that indicate the color content of an image.

NumberNameDescription
-1UnknownImage color type has not been determined
0BlackWhiteBlack and white image
1GrayscaleGray image
2ColorColor image

PageFileSource

Defines values that identify the source of an alternate page file added to the alternate page files collection of a page object.

NumberNameDescription
0NotSpecifiedThe source of the file was not specified.
1CaptureThe file was created by the Capture or Auto Import modules.
2ImageProcessingThe file was created by an Image Processing operation.
3OMRThe file was created by an OMR operation.

PatchCodeTypes

Defines the patch codes that are valid for the system.

NumberNameDescription
0UnknownLogical type used to identify an invalid patch code data structure.
1IPatch Type I
2IIPatch Type II
3IIIPatch Type III
4IVPatch Type IV
5VPatch Type V
6TPatch Type T

RedactionTypes

Defines values that determine how redaction operations are applied to images.

NumberNameDescription
0OCRRedaction areas are selected by text content.
1ZoneRedaction areas are pre-defined areas on the image.
2ManualRedaction was applied to an area manually selected by the user.