Configuration Overview
The Database Lookup QSX may be configured to support multiple document types in one instance of the QSX. Since the Database Lookup's query is based on one or more document-level index field values, consideration should be given to the types of documents for which a lookup is desired.
A lookup will only be performed for documents with document types that have been configured for the specific instance of the Database Lookup QSX.
The Database Lookup configuration dialog may be displayed be right-clicking on the QSX icon and selecting the Configure... option from the context menu.
1. Select Document Type
All configuration settings apply to a specific document type, including the database connection. This provides the greatest flexibility, even allowing queries to be made on different databases for different document types. Select the desired document type from the Document Type drop-down.
2. Configure Database Connection
To create or configure the database connection, click on the Configure DB Connection button. This will display the Data Link Properties dialog for selecting the desired connection provider, database server and connection credentials. It is always a good idea to test the connection before proceeding to eliminate database connection issues if troubleshooting is needed in later steps.
3. Define Lookup Query
Once a connection to the database has been established, select the desired database table from the Database Table drop-down.
Next, select document fields to add to the query. If the CAPSYS CAPTURE field names are different from the database column names, you can "map" the appropriate database column to a field by selecting the column from the DB Column Alias drop-down next to the CAPSYS CAPTURE field name.
Finally, add any query conditions by selecting the Database Column, Operator and Index Field values and clicking Add Condition.
As the query is being defined, the SQL Query text box will dynamically update with the results of the query selections.
4. Test Lookup Query
Once all the options for the query have been selected, click the Test Query button to run a test.
5. Select Process Outcome Options
Select the desired options for Process Outcomes for exception handling.
6. Save Document Type Configuration
Once all query options have been selected for a document type, and after a test query has been successfully executed, click Save Document Type Configuration to save the settings for the selected document type.
Repeat this process for each document type for which a database lookup is desired in this instance of the Database Lookup QSX.
Custom SQL Query
For advanced users, the Use Custom Query checkbox may be selected and a custom SQL Query entered into the corresponding text field. When the Use Custom Query checkbox is selected, the Database Lookup QSX will override any Query options selected in the dialog, and will use only the custom query text entered.