Database Lookup (Lookup Specification)

⚠	This article was migrated from an older version and has not been updated for the current version of Grooper. This tag will be removed upon article review and update.

This article is about the current version of Grooper. Note that some content may still need to be updated.
2025	2023	2.80

WIP	This article is a work-in-progress or created as a placeholder for testing purposes. This article is subject to change and/or expansion. It may be incomplete, inaccurate, or stop abruptly. This tag will be removed upon draft completion.

Database Lookup is a Lookup Specification that performs a lookup against a database Data Connection via a SQL query.

About

For validation, values in a Data Field are compared to corresponding values in a database table. If the results differ from what is in the table, that field can be flagged.

For data population, as long as the "lookup values" exist in the external database, Grooper extracted values can be used to populate additional Data Fields. Given a certain field or fields in a Data Model matches fields in a database table, additional values in the table’s row can be assigned to empty Grooper Data Fields. For example, an extracted social security number from a document could be used to lookup a corresponding name in database that has both the social security number and name.

The Grooper data fields used for comparison against a database table are called "lookup fields". The fields populated from the database table are called "target fields". A SQL query is used to find the lookup fields and target fields in the database table.

Database Lookup can be used to validate data already populated in a Grooper data model. That way, you can check to see if data extracted from a document set matches what's already in an existing database. It can also be used to populate data in a Grooper data model from a database. In these cases, some kind of extracted value from the document is used as a key to return information from a database that is not found on the document.

FYI	SQL databases and ODBC compliant databases are compatible with Grooper.

How To

Create a Data Connection

Before you can perform a Database Lookup, first Grooper must be able to connect to it in order to see everything in the data table. This is done by creating a Data Connection. Grooper can connect to a SQL database or an ODBC compliant database provider (such as Oracle, MySQL, PostgreSQL, or Db2). You will also need the user name and password used to access the database.

Add a Data Connection

1. In the node tree inside of your project, right click the folder where you would like to create your Data Connection.
2. Hover your mouse over "Add".
3. Select "Data Connection..." from the list that pops up.

4. When the "Add" window pops up, enter a name for your Data Connection.
5. Click "EXECUTE" to create.

Configure the Database Connection

1. Select the Data Connection in your node tree.
2. Click the hamburger menu to the right of the Connection Settings property.
3. Select ODBC or SQL Server:- from the drop down list. For this example we are going to select SQL Server:-.

4. Click the arrow next to the Connection Settings Property to open up its sub properties.
5. Enter in the name of the server hosting the ODBC or SQL.
6. Click the ellipsis button next to the Database Name property.

7. When the "Database Name" window pops up, scroll through and select the desired database.
8. Click "OK" to select.

9. Enter in the User Name and Password you will be using to access the database. If you leave these fields blank, Grooper will default to Windows Authentication.
10. Click the Save icon to save your changes.

11. Click the play button to verify your connection. You should see your database information pop up in the other windows.