|
Octobox API
4.1.0
Octobox Scripting API
|
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... | |
The batch process object.
|
inline |
Add a new document to the end of the batch.
| document | Document to add |
|
inline |
Adds a new document with specified file to the end of the document collection.
| filePath | Full path of the file to add |
|
inline |
Adds a new document with specified file to the end of the document collection.
| filePath | Full path of the file to add |
| parent | Parent document the created document will be added to |
|
inline |
Adds a new validation export image and copies the file to the internal storage (jpeg only).
| filePath | Full path of the new image. |
| index | Zero based index of the page. |
| medium | medium to add the image to. |
|
inline |
Returns a duplicate of the specified document.
| document | The document to duplicate |
|
inline |
Generates and returns a document extraction field result with the specified name. If field already exists it will be returned.
| name | name of the field |
|
inline |
Generates and returns a document extraction field result with the specified name. If field already exists it will be returned.
| document | document to generate the field for |
| name | name of the field |
|
inline |
Generates and returns a new SCExtractionPattern
|
inline |
Returns the email CC addresses of the document or its first parent with origin Msg or EmbeddedMsg.
| doc | List of email CC addresses. |
|
inline |
Returns the date received of the document or its first parent with origin Msg or EmbeddedMsg.
| doc | Document to check. |
|
inline |
Returns the from address of the document or its first parent with origin Msg or EmbeddedMsg.
| doc | Document to check. |
|
inline |
Returns the unique message id of the document or its first parent with origin Msg or EmbeddedMsg.
| doc | Document to check. |
|
inline |
Returns the message subject of the document or its first parent with origin Msg or EmbeddedMsg.
| doc | Document to check |
|
inline |
Returns the email TO addresses of the document or its first parent with origin Msg or EmbeddedMsg.
| doc | Document to check. |
Returns a list of all extended info document records in this batch
| orderByDateReceived | True if results should be ordered ascending based on datereceived. |
|
inline |
Returns the extraction field object based on the passed through extraction field name.
| name | The extraction field for which to find the extraction results |
|
inline |
Inserts a new document with the specified file at the specified index in the document collection.
| filePath | Document to reclassify |
| index | Index in the document to insert the medium |
|
inline |
Merges a list of alternatives to a single alternative
| alternatives | List of alternatives to merge |
|
inline |
Reclassifies a document to a new type while maintaining its existing fields collection.
| document | Document to reclassify |
| docTypeName | New document type |
| removeExistingTypes | True to replace existing types with this one, False to add this type to the list of types |
|
inline |
Removes a document.
| doc | document to remove |
| removeEmptyParent | define if empty parent document should be removed. Default: true. |
|
inline |
Removes a number of pages of the specified document including their validation pages and recognition results.
| document | Document to remove pages from. A single medium is required. |
| pageIndices | List of zero based page indices to remove |
|
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.
| typesToIgnore | List of document types to mark as ignored |
| int LicenseCount => DocProcess.LicenseCount |
Used license count.
| int LicenseCountAdvanced => DocProcess.AdvLicenseCount |
Used advanced license count.
|
get |
Current account settings.
|
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).
|
get |
Archive path of the original message or file (if previously stored by the Archive activity).
|
get |
Collection of all assignable document types.
|
get |
Internal working folder where attachments are temporarely stored.
|
get |
ID of the loaded configuration.
|
get |
Collection of currently assigned document types.
|
get |
Path of the currently processed message or file.
|
get |
Collection of all documents not in error state and not filtered by the assigned document types without the original message or file(s).
|
get |
Collection of all documents not in error state and not filtered by the assigned document types.
|
get |
Collection of currently assigned documents not in error state without the original message or file(s).
|
get |
Collection of currently assigned documents not in error state.
|
get |
Collection of all documents in error state not filtered by the assigned document types without the original message or file(s).
|
get |
Collection of all batch level extraction results.
|
get |
Meta data of the imported file.
|
get |
Collection of all batch level import fields populated by the Xml Import file connector.
|
get |
Internal working folder where inserted files from the FileInsertion activity are temporarly stored.
|
get |
Meta data of the imported email message.
|
getset |
Full mailfolder path the email will be moved to during finalization incase of an error.
|
getset |
Full mailfolder path the email will be moved to during finalization.
|
get |
Full mailfolder path the email is located at during processing.
|
getset |
The current messages unique URI on the mailserver.
|
get |
Collection of all original imported files.
|
get |
Top level document parent collection (these documents may contain children).
|
getset |
Indicate if partial release for this batch should always be prevented even if it is selected in the validation profile.
|
getset |
Priority of this process.
|
get |
Unique identifier of this process.
|
getset |
Batch description field ProcessTag1
|
getset |
Batch description field ProcessTag2
|
getset |
Batch description field ProcessTag3
|
getset |
Batch description field ProcessTag4
|
getset |
Batch description field ProcessTag5
|
getset |
Batch description field ProcessTagDescription
|
getset |
Finalization action of the batch.
|
getset |
Currently selected document.
|
get |
Version of this process.
1.8.13