Octobox API  4.1.0
Octobox Scripting API
Data Structures | Enumerations
CEScriptObjects Namespace Reference

Data Structures

class  ActivityConditionScriptBase
 Base class for activity conditions. More...
 
class  ActivityPluginBase
 Base class for any plugin activity. More...
 
class  ActivityScriptBase
 Base class for any scripted activity. More...
 
class  BatchSplittingScriptBase
 Base class for batch splitting scripts. More...
 
class  ClassificationScriptBase
 Base class for document classification scripts. More...
 
class  ConversionScriptBase
 Base class for all script locators. More...
 
class  Crypto
 
class  ExtractionScriptBase
 Base class of extraction activity scripts containing all extraction events. More...
 
class  FieldFormatterResult
 Object containing the result of a field formatting. More...
 
class  FieldFormatterScriptBase
 Base class for all field formatter scripts. More...
 
class  FileImportScriptBase
 Base class for all file import scripts. More...
 
class  FileInsertionDownloadScriptBase
 Base class for all script locators. More...
 
class  LocatorScriptBase
 Base class for all script locators. More...
 
class  RulePatternScriptBase
 Base class for all rule matching pattern scripts. More...
 
class  SCAccount
 Object with the account settings. More...
 
class  SCAlternative
 Object containing the alternatives. More...
 
class  SCAlternativeSubField
 Object containg an alternative sub field. More...
 
class  SCAnnotationOutputData
 Object containing the annotation output data. More...
 
class  SCDatabase
 Object containing a validation rule. More...
 
class  SCDocument
 Object containing the main document class. More...
 
class  SCExtInfo
 Class containing extended document information More...
 
class  SCExtractionField
 Object containing read only properties of an extraction field. More...
 
class  SCExtractionPattern
 Object containing the settings of an extraction pattern. More...
 
class  SCExtractionResult
 Object containing the extraction results. More...
 
class  SCFileImportBatch
 A batch to import, containing documents, files and optionally fields. More...
 
class  SCFileImportDocument
 A document to import, optionally containing fields. More...
 
class  SCFileImportInfo
 Import information on a file or folder import. More...
 
class  SCFormatter
 Object with the formatting settings. More...
 
class  SCGridHeader
 Object containing the settings for a grid header. More...
 
interface  SCIImportInfo
 Object with the import info settings. More...
 
class  SCImportField
 Object with the import field settings. More...
 
class  SCLocalDatabase
 Object with the text database settings. More...
 
class  SCLocator
 Object containing the locator settings. More...
 
class  SCLocatorFormat
 Object containing the locator format settings. More...
 
class  SCLocatorFunctionFile
 Object containing the locator function file settings. More...
 
class  SCLocatorFunctionFileResult
 Object containing the locator function file results. More...
 
class  SCLocatorZone
 Object containing the zone locator settings. More...
 
class  SCLocatorZoneField
 A specific zone locator field containing a region and results. More...
 
class  SCLookupDialog
 Object containing the common settings of a lookup dialog box. More...
 
class  SCLookupDialogAlternatives
 Object containing the settings of a lookup dialog box for alternative results. More...
 
class  SCLookupDialogCustom
 Object containing the settings of a custom lookup dialog box. More...
 
class  SCLookupDialogLocalDb
 Object containing the settings of a lookup dialog box with a local database (text based). More...
 
class  SCLookupResult
 Object containing the lookup results. More...
 
class  SCMailAddress
 Class containing mail addresses More...
 
class  SCMailImportInfo
 Object with the import information on an email import. More...
 
class  SCMedium
 Object with the medium settings. More...
 
class  SCOcrBlock
 Object containing OCR block settings. More...
 
class  SCOcrChar
 Obect containing a recognized character in a word. More...
 
class  SCOcrLine
 Object containing OCR line settings. More...
 
class  SCOcrPage
 Object with all the OCR page results. More...
 
class  SCOcrResult
 Object with the OCR results. More...
 
class  SCOcrWord
 Object containing a recognized word in the block. More...
 
class  SCProcess
 The batch process object. More...
 
class  SCProjectCollections
 Object containing common scripting properties and functions. More...
 
class  SCRegion
 Object with the region settings. More...
 
class  SCResultRow
 Object containing the selected row from the lookup dialog box. More...
 
class  ScriptBase
 Base class for all script classes. More...
 
class  SCSeparationData
 Object containing the separation data. More...
 
class  SCValidationListItem
 Object containing a list item (usually used in a combobox containing a value populated by a list validation rule or in the BeforeComboBoxDropDown event). More...
 
class  SCValidationPage
 Object containing the validation page data. More...
 
class  SCValidationRule
 Object containing a validation rule. More...
 
class  SCZone
 Object containing OCR line settings. More...
 
class  ValidationRuleResult
 Object containing the validation rule result. More...
 
class  ValidationRuleScriptBase
 Base class for all script validation rules. More...
 
class  ValidationScriptBase
 Base class containing all available events in the validation module. More...
 
class  ZoneSelectionScriptBase
 Base class containing all available events in the ZoneSelection module. More...
 

Enumerations

enum  DatabaseTypes { Dictionary, LocalDatabase, RelationalDatabase }
 Type of database. More...
 
enum  FormatterTypes { Simple, Date, Script }
 Enumeration of Formatting types. More...
 
enum  LocatorTypes { BarcodeLocator, FormatLocator, TableLocator, ZoneLocator, DatabaseLocator, ScriptLocator, ComboLocator, AmountLocator, TrainableLocator, FunctionFileLocator }
 Enumeration of Locator types. More...
 
enum  SCFinalizeLogic { None, DeleteAlways, DeleteSuccessOnly, MoveToMailFolder }
 List of possible actions during finalization. More...
 
enum  SCMailPriority { Normal, Low, High }
 Mail priority enumeration. More...
 
enum  SCProcessStates {
  Undefined = -1, Ready, Suspended, Completed, Rejected, Reserved, Error, Missing, Processing, Outdated,
  CompletedPartial, DeletionPending, MovePending, ErrorMove, ErrorDeletion, ReprocessPending, SendToErrorPending
}
 List of all possible states of a batch. More...
 
enum  SourceApplications { Other, ExtractionActivity, ValidationActivity, ClassificationActivity, SortActivity, ActivityConditions, ValidationModule, ZoneSelectionActivity, ZoneSelectionModule }
 Enumeration of the component the event originated from. More...
 
enum  ValidationRuleTypes { Regex, List, Lookup, Simple, Date, Function, Script }
 Type of validation rule. More...
 

Enumeration Type Documentation

◆ DatabaseTypes

enum DatabaseTypes
strong

Type of database.

Enumerator
Dictionary 

Dictionary.

LocalDatabase 

LocalDatabase.

RelationalDatabase 

RelationalDatabase.

◆ FormatterTypes

enum FormatterTypes
strong

Enumeration of Formatting types.

Enumerator
Simple 

Text formatting.

Date 

Date formatting.

Script 

Formatting by scripting.

◆ LocatorTypes

enum LocatorTypes
strong

Enumeration of Locator types.

Enumerator
BarcodeLocator 

Locate by barcode.

FormatLocator 

Locate by format.

TableLocator 

Locate by table.

ZoneLocator 

Locate by zone.

DatabaseLocator 

Locate by database.

ScriptLocator 

Locate by script.

ComboLocator 

Locate by combining locators.

AmountLocator 

Locate by amount.

TrainableLocator 

Locate by trainable locator.

FunctionFileLocator 

Locate by matching with file content.

◆ SCFinalizeLogic

enum SCFinalizeLogic
strong

List of possible actions during finalization.

Enumerator
None 

None.

DeleteAlways 

Always delete.

DeleteSuccessOnly 

Delete after successful processing only.

MoveToMailFolder 

Move to mail folder.

◆ SCMailPriority

enum SCMailPriority
strong

Mail priority enumeration.

◆ SCProcessStates

enum SCProcessStates
strong

List of all possible states of a batch.

Enumerator
Undefined 

Undefined state.

Ready 

Ready for next process.

Suspended 

Suspended on current process.

Completed 

Process completed.

Rejected 

Process rejected.

Reserved 

Reserved.

Error 

Error on current process.

Missing 

Missing.

Processing 

Processing.

Outdated 

Config outdated.

CompletedPartial 

Partially completed.

DeletionPending 

Deletion still pending.

MovePending 

Move pending.

ErrorMove 

Error on move.

ErrorDeletion 

Error during deletion.

ReprocessPending 

Reprocess still pending.

SendToErrorPending 

Send to error still pending.

◆ SourceApplications

enum SourceApplications
strong

Enumeration of the component the event originated from.

Enumerator
Other 

Other component.

ExtractionActivity 

Extraction activity.

ValidationActivity 

Validation activity.

ClassificationActivity 

Classification activity.

SortActivity 

Sort activity.

ActivityConditions 

Activity conditions.

ValidationModule 

Validation module.

ZoneSelectionActivity 

ZoneSelection activity.

ZoneSelectionModule 

ZoneSelection module.

◆ ValidationRuleTypes

enum ValidationRuleTypes
strong

Type of validation rule.

Enumerator
Regex 

Validate by Regular expression.

List 

Validate by List of items.

Lookup 

Validate by Lookup in a database.

Simple 

Validate by Text formatting.

Date 

Validate by Date formatting.

Function 

Validate by Predefined function.

Script 

Validate by Scripting.