Configuring Database Lookup

Configuring Database Lookup always starts with defining the batch and document index fields that will be used by the Lookup.  Database Lookups are configured for each job.

Defining of index fields in Job Setup has not changed from previous versions of the software.

To add or edit a new lookup:

  1. Click File>Job Setup. The Job Setup dialog box will be displayed.

  2. Select a job setup from the Job Name drop-down list. The settings for the job setup will be displayed.

  3. Select the Index tab.

  4. Select the Database Lookup tab. The Lookups table will be displayed with the following fields: Name,  Input Index Field, Output Index Field (Batch) and Output Index Field (Document) for each Lookup.

  5. Click Add. The Database Lookup wizard will be displayed.

  6. Enter the name of your Lookup in the Lookup name field.

  7. Click Browse to open the Select Data Source dialog box.

  • Select an existing File Data Source or Machine Data Source, or click New to create a new data source.  Depending on the type of data source you have selected, you will be prompted for additional information.

  • Click OK after all required information has been entered.

  1. Select the table or file from the Database table drop-down list that contains the data that will be used to populate or validate the index fields.

  2. Click Next to define how you want to do the data lookup.

  • Select the Validate index fields from Lookup results radio button if you want to validate one or more index field values with data from the Lookup. To save the validation results for other processing, select the checkbox for that option. 

  • Select the Populate index fields from Lookup results radio button if you want to populate one or more index fields from the Lookup.

  1. Select the index field(s) to be used by the Lookup to find matching values in the selected database from the Lookup index field drop-down list. This list contains all defined document and batch index fields. If a single index field is to be used for the Lookup, it must be in the left column before the “And”. If two Lookup index fields are provided, then only database records that contain both values will be matched. At the time of index data entry, if one value is not known, it may be replaced by the asterisk (*) character.

  2. Select the table column(s) to be searched for values matching the selected Lookup index field from the Lookup table column drop-down list. This list contains all table column names from the selected database table.

  3. For each Batch or Document index field, that you want to populate or validate, select the database column that contains the desired data.  Click in the column to the right of the index field name and select the database column from the drop-down list.

  4. Click Next to choose the database lookup options.

  5. Select the desired Lookup options:

  • Disable Lookup: when checked, Lookups will not be performed during scanning. This may improve performance with large or remote databases.  Lookups will continue to occur in Edit Index mode and when the batch is output/processed.

  • Disable multiple lookup results if there is more than one result: when unchecked, the Multiple Lookup Results table will not be displayed during scanning. Multiple Lookup results will be resolved in Edit Index mode, allowing scanning to continue uninterrupted.

  • Lookup will overwrite existing index value: when checked, the Lookup will always populate an index field with the lookup value in the database, as long as the database entry has a value (i.e., is not empty or Null). If you want your users to be able to manually enter data into an index field that Database Lookup is populating, this option should be unchecked or disabled.

Database Lookup will never overwrite data when the batch is output.

  • Disable Lookup during Output: when checked, no Lookup (populate or validate) will occur during output. If unchecked, empty fields will be populated and missing or multiple records will be ignored. Validation will fail if no matching record is found.

  • Maximum multiple results to display: when multiple lookup results are found, a table of the results will be displayed allowing you to choose the correct result. The value entered will limit the length of the table.

  1. Click Next to test the Lookup.

  2. Click Test Query. The Test Query dialog box will be displayed.

  3. Enter a valid value for the parameter that is used to perform the Lookup. If you leave the value blank, the first 25 records in the data table will  be displayed.

  4. Click OK.

See also:

Using Database Lookup