Octobox API  4.1.0
Octobox Scripting API
Public Member Functions | Data Fields | Properties
SCProcess

The batch process object. More...

Public Member Functions

void AddDocument (SCDocument document)
 Add a new document to the end of the batch. More...
 
void AddDocumentWithFile (string filePath)
 Adds a new document with specified file to the end of the document collection. More...
 
SCDocument AddDocumentWithFileToParent (string filePath, SCDocument parent)
 Adds a new document with specified file to the end of the document collection. More...
 
void AddValidationImage (string filePath, int index, SCMedium medium)
 Adds a new validation export image and copies the file to the internal storage (jpeg only). More...
 
SCDocument DuplicateDocument (SCDocument document)
 Returns a duplicate of the specified document. More...
 
SCExtractionResult GenerateBatchFieldResult (string name)
 Generates and returns a document extraction field result with the specified name. If field already exists it will be returned. More...
 
SCExtractionResult GenerateDocumentFieldResult (SCDocument document, string name)
 Generates and returns a document extraction field result with the specified name. If field already exists it will be returned. More...
 
SCExtractionPattern GenerateExtractionPattern ()
 Generates and returns a new SCExtractionPattern More...
 
List< SCMailAddress > GetDocInheritedMessageCC (SCDocument doc)
 Returns the email CC addresses of the document or its first parent with origin Msg or EmbeddedMsg. More...
 
DateTime GetDocInheritedMessageDateReceived (SCDocument doc)
 Returns the date received of the document or its first parent with origin Msg or EmbeddedMsg. More...
 
SCMailAddress GetDocInheritedMessageFrom (SCDocument doc)
 Returns the from address of the document or its first parent with origin Msg or EmbeddedMsg. More...
 
string GetDocInheritedMessageId (SCDocument doc)
 Returns the unique message id of the document or its first parent with origin Msg or EmbeddedMsg. More...
 
string GetDocInheritedMessageSubject (SCDocument doc)
 Returns the message subject of the document or its first parent with origin Msg or EmbeddedMsg. More...
 
List< SCMailAddress > GetDocInheritedMessageTo (SCDocument doc)
 Returns the email TO addresses of the document or its first parent with origin Msg or EmbeddedMsg. More...
 
List< SCExtInfo > GetExtInfoList (bool orderByDateReceived)
 Returns a list of all extended info document records in this batch More...
 
SCExtractionResult GetFieldResultByName (string name)
 Returns the extraction field object based on the passed through extraction field name. More...
 
void InsertDocumentWithFile (string filePath, int index)
 Inserts a new document with the specified file at the specified index in the document collection. More...
 
SCAlternative MergeAlternatives (List< SCAlternative > alternatives)
 Merges a list of alternatives to a single alternative More...
 
void ReclassifyDocument (SCDocument document, string docTypeName, bool removeExistingTypes=true)
 Reclassifies a document to a new type while maintaining its existing fields collection. More...
 
void RemoveDocument (SCDocument doc, bool removeEmptyParent=true)
 Removes a document. More...
 
List< int > RemoveDocumentPages (SCDocument document, List< int > pageIndices)
 Removes a number of pages of the specified document including their validation pages and recognition results. More...
 
void UpdateExtInfoDb (List< string > typesToIgnore)
 Synchronize ExtInfo database records for this batch with the current document collection and specify ignored documents consisting of error documents and documents matching a specific type. More...
 

Data Fields

int LicenseCount => DocProcess.LicenseCount
 Used license count. More...
 
int LicenseCountAdvanced => DocProcess.AdvLicenseCount
 Used advanced license count. More...
 

Properties

SCAccount Account [get]
 Current account settings. More...
 
IReadOnlyCollection< SCDocument > AllDocumentsAllLevels [get]
 Collection of all documents (both parents and children) not in error state and not filtered by the assigned document types without the original message or file(s). More...
 
String ArchivedImportObjectFileName [get]
 Archive path of the original message or file (if previously stored by the Archive activity). More...
 
IReadOnlyCollection< string > AssignableDocumentTypes [get]
 Collection of all assignable document types. More...
 
String AttachmentWorkingFolder [get]
 Internal working folder where attachments are temporarely stored. More...
 
Guid ConfigId [get]
 ID of the loaded configuration. More...
 
IReadOnlyCollection< string > CurrentDocumentTypes [get]
 Collection of currently assigned document types. More...
 
string CurrentMainObjectPath [get]
 Path of the currently processed message or file. More...
 
IReadOnlyCollection< SCDocument > Documents [get]
 Collection of all documents not in error state and not filtered by the assigned document types without the original message or file(s). More...
 
IReadOnlyCollection< SCDocument > DocumentsAll [get]
 Collection of all documents not in error state and not filtered by the assigned document types. More...
 
IReadOnlyCollection< SCDocument > DocumentsAssigned [get]
 Collection of currently assigned documents not in error state without the original message or file(s). More...
 
IReadOnlyCollection< SCDocument > DocumentsAssignedAll [get]
 Collection of currently assigned documents not in error state. More...
 
IReadOnlyCollection< SCDocument > DocumentsError [get]
 Collection of all documents in error state not filtered by the assigned document types without the original message or file(s). More...
 
IReadOnlyCollection< SCExtractionResult > ExtractionResults [get]
 Collection of all batch level extraction results. More...
 
SCFileImportInfo FileImportInfo [get]
 Meta data of the imported file. More...
 
IReadOnlyCollection< SCImportField > ImportBatchFields [get]
 Collection of all batch level import fields populated by the Xml Import file connector. More...
 
String InsertedFilesFolder [get]
 Internal working folder where inserted files from the FileInsertion activity are temporarly stored. More...
 
SCMailImportInfo MailImportInfo [get]
 Meta data of the imported email message. More...
 
string MailRuleFolderError [get, set]
 Full mailfolder path the email will be moved to during finalization incase of an error. More...
 
string MailRuleFolderProcessed [get, set]
 Full mailfolder path the email will be moved to during finalization. More...
 
string MailRuleFolderProcessing [get]
 Full mailfolder path the email is located at during processing. More...
 
string MessageUniqueUri [get, set]
 The current messages unique URI on the mailserver. More...
 
IReadOnlyCollection< SCDocument > OriginalImportedFiles [get]
 Collection of all original imported files. More...
 
IReadOnlyCollection< SCDocument > ParentDocuments [get]
 Top level document parent collection (these documents may contain children). More...
 
bool PreventPartialRelease [get, set]
 Indicate if partial release for this batch should always be prevented even if it is selected in the validation profile. More...
 
int Priority [get, set]
 Priority of this process. More...
 
int ProcessId [get]
 Unique identifier of this process. More...
 
string ProcessTag1 [get, set]
 Batch description field ProcessTag1 More...
 
string ProcessTag2 [get, set]
 Batch description field ProcessTag2 More...
 
string ProcessTag3 [get, set]
 Batch description field ProcessTag3 More...
 
string ProcessTag4 [get, set]
 Batch description field ProcessTag4 More...
 
string ProcessTag5 [get, set]
 Batch description field ProcessTag5 More...
 
string ProcessTagDescription [get, set]
 Batch description field ProcessTagDescription More...
 
SCFinalizeLogic RuleFinalizationLogic [get, set]
 Finalization action of the batch. More...
 
SCDocument SelectedDocument [get, set]
 Currently selected document. More...
 
string Version [get]
 Version of this process. More...
 

Detailed Description

The batch process object.

Member Function Documentation

◆ AddDocument()

void AddDocument ( SCDocument  document)
inline

Add a new document to the end of the batch.

Parameters
documentDocument to add

◆ AddDocumentWithFile()

void AddDocumentWithFile ( string  filePath)
inline

Adds a new document with specified file to the end of the document collection.

Parameters
filePathFull path of the file to add

◆ AddDocumentWithFileToParent()

SCDocument AddDocumentWithFileToParent ( string  filePath,
SCDocument  parent 
)
inline

Adds a new document with specified file to the end of the document collection.

Parameters
filePathFull path of the file to add
parentParent document the created document will be added to

◆ AddValidationImage()

void AddValidationImage ( string  filePath,
int  index,
SCMedium  medium 
)
inline

Adds a new validation export image and copies the file to the internal storage (jpeg only).

Parameters
filePathFull path of the new image.
indexZero based index of the page.
mediummedium to add the image to.

◆ DuplicateDocument()

SCDocument DuplicateDocument ( SCDocument  document)
inline

Returns a duplicate of the specified document.

Parameters
documentThe document to duplicate
Returns

◆ GenerateBatchFieldResult()

SCExtractionResult GenerateBatchFieldResult ( string  name)
inline

Generates and returns a document extraction field result with the specified name. If field already exists it will be returned.

Parameters
namename of the field
Returns
The generated or existing field

◆ GenerateDocumentFieldResult()

SCExtractionResult GenerateDocumentFieldResult ( SCDocument  document,
string  name 
)
inline

Generates and returns a document extraction field result with the specified name. If field already exists it will be returned.

Parameters
documentdocument to generate the field for
namename of the field
Returns
The generated or existing field

◆ GenerateExtractionPattern()

SCExtractionPattern GenerateExtractionPattern ( )
inline

Generates and returns a new SCExtractionPattern

Returns
The generated pattern

◆ GetDocInheritedMessageCC()

List<SCMailAddress> GetDocInheritedMessageCC ( SCDocument  doc)
inline

Returns the email CC addresses of the document or its first parent with origin Msg or EmbeddedMsg.

Parameters
docList of email CC addresses.

◆ GetDocInheritedMessageDateReceived()

DateTime GetDocInheritedMessageDateReceived ( SCDocument  doc)
inline

Returns the date received of the document or its first parent with origin Msg or EmbeddedMsg.

Parameters
docDocument to check.
Returns
Datereceived.

◆ GetDocInheritedMessageFrom()

SCMailAddress GetDocInheritedMessageFrom ( SCDocument  doc)
inline

Returns the from address of the document or its first parent with origin Msg or EmbeddedMsg.

Parameters
docDocument to check.
Returns
Email from address.

◆ GetDocInheritedMessageId()

string GetDocInheritedMessageId ( SCDocument  doc)
inline

Returns the unique message id of the document or its first parent with origin Msg or EmbeddedMsg.

Parameters
docDocument to check.
Returns
Unique message id.

◆ GetDocInheritedMessageSubject()

string GetDocInheritedMessageSubject ( SCDocument  doc)
inline

Returns the message subject of the document or its first parent with origin Msg or EmbeddedMsg.

Parameters
docDocument to check
Returns
Message subject.

◆ GetDocInheritedMessageTo()

List<SCMailAddress> GetDocInheritedMessageTo ( SCDocument  doc)
inline

Returns the email TO addresses of the document or its first parent with origin Msg or EmbeddedMsg.

Parameters
docDocument to check.
Returns
List of email TO addresses.

◆ GetExtInfoList()

List<SCExtInfo> GetExtInfoList ( bool  orderByDateReceived)
inline

Returns a list of all extended info document records in this batch

Parameters
orderByDateReceivedTrue if results should be ordered ascending based on datereceived.
Returns
List of all extended info document records in this batch

◆ GetFieldResultByName()

SCExtractionResult GetFieldResultByName ( string  name)
inline

Returns the extraction field object based on the passed through extraction field name.

Parameters
nameThe extraction field for which to find the extraction results
Returns
The requested extraction result

◆ InsertDocumentWithFile()

void InsertDocumentWithFile ( string  filePath,
int  index 
)
inline

Inserts a new document with the specified file at the specified index in the document collection.

Parameters
filePathDocument to reclassify
indexIndex in the document to insert the medium

◆ MergeAlternatives()

SCAlternative MergeAlternatives ( List< SCAlternative >  alternatives)
inline

Merges a list of alternatives to a single alternative

Parameters
alternativesList of alternatives to merge
Returns
First alternative of the list with all other alternatives merged

◆ ReclassifyDocument()

void ReclassifyDocument ( SCDocument  document,
string  docTypeName,
bool  removeExistingTypes = true 
)
inline

Reclassifies a document to a new type while maintaining its existing fields collection.

Parameters
documentDocument to reclassify
docTypeNameNew document type
removeExistingTypesTrue to replace existing types with this one, False to add this type to the list of types

◆ RemoveDocument()

void RemoveDocument ( SCDocument  doc,
bool  removeEmptyParent = true 
)
inline

Removes a document.

Parameters
docdocument to remove
removeEmptyParentdefine if empty parent document should be removed. Default: true.

◆ RemoveDocumentPages()

List<int> RemoveDocumentPages ( SCDocument  document,
List< int >  pageIndices 
)
inline

Removes a number of pages of the specified document including their validation pages and recognition results.

Parameters
documentDocument to remove pages from. A single medium is required.
pageIndicesList of zero based page indices to remove
Returns
List of actual removed zero based page indices

◆ UpdateExtInfoDb()

void UpdateExtInfoDb ( List< string >  typesToIgnore)
inline

Synchronize ExtInfo database records for this batch with the current document collection and specify ignored documents consisting of error documents and documents matching a specific type.

Parameters
typesToIgnoreList of document types to mark as ignored

Field Documentation

◆ LicenseCount

int LicenseCount => DocProcess.LicenseCount

Used license count.

◆ LicenseCountAdvanced

int LicenseCountAdvanced => DocProcess.AdvLicenseCount

Used advanced license count.

Property Documentation

◆ Account

SCAccount Account
get

Current account settings.

◆ AllDocumentsAllLevels

IReadOnlyCollection<SCDocument> AllDocumentsAllLevels
get

Collection of all documents (both parents and children) not in error state and not filtered by the assigned document types without the original message or file(s).

◆ ArchivedImportObjectFileName

String ArchivedImportObjectFileName
get

Archive path of the original message or file (if previously stored by the Archive activity).

◆ AssignableDocumentTypes

IReadOnlyCollection<string> AssignableDocumentTypes
get

Collection of all assignable document types.

◆ AttachmentWorkingFolder

String AttachmentWorkingFolder
get

Internal working folder where attachments are temporarely stored.

◆ ConfigId

Guid ConfigId
get

ID of the loaded configuration.

◆ CurrentDocumentTypes

IReadOnlyCollection<string> CurrentDocumentTypes
get

Collection of currently assigned document types.

◆ CurrentMainObjectPath

string CurrentMainObjectPath
get

Path of the currently processed message or file.

◆ Documents

IReadOnlyCollection<SCDocument> Documents
get

Collection of all documents not in error state and not filtered by the assigned document types without the original message or file(s).

◆ DocumentsAll

IReadOnlyCollection<SCDocument> DocumentsAll
get

Collection of all documents not in error state and not filtered by the assigned document types.

◆ DocumentsAssigned

IReadOnlyCollection<SCDocument> DocumentsAssigned
get

Collection of currently assigned documents not in error state without the original message or file(s).

◆ DocumentsAssignedAll

IReadOnlyCollection<SCDocument> DocumentsAssignedAll
get

Collection of currently assigned documents not in error state.

◆ DocumentsError

IReadOnlyCollection<SCDocument> DocumentsError
get

Collection of all documents in error state not filtered by the assigned document types without the original message or file(s).

◆ ExtractionResults

IReadOnlyCollection<SCExtractionResult> ExtractionResults
get

Collection of all batch level extraction results.

◆ FileImportInfo

SCFileImportInfo FileImportInfo
get

Meta data of the imported file.

◆ ImportBatchFields

IReadOnlyCollection<SCImportField> ImportBatchFields
get

Collection of all batch level import fields populated by the Xml Import file connector.

◆ InsertedFilesFolder

String InsertedFilesFolder
get

Internal working folder where inserted files from the FileInsertion activity are temporarly stored.

◆ MailImportInfo

SCMailImportInfo MailImportInfo
get

Meta data of the imported email message.

◆ MailRuleFolderError

string MailRuleFolderError
getset

Full mailfolder path the email will be moved to during finalization incase of an error.

◆ MailRuleFolderProcessed

string MailRuleFolderProcessed
getset

Full mailfolder path the email will be moved to during finalization.

◆ MailRuleFolderProcessing

string MailRuleFolderProcessing
get

Full mailfolder path the email is located at during processing.

◆ MessageUniqueUri

string MessageUniqueUri
getset

The current messages unique URI on the mailserver.

◆ OriginalImportedFiles

IReadOnlyCollection<SCDocument> OriginalImportedFiles
get

Collection of all original imported files.

◆ ParentDocuments

IReadOnlyCollection<SCDocument> ParentDocuments
get

Top level document parent collection (these documents may contain children).

◆ PreventPartialRelease

bool PreventPartialRelease
getset

Indicate if partial release for this batch should always be prevented even if it is selected in the validation profile.

◆ Priority

int Priority
getset

Priority of this process.

◆ ProcessId

int ProcessId
get

Unique identifier of this process.

◆ ProcessTag1

string ProcessTag1
getset

Batch description field ProcessTag1

◆ ProcessTag2

string ProcessTag2
getset

Batch description field ProcessTag2

◆ ProcessTag3

string ProcessTag3
getset

Batch description field ProcessTag3

◆ ProcessTag4

string ProcessTag4
getset

Batch description field ProcessTag4

◆ ProcessTag5

string ProcessTag5
getset

Batch description field ProcessTag5

◆ ProcessTagDescription

string ProcessTagDescription
getset

Batch description field ProcessTagDescription

◆ RuleFinalizationLogic

SCFinalizeLogic RuleFinalizationLogic
getset

Finalization action of the batch.

◆ SelectedDocument

SCDocument SelectedDocument
getset

Currently selected document.

◆ Version

string Version
get

Version of this process.