Octobox API  4.1.0
Octobox Scripting API
Public Types | Properties
SCExtractionField

Object containing read only properties of an extraction field. More...

Public Types

enum  FieldTypes { Document, Batch }
 Enumeration of Field types. More...
 
enum  SearchTypes { ImportField = -2, FixedValue = -1, BarcodeLocator, FormatLocator, TableLocator, ZoneLocator, DatabaseLocator }
 Enumeration of Search types. More...
 
enum  TargetTypes { All = -1, Documents, Body, Subject, BodyAndSubject }
 Enumeration of Target types. More...
 

Properties

int AlternativeIndex [get]
 Field data type of the extraction field. More...
 
string DefaultValue [get]
 Default value of the extraction field. More...
 
string Description [get]
 Description of the extraction field. More...
 
bool DistinctValues [get]
 List of the unique extraction values. More...
 
FieldTypes FieldType [get]
 Field type of the extraction field. More...
 
string FixedValue [get]
 Fixed value of the extraction field. More...
 
Guid Id [get]
 Id of the extraction field. More...
 
bool IsRequired [get]
 Indicates if this extraction field must contain a value. More...
 
SCLocator Locator [get]
 Locator field to use to find the extraction field value. More...
 
string LocatorFieldName [get]
 Name of the locator field. More...
 
Guid LocatorId [get]
 Id of the locator field. More...
 
int MaxAlternatives [get]
 Maximum number of returned alternatives. More...
 
bool MergeAlternatives [get]
 Indicates if to merge the alternatives. More...
 
string Name [get]
 Name of the extraction field. More...
 
SearchTypes SearchType [get]
 Search type to use to find the extraction field. More...
 
TargetTypes TargetType [get]
 Target type to use to find the extraction field. More...
 

Detailed Description

Object containing read only properties of an extraction field.

Member Enumeration Documentation

◆ FieldTypes

enum FieldTypes
strong

Enumeration of Field types.

Enumerator
Document 

Document field.

Batch 

Batch/Email field.

◆ SearchTypes

enum SearchTypes
strong

Enumeration of Search types.

Enumerator
ImportField 

Imported field from email/file.

FixedValue 

Fixed value.

BarcodeLocator 

Barcode locator.

FormatLocator 

Format locator.

TableLocator 

Table locator.

ZoneLocator 

Zone locator.

DatabaseLocator 

Database locator.

◆ TargetTypes

enum TargetTypes
strong

Enumeration of Target types.

Enumerator
All 

All.

Documents 

Documents.

Body 

Body of email.

Subject 

Subject of email.

BodyAndSubject 

Body and subject of email.

Property Documentation

◆ AlternativeIndex

int AlternativeIndex
get

Field data type of the extraction field.

Index of the alternative value.

◆ DefaultValue

string DefaultValue
get

Default value of the extraction field.

◆ Description

string Description
get

Description of the extraction field.

◆ DistinctValues

bool DistinctValues
get

List of the unique extraction values.

◆ FieldType

FieldTypes FieldType
get

Field type of the extraction field.

◆ FixedValue

string FixedValue
get

Fixed value of the extraction field.

◆ Id

Guid Id
get

Id of the extraction field.

◆ IsRequired

bool IsRequired
get

Indicates if this extraction field must contain a value.

◆ Locator

SCLocator Locator
get

Locator field to use to find the extraction field value.

◆ LocatorFieldName

string LocatorFieldName
get

Name of the locator field.

◆ LocatorId

Guid LocatorId
get

Id of the locator field.

◆ MaxAlternatives

int MaxAlternatives
get

Maximum number of returned alternatives.

◆ MergeAlternatives

bool MergeAlternatives
get

Indicates if to merge the alternatives.

◆ Name

string Name
get

Name of the extraction field.

◆ SearchType

SearchTypes SearchType
get

Search type to use to find the extraction field.

◆ TargetType

TargetTypes TargetType
get

Target type to use to find the extraction field.