Include predefined fields

How to ... ››
Parent Previous Next

Predefined Fields



Description


When defining file names, entering the text for notifications or export values, the value can be set by entering a fixed value or by selecting a field available within the Octobox environment. While processing emails and files additional fields becomes available, these fields can then be used in the subsequent steps (activities) in the processing flow of these emails and files.



Groups


When the user performs a right-click in a field, a context menu is shown with a list of the different types of predefined fields available.


When using the File plug-in


The following groups and functions are available:


Additional fields become available when specific activities are added in the flow, these activities are:



Standard Available Fields


When selecting Message fields, the following fields are available




When selecting File fields, the following fields are available




When selecting Exception fields, the following fields are available




When selecting General fields, the following fields are available



CECurrentDate - Current date, default format “dd/MM/yyyy”

CECurrentTime - Current date, default format “HH:mm:ss”

CETimeStamp - Current date time, default format “yyyyMMddHHmmssfff”


All 3 date fields can be formatted to any valid date format by supplying it as a suffix.

Example: {CECurrentDate[yyyy-MM-dd HH:mm]}


CEAccountName - Name of the used account

CERuleName - Name of the used rule


CEGuid - A new UUID is generated for each document

CEGuidGlobal - A new UUID is generated once per batch and is the same for all documents it contains

CEDocumentIndex - Index of the current document from the collection of selected document types

CEDocumentIndexGlobal - Index of the current document in the batch



When selecting Message fields, the following fields are available



CEMessageID - Unique identifier of this email message on the mail server

CEMessageFileName - Filename of the EML or MSG when using file import for emails

CEMessageFileNameFull - Filename includes also the full path

CEOriginalFileName - Filename of the attachment in an email after separating a file into independent files

CEOriginalFileNameInit - Filename of an attachment in an email



When selecting Reporting fields, the following fields are available



CEReportObjectId - Unique ID of a specific email message or file in Octopus, reprocessing a message or file will result in the same ID

CEReportProcessID - Unique ID of a specific process in Octopus, reprocessing a message or file will result in a new ID, this ID is always unique



Standard Functions


When selecting Function fields, the following fields are available



CEFunctionLeft[CEField , Length]

Definition: Take the first x characters of the specified field.

Example: {CEFunctionLeft[CEMessageFrom , 5]} using value 'octobox@capture-experts.com'

Description: Take the first 5 characters of the value in the predefined field CEMessageFrom

Result: octob


CEFunctionRight[CEField , Length]

Definition: Take the last x characters of the specified field.

Example: {CEFunctionRight[CEMessageFrom , 5]} using value 'octobox@capture-experts.com' 

Description: Take the last 5 characters of the value in the predefined field CEMessageFrom

Result: s.com


CEFunctionMid[CEField , Start , Length]

Definition: Take the x characters of the specified field starting at a specific index.

Example: {CEFunctionMid[CEMessageFrom , 5 , 3]} using value 'octobox@capture-experts.com' 

Description: Take the 3 characters starting from position 5 of the value in the predefined field CEMessageFrom

Result: ox@


CEFunctionSplit[CEField , SeparatorValue , Index]

Definition: Split the specified field based on the separator value and return the part defined by the index. Index N will return the last part.

Example: {CEFunctionSplit[CEMessageFrom , b , 2]} using value 'octobox@capture-experts.com' 

Description: Split the value of the predefined field CEMessageFrom using the letter 'b' and return the value of the 2nd part

Result:  ox@ca


CEFunctionFind[CEField , MatchCount , Regex]

Definition: Return the MatchCount number of matches to the specified Regex.

Example: {CEFunctionFind[CEMessageFrom , 2 , .p]} using value 'octobox@capture-experts.com' 

Description: Find in the value of the predefined field CEMessageFrom all the parts that match the regular expression '.p' (character 'p' preceded by any character) and return the first 2 found values (concatenated using the ';' character)

Result: ap


CEFunctionFirst[CEField1 , CEField2 , CEField3 , ...]

Definition: Return the first not empty value of the list of passed fields.

Example: {CEFunctionFirst[Field1, Field2, 'Field3']} using values Field1='', Field2='Val1'

Description: Find in the values the first not empty value

Result: Val1


CEFunctionFormat[FieldName , FormatterName]

Definition: Return the formatted value of the content of the specified field by executing the specified formatter.

Example: {CEFunctionFormat[InDate, FmtDate]} using values InDate = '12-10-2018' and FmtDate is a date formatter returning valid dates in the format YYYY/MM/DD

Description: Format the content of the Indate field according to the settings of the FmtDate formatter

Result: 2018/10/12



Predefined Fields Linked To Specific Activities


The predefined fields listed below each time become available in the activity following this activity.


When using the Annotation activity, the following fields become available



CEAnnotationBarcodeCntr - Value of the barcode counter during Barcode Annotation

CEAnnotationBarcodeValue - Value of the printed barcode during Barcode Annotation

CEAnnotationTextCntr - Value of the counter during Text Annotation

CEAnnotationTextValue - Value of the printed text during Text Annotation



When using the Archiving activity, the following fields become available



CEArchiveNameMessage - Full path of the archived message file name

CEArchiveNameOriginals - Full path of the original file name

CEArchiveNameExported - Full path of the processed file name



When using the Classification activity, the following fields become available



CEClassDocumentType - List separated by the '|' character, the list contains all the document types the current document was assigned to.



When using the Extraction activity, the following fields become available



Batch and document extraction fields defined during extraction.



When using the Kofax Capture activity, the following fields become available



CEKCBatchID - Internal batch ID of the batch (returned from Kofax Capture after exporting to Kofax Capture).

CEKCDocumentID - Internal document ID of the document (returned from Kofax Capture after exporting to Kofax Capture).



When using the Separation activity, the following fields become available



CESepValue - The value of the page the document was separated on during separation

CESepIndex - The page index of the page the document was separated on during separation