Indexing Profile
Category
Specifies the category that the document will be assigned to.
Script
A script can be created which will be executed before the execution of the field assignments. This script can also contain functions that can be called from the assignments. See the table below for a list o objects and functions available.
To extract, for example, position 1 to 9 of a barcode called "Barcode1" use the script:
Mid(GetValue("Barcode1"), 1, 9)If this was a date then you could also use the ToDate function to make sure that it is converted correctly. e.g:
ToDate(Mid(GetValue("Barcode1"),1,9),"DD/MM/YYYY")You could also use a script to set the category. For example, if the category is defined by the 1st and 2nd characters in a barcode the script would be:
Dim myBarcode
'Get the barcode value
myBarcode = Barcode.GetValue(„barcodename“)
'Extract only the first two characters
Dim barcodeChars
barcodeChars = Mid(myBarcode, 1, 2)
'Convert the first 2 characters of the barcode to a category id
If barcodeChars = "EN" Then
SetCategory(1)
ElseIf barcodeChars = "DE" Then
SetCategory(2)
ElseIf barcodeChars = "FR" Then
SetCategory(3)
End If
|
Note:
|
To automatically create barcode values from items in a 2D barcode that has a separator value. For example, a 2D barcode that 4 values separated by the " –" : Invoice – 12345 – 10/10/2014 – Therefore
Dim BarcodeValues
BarcodeValues = Split(Barcode.GetValue("Barcode1"), "-")Assignments will then be available in the indexing profile tab:
BarcodeValues(0)
BarcodeValues(1)
BarcodeValues(2)
BarcodeValues(3)
Auto-append mode
The auto-append mode for documents saved with this profile can be defined.
Assignment
Once a category has been chosen, a list of the index fields will be displayed. Clicking on the assignment down arrow will display a list of assignment variables. Clicking on the browse button opens a dialog where validation and error handling can be configured. See:
Assignments
Objects and Functions
| 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 |