|
Octobox API
4.1.0
Octobox Scripting API
|
Object containing the main document class. More...
Public Types | |
| enum | MailAttachmentTypes { Regular, Inline } |
| Enumeration of the Attachment types of an email attachment. More... | |
| enum | OriginTypes { Other, Body, BodyReply, Msg, MsgReply, Folder, InsertedFile, DuplicatedFile, PackagedFile, GeneratedExportFile, EmbeddedMsg, Archive } |
| Enumeration of Origin types of this document. More... | |
Public Member Functions | |
| SCExtractionResult | GetFieldResultByName (string name) |
| Returns the extraction field result based on the specified extraction field name. More... | |
| SCExtractionResult | GetFieldResultByNameOptional (string name) |
| Returns the extraction field result based on the specified extraction field name if it exists. More... | |
| void | RemoveDocumentType (string docTypeName) |
| Remove the specified document type from the DocumentTypes collection (if no document types remain, Unclassified is used). More... | |
| void | RemoveMedium (int index) |
| Remove medium at a specific index. More... | |
| SCDocument (object doc) | |
| Internal constructor for object initialization used by OCTOBOX (Do not use). More... | |
| SCDocument () | |
| Generate a new empty document. More... | |
Data Fields | |
| object | Object => Document |
| Internal object (do not use). More... | |
Properties | |
| SCLookupDialog | ActiveDialog [get, set] |
| Temporary storage of dialog to show. (Internal use only!) More... | |
| SCAnnotationOutputData | AnnotationOutputData [get] |
| Annotated value used on this document. More... | |
| IReadOnlyCollection< string > | ArchivedMedia [get] |
| List of file paths of this documents media if it is previously processed by the Archive Activity. More... | |
| MailAttachmentTypes | AttachmentType [get] |
| The type of attachment if this document originated from an email (use only in a rule pattern script). More... | |
| IReadOnlyCollection< SCDocument > | Children [get] |
| List of child documents (empty unless a split is performed before). More... | |
| Guid | DocumentId [get] |
| Unique Identifier of the document More... | |
| IReadOnlyCollection< string > | DocumentTypes [get] |
| List of documenttypes this document is classified too. More... | |
| IReadOnlyCollection< KeyValuePair< String, String > > | DynamicFields [get] |
| Key-Value list used to store activity specific fields. More... | |
| string | ErrorStateDescription [get, set] |
| Description of the error state. Setting this value will update the Message part of the description only. Other parts will be updated upon completion of the activity. More... | |
| IReadOnlyCollection< SCLocator > | ExecutedLocators [get] |
| A list of all locators executed for this document with stored alternatives. More... | |
| IReadOnlyCollection< SCDocument > | ExportDocuments [get] |
| Return a recursive list of all the children or the document itself if no children exist. More... | |
| DateTime | ExtInfoDateReceived [get, set] |
| Date received of this document based on its parents datereceived or date modified More... | |
| IReadOnlyCollection< SCExtractionResult > | ExtractionResults [get] |
| Collection containing all extraction results for this document. More... | |
| IReadOnlyCollection< SCImportField > | ImportFields [get] |
| Collection of all batch level import fields populated by the file connector Xml Import. More... | |
| bool | IsErrorState [get, set] |
| Indicates if a document is in error state and will not be processed by any activity regardless its classication or type. More... | |
| bool | IsExternalProcessValid [get] |
| Indicate this document as a whole is valid. More... | |
| IReadOnlyCollection< SCMedium > | Media [get] |
| A list of all media of this document. More... | |
| String | OriginalFileName [get] |
| Original attachment or filename. More... | |
| String | OriginalStoredFileName [get] |
| Full path of stored original attachment or filename. More... | |
| OriginTypes | OriginType [get, set] |
| Type of this documents origin (Normal, Body, Msg, MsgReply, Folder, ...). More... | |
| SCDocument | Parent [get] |
| Parent of this document (always null unless document is split). More... | |
| SCSeparationData | SeparationData [get] |
| Separation data (if the document is previously separated by the Separation Activity). More... | |
| String | StoredFullName [get] |
| Internal full filename of the file in the working folder. More... | |
| String | StoredName [get] |
| Internal filename of the file in the working folder. More... | |
Object containing the main document class.
|
strong |
|
strong |
Enumeration of Origin types of this document.
|
inline |
Internal constructor for object initialization used by OCTOBOX (Do not use).
| doc | Current document |
|
inline |
Generate a new empty document.
|
inline |
Returns the extraction field result based on the specified extraction field name.
| name | The extraction field for which to find the extraction results |
|
inline |
Returns the extraction field result based on the specified extraction field name if it exists.
| name | The extraction field for which to find the extraction results |
|
inline |
Remove the specified document type from the DocumentTypes collection (if no document types remain, Unclassified is used).
| docTypeName | Name of the document type to remove |
|
inline |
Remove medium at a specific index.
| index | Index in the document of the media to remove |
| object Object => Document |
Internal object (do not use).
|
getset |
Temporary storage of dialog to show. (Internal use only!)
|
get |
Annotated value used on this document.
|
get |
List of file paths of this documents media if it is previously processed by the Archive Activity.
|
get |
The type of attachment if this document originated from an email (use only in a rule pattern script).
|
get |
List of child documents (empty unless a split is performed before).
|
get |
Unique Identifier of the document
|
get |
List of documenttypes this document is classified too.
|
get |
Key-Value list used to store activity specific fields.
|
getset |
Description of the error state. Setting this value will update the Message part of the description only. Other parts will be updated upon completion of the activity.
|
get |
A list of all locators executed for this document with stored alternatives.
|
get |
Return a recursive list of all the children or the document itself if no children exist.
|
getset |
Date received of this document based on its parents datereceived or date modified
|
get |
Collection containing all extraction results for this document.
|
get |
Collection of all batch level import fields populated by the file connector Xml Import.
|
getset |
Indicates if a document is in error state and will not be processed by any activity regardless its classication or type.
|
get |
Indicate this document as a whole is valid.
|
get |
A list of all media of this document.
|
get |
Original attachment or filename.
|
get |
Full path of stored original attachment or filename.
|
getset |
Type of this documents origin (Normal, Body, Msg, MsgReply, Folder, ...).
|
get |
Parent of this document (always null unless document is split).
|
get |
Separation data (if the document is previously separated by the Separation Activity).
|
get |
Internal full filename of the file in the working folder.
|
get |
Internal filename of the file in the working folder.
1.8.13