Definition

There are two different types of database lookups:

  • Query lookups use values from certain index fields to run a query in the selected database table, or view and return only records matching those values.

  • List lookups return all the records from the selected row within a table or view. From the returned records, the user can select the record to be used to populate the selected index fields.

Name is the name of the current database lookup definition.

The Provider can be one of the following:

  • Delimited Text Files (for example, CSV)

  • FileBound

  • FileBound List

  • IBM DB2 (AS400 or MVS)

  • IBM Informix Dynamic Server

  • Microsoft Access

  • Microsoft SharePoint Choice Field

  • Microsoft SharePoint List

  • Microsoft SharePoint Person/Group

  • Microsoft SharePoint Term Set

  • Microsoft SQL Server

  • ODBC Compliant Databases

  • OpenLink Virtuoso Server

  • Oracle

  • Xero

With the exception of OpenLink and ODBC, the program connects directly to them without any further configuration, which is presented in the configuration screens of the program. Some databases require a client application to be loaded on each computer connecting to that database. Consult with the database provider for more information.

Next to Configuration, click the Setup button to configure the lookup.

In the dialog box that opens after clicking Setup, another Setup button might show up that needs to be clicked.

Outlined below is the provider information needed for configuration.

Provider Instructions

Delimited Text Files (for example, CSV)

  1. Select the directory.

  2. Select the file.

  3. Select the file type.

    • CSV Delimited

    • Tab Delimited

    • Fixed Length Fields

    • Custom Delimited

    • Enter the Custom Delimiter (| or ,)

  4. Select the box if the first row contains field names.

FileBound

  1. Select the version of the FileBound.

  2. Enter the FileBound server URL.

  3. Enter the user name and password.

  4. Click Test Connection.

  5. Select the desired project.

FileBound List
  1. Select the version of the FileBound.

  2. Enter the FileBound server URL.

  3. Enter the user name and password.

  4. Click Test Connection.

  5. Select the desired project.

  6. Select the desired list field.

IBM DB2
  1. Enter the name of the database alias.

  2. Enter the schema (optional).

  3. Enter the user ID and password for the selected database.

IBM Informix Dynamic Server
  1. Enter the name of the host.

  2. Enter the name of the service.

  3. Enter the name of the server.

  4. Enter the name of the database.

  5. Enter the user ID and password for the selected database.

Microsoft Access
  1. Enter the path to the Access database or click Browse to locate it.

  2. Enter the user ID and password if applicable.

Microsoft SharePoint Choice Field

Authentication type: Basic Authentication

Select this radio button at the top of the configuration window and then configure the following fields:

Site version: Select the version of SharePoint to use.

Support for SharePoint versions older than 2013 is deprecated.

Site address: Enter the complete site address. For example: http://sharepoint.company.com.

User name: Enter the username of the site collection administrator (preferred) or any other administrator.

Domain: Enter the domain of the SharePoint site. Note that this setting is disabled for SharePoint Online (noted below), because the domain is fixed.

Advanced: Opens the dialog box for the advanced settings.

  • Enable advanced authentication: Enables a claims-based authentication type for one of the following protocols:
    • NTLM (Mixed Mode): This basic Windows authentication type takes advantage of your existing Windows authentication provider (AD DS) and the authentication protocols that a Windows domain environment uses to validate the credentials of connecting clients.
    • Forms: Forms-based authentication is a claims-based identity management system that is based on ASP.NET membership and role provider authentication. Forms-based authentication can be used against credentials that are stored in an authentication provider, such as:
      • Active Directory Domain Services (AD DS)
      • SQL Server database (or similar database type)
      • A Lightweight Directory Access Protocol (LDAP) data store
    • ADFS: ADFS is a SAML token-based authentication in SharePoint Server, and uses the SAML 1.1 protocol and the WS-Federation Passive Requestor Profile (WS-F PRP). It requires coordination with administrators of a claims-based environment, whether it is your own internal environment or a partner environment. If you use Active Directory Federation Services (ADFS) 2.0 or later, you have a SAML token-based authentication environment.
      • When using ADFS, the ADFS identify provider configuration fields are enabled. Fill out the following to enable this claims-based authentication process as a part of your connection profile:
        • Identify provider URL: Enter the complete URL provisioned as an identity provider within the domain. For example: http://sharepoint.company.com.
        • Trust version: Choose from one of the following trust versions as configured by your domain administrator:
          • WsTrust Version 2005
          • WsTrust Version 13
          • Federated Trust
  • SharePoint online authentication: Use ADFS indentity provider: Enable this feature to use the SharePoint Online domain instead of a locally managed domain.

Password: Enter the password of the site collection administrator (preferred) or any other administrator. Use the Test Connection button to ensure the connection is successful.

Authentication type: Connection Profile

Select this radio button at the top of the configuration window and select a preconfigured SharePoint Connection Profile. For more information, see Connecting to SharePoint

SharePoint choice field selection:

  1. Select the desired Web.

  2. Select the desired Document Library/List.

  3. Select the desired Choice Field.

Microsoft SharePoint List
  1. Input the connection information as described in the "Microsoft SharePoint Choice Field" section above.

  2. Select the desired web.

  3. Select the desired document library or list.

Microsoft SharePoint Person/Group
  1. Input the connection information as described in the "Microsoft SharePoint Choice Field" section above.

  2. Select the desired web.

  3. Select the desired lookup type (person or group).

Microsoft SharePoint Term Set
  1. Input the connection information as described in the "Microsoft SharePoint Choice Field" section above.

  2. Select Term store ID, Term set ID, or Parent term ID.

Microsoft SQL Server
  1. Enter the name of the SQL server or select a server from the list to locate it.

    This function queries the whole domain for all SQL servers.

  2. Select the database to use.

ODBC Compliant Database Select a predefined system DSN.
OpenLink Virtuoso Server
  1. Enter the name of the Virtuoso server.

  2. Enter the name of the qualifier.

  3. Enter the name of the owner.

  4. Enter the name of the database.

  5. Enter the user ID and password for the selected database.

  6. Click Test Connection.

Oracle
  1. Enter the name of the Oracle server.

  2. Enter the schema / owner (optional).

  3. Select Use trusted connection or enter the user ID and password for the selected Oracle server.

Xero
  1. Enter the connection.

  2. Select the lookup type.

In the Field mappings grid, you can map the index fields defined in Capture Profile: Indexing with the fields defined in the selected database table.

Icon Description
Edit Field Mapping

Opens the Lookup Field Selection dialog box, where you can map the selected field.

Clear Field Mapping

Clears the selected field.