Objects and Functions |
Scroll |
Type of Object |
Name |
Description |
Used with |
Barcode Object |
Barcode.GetValue |
Gets the value of the barcode. |
Script & Assignments |
Barcode.IsAvailable |
With this function it is possible to check if a barcode is available. |
Script |
|
Barcode.GetValue (<name of defined barcode>) |
When barcodes have been defined these will be listed. This gets the value of this barcode. |
Script & Assignments |
|
Capture Client Object
|
Document size |
Gets the size of the document. |
Script & Assignments |
Domain User |
Gets the domain user. |
Script & Assignments |
|
Page count |
Gets the page count of the document. |
Script & Assignments |
|
User |
Gets the user name. |
Script & Assignments |
|
OCR Object |
Extract |
Gets the value of the defined part in the OCR Zone. |
Script & Assignments |
ExtractList |
Gets an array of values for the defined part in the OCR Zone. |
Script & Assignments |
|
<name of OCR Zone> |
When OCR zones have been defined these will be listed. This gets the value of this OCR Zone. |
Script & Assignments |
|
Index Data Object |
GetField |
Gets the current index data value of the specified field. |
Script |
SetCategory |
Sets the category for the current document. You can use an integer (category ID) or a string (category name). |
Script |
|
SetField |
Sets the value of the index data field. |
Script |
|
SetCaseNo |
Sets the CaseNo for this Index Data object. |
Script |
|
SetCaseDef |
Initializes this index data object, with a case definition. DO NOT USE THIS DIRECTLY ON THE PREDEFINED IndexData object (the predefined object is used when you don’t write an object name in front of the function call). This should be used in conjunction with CreateThereforeObject. |
Script |
|
CreateCase |
Use this after you have initialized the index data object with a case definition and after all mandatory fields are filled in. DO NOT USE THIS DIRECTLY ON THE PREDEFINED IndexData object (the predefined object is used when you don’t write an object name in front of the function call). This should be used in conjunction with CreateThereforeObject. |
Script |
|
Profile Object |
AddNewKeyword |
With this function you can add a new keyword to an already existing keyword dictionary. |
Script & Assignments |
NotApplicable |
Call this function if you want to abort the indexing profile execution. |
Script |
|
ReadPart |
Reads a part of the text, specified with a mask. |
Script & Assignments |
|
ScriptError |
Stops the execution of the script and throws an error with the specified text. |
Script |
|
ToDate |
Converts a string in the specified format to a date. This is needed, for example, when the date on imported documents is in a different format to the system. Use "D", "M", "Y" for day, month, year respectively. Delimiters are interpreted strictly, for example "D-M-Y" the delimiter MUST be "-" in this case. To represent any delimiter use "~". |
Script & Assignments |
|
ToFloat |
Converts a string in the specified format to a float number. |
Script & Assignments |
|
CreateThereforeObject |
This function will create a new Therefore object. As parameter, an array is expected. The first element in the array should always be a string with the object name you want to create. Currently this can be used to create an Index data object. Note: If you use the scripting help dialog, it will insert a predefined CreateThereforeObject call. |
Script |