General

The Default value of an index field can be a predefined value selected from the list below or a value entered manually.

The following predefined values can be selected:

Depending on the data type of the field, items in this list may not be present.

  • Today's Date: mmddyyyy (as defined in the local system)

  • Today's Date/Time: mmddyyy.hhmmss (as defined in the local system)

  • Capture Profile Name: The name of the capture profile

  • User Name: The name and domain of the logged in user (Example: PSIGEN\scanner1)

  • User Name (No Domain): Only the name of the logged in user (Example: scanner1)

  • User Display Name: The display name for the profile of the user (Example: Scanning User)

  • Capture Station: The name of the station used to capture the batch

  • Batch Name: The batch name

  • Folder Separator Value (folder index fields only): The value used to separate the folder (usually a bar code value)

  • Document Separator Value: The value used to separate the document (usually a bar code value)

  • Folder Name: The name of the folder

  • Folder Number: The number of the folder relative to the batch it is contained in

  • Document Number: The number of the document number relative to the batch it is contained in

  • Document Page Count: The number of pages in the document

  • Import Filename: The Windows filename including its extension

  • Import Filename (No Extension): The Windows filename without its extension

  • Import File Path: Shows the file path if the import source is from a local or a mapped drive

  • Import File UNC Path: Shows the file path if the import source is from a network location

  • Import File Directory Path: Shows the file directory path if the import source is from a local or mapped drive

  • Import File Directory UNC Path: Shows the file directory path if the import source is from a network location

  • Import File Create Date: The date when the file was created

  • Import File Create Date/Time: The date/time when the file was created

  • Import File Modify Date: The date when the file was last modified

  • Import File Modify Date/Time: The date/time when the file was last modified

  • Import File Page Number: The page of the imported document

  • Import Path Elements (1–10): The path elements of the file

    For example: C:\Images\best buy\sales orders\00001.tif. If the user selected "best buy" during the Import or Auto Import process, selecting Import Path Element 2 would place "sales orders" in the index field.

  • Import Path Parent (1–10): The parent path elements of the file

    For example: C:\Images\best buy\sales orders\00001.tif. If the user selected the "sales orders" root directory during the Import or Auto Import process, selecting Import Parent Path Element 1 would place "Images" in the index field.

  • Begin Bates Stamp (1–5): The position of the begin bates stamp value to put in this index field

  • End Bates Stamp (1–5): The position of the end bates stamp value to put in this index field

  • OCR Value: The default OCR value as recognized during the Capture/Import step.

  • Begin Imprinted Value: The first imprinted value of each document

  • End Imprinted Value: The last imprinted value of each document

Additional options appear after defining batch or folder index fields. They appear as [Batch Field.(the name of the field)] or [Folder Field.(the name of the field)], which allows the user to automatically populate the document index field with those batch or folder field values.

For Input mask, many options can be selected to limit what the user can enter into the field when manually indexing. This feature provides a visual mask and forces manually indexing users to adhere to the defined format. Select a commonly used mask from the list or write custom masks with regular expressions.

This feature is not used in validation and is not used for validation when auto populating a field. It may be required to display the return values in an index field.

Click the question mark button to see the complete list of options or see the following table:

Character Purpose Description
# Digit placeholder Character must be numeric (0-9) and entry is required.
. Decimal placeholder The actual character used is the one specified as the decimal placeholder by the international settings of the system. This character is treated as a literal for masking purposes.
, Thousands separator The actual character used is the one specified as the thousands separator by the international settings of the system. This character is treated as a literal for masking purposes.
: Time separator The actual character used is the one specified as the time separator by the international settings of the system. This character is treated as a literal for masking purposes.
/ Date separator The actual character used is the one specified as the date separator by the international settings of the system. This character is treated as a literal for masking purposes.
\ Literal marker Treat the next character in the mask string as a literal. As a result, users can include the "#", "&", "A", "?", and other characters with special meanings in the mask. This character is treated as a literal for masking purposes.
& Character placeholder Valid values for this placeholder are ANSI characters in the following ranges: 32–126 and 128–255 (keyboard and foreign symbol characters).
> Uppercase marker Convert all the characters that follow to uppercase.
< Lowercase marker Convert all the characters that follow to lowercase.
A Alphanumeric character placeholder For example: a-z, A-Z, or 0-9. Character entry is required.
a Alphanumeric character placeholder For example: a-z, A-Z, or 0-9. Character entry is not required.
9 Digit placeholder Character must be numeric (0-9) but entry is not required.
- Negative sign When followed by a number section defined by series of "n"s (like in "-nn,nnn.nn"), it indicates that negative numbers are allowed. When not followed by a series of "n"s, it is treated as a literal. Minus sign is only shown when the number is actually negative.
+ Positive sign When followed by a number section defined by series of "n"s (like in "-nn,nnn.nn"), it indicates that negative numbers are allowed. However, it differs from the minus sign in the respect that it always shows a "+" or a "-" sign depending on whether the number is positive or negative.
C Character or space placeholder Character entry is not required. This option operates exactly like the "&" placeholder and ensures compatibility with Microsoft Access.
? Letter placeholder For example: a-z or A-Z. Character entry is not required.
n Digit placeholder A group of "n"s can be used to create a numeric section where numbers are entered from right to left. Character must be numeric (0-9) but entry is not required.
mm, dd, yy Date mask Combination of these three, special tokens can be used to define a date mask. mm for month, dd for day, yy for two-digit year, and yyyy for four-digit year. Examples: mm/dd/yyyy, yyyy/mm/dd, mm/yy.
hh, mm, ss, tt Time mask Combination of these three, special tokens can be used to define a time mask. hh for hour, mm for minute, ss for second, and tt for AP/PM. Examples: hh:mm, hh:mmtt, hh:mm:ss.
{date} Date token A placeholder for short date input. The date mask is derived using the underlying culture settings.
{time} Time token A placeholder for short time input. Short time typically does not include the seconds portion. The time mask is derived using the underlying culture settings.
{longtime} Longtime token A placeholder for long time input. Long time typically includes the seconds portion. The long time mask is derived using the underlying culture settings.
{double:i.f:c} Floating point placeholder A placeholder for a mask that allows floating point input where i and f in i.f specify the number of digits in the integer and fraction portions respectively. The :c portion of the mask is optional, and it specifies that the inputting of the value should be done continuously across fraction and integer portions. For example, with :c in the mask, in order to enter 12.34, the user types in "1234". Notice that the decimal separator character is missing. This method alleviates the user from having to type in the decimal separator.
{double:-i.f:c} Floating point placeholder Same as {double:i.f:c}, except this option can use negative numbers.
{currency:i.f:c} Floating point placeholder Same as {double:i.f:c}, except the mask is constructed based on currency formatting information of the underlying format provider or the culture. It typically has the currency symbol and also displays the group characters.
{currency:-i.f:c} Floating point placeholder Same as {currency:i.f:c}, except this option can use negative numbers.
Literal Literal text All other symbols are displayed as literals; That is, they appear as themselves.

Users can also escape the mask with {LOC} character sequence to indicate that symbols in the following table should be mapped to the associated symbols in the underlying culture settings.

Character Definition
$ Currency symbol
/ Date separator
: Time separator
, Thousands separator
. Decimal separator
+ Positive sign
- Negative sign

Minimum length and Maximum length define the minimum and maximum length of only those fields with a data type of Text. If the length of the populated data falls outside these parameters, validation of the selected index field fails.

You can define a Custom value for the selected index field with the use of constants and/or a combination of other fields. Clicking Build Custom Value opens the Custom Index Values Configuration dialog box, where you can create a custom index field.

In this dialog box, you can use a combination of the following options to create a custom value:

  • Field: Uses a current index field value.

  • Constant: Uses custom input information.

  • Math Symbol: Uses math symbols to calculate the custom value.

In multi-record indexing mode, where record types had been previously defined, each index field can be assigned to a specific Record Type or be shared among all record types.

Allow multiple records per Document and Support Document Record Types must be enabled and configured in the Document Records tab to make a selection.

Auto-populated data options

  • Select Truncate to maximum length for fields with a data type of Text that are populated automatically by methods like bar code, zone OCR, and database lookup, where the data captured must NOT exceed the permitted length for the index field. Under the Setup option, set the truncation from the start or the end of the index field if the length of the index field value exceeds the maximum set value.

  • Select Ignore length for fields with a data type of Text that are populated automatically by methods like bar code, zone OCR, and database lookup, where the desired result is to have all data populate the field regardless of the maximum length. Maximum length is ignored during validation if data is auto populated.

  • Select Trim whitespace to delete the whitespace at the end of any value entered in the index field.

  • Selecting Auto Increment and clicking Setup opens the Auto Increment Configuration dialog box, where you can set up a numeric field to be an auto-incremented number.

In the Auto Increment Configuration dialog box, you can select "New Counter Per Batch" or set up a new counter by clicking Setup.

Clicking Setup opens the Setup Counters dialog box, where you can select one of the defined counters or create a new one. See Configuration: Shared Counters.

Selecting "New Counter Per Batch" from the list causes the counter to start at the defined Start value with each new batch.

Start value is the starting value from where the incrementing begins.

Increment by is the value by which the user wishes the counter to increment.

Selecting Update subsequent items after value changed causes subsequent records to also be changed after changing a record. (For example: Record 3 has a value of 3. If the user changes it to 5 and the Increment By value is 1, then record 4 has a value of 6).

Field options

  • Select Required if this field requires data to be entered.

  • Select Read only if this field is read-only.

  • If Hide is selected, this field is not displayed to the user.

  • If Skip is selected, this field is skipped when the user presses Tab or Enter during navigation between index fields.

  • The Synchronized option is used for multi-record processing. Selecting it causes the selected index field to remain constant between all records on that document. Any change to one record updates this index field on all other records for the active document.

  • The Re-key option is used in conjunction with a second index workflow step. Once this option is selected, the field needs to be re-entered. When re-entering a field in Re-index (the second Index step in the workflow), if the re-entered value does not match the previously entered data, the user is warned that the expected value is the first value keyed, and the user is then prompted to either keep the original value or override it with the newly entered value.

  • If Sticky is selected, the data in this field remains in this field for each following document until changed. Click Setup to populate subsequent fields with the entire value or a subset value. In order to determine the subset, a start and end position must be defined.

  • Selecting Auto casing adjusts the case of all characters to the setting selected in Setup.

  • Selecting Regex validation further manipulates the data entered into the index field by using regular expressions. Clicking Setup opens the Regular Expression Selection dialog box, where you can configure the expressions currently in use or add new ones. Clicking Add opens the Regular Expression Editor, where you can write custom expressions or click Select to display the Regular Expressions Manager, where you can select existing expressions.

    For more information on regular expressions, see the part about Advanced Data Extraction. PSIcapture utilizes the .NET standard for regular expressions.

Import filename and path parsing

Select one of the following options if applicable:

  • Entire file / directory name: The entire file or folder name is placed in the selected index field.

  • Subset: The value placed in the index field is based on what values you set for Start position and End position. For example, if the start position is 1 and the end position is 4, only the first 4 characters of the file name would be placed there.

  • Split: The value placed in the index field is determined by a split character. For example, if the split character is an underscore ("_") in "(fred_123456_utah.tif)", then element 1 is "fred".

Scripting

Select Use custom scripts to populate and validate index fields for using scripts to validate each index field after entered. Click Open Script Editor to open the Script Editor.