2023:Data Connection (Node Type): Difference between revisions

From Grooper Wiki
(25 intermediate revisions by 2 users not shown)
Line 1: Line 1:
<blockquote>
{{AutoVersion}}
'''Data Connections''' are required to connect a [[Grooper Repository]] to an external database.  The '''Data Connection''' stores all information needed to access the database.  Once connected, Grooper has both read and write access to tables in the database (assuming you have those user rights in the database).
 
</blockquote>
{{stubs}}
 
<blockquote>{{#lst:Glossary|Data Connection}}</blockquote>


Grooper can connect to a Microsoft SQL Server or ODBC-compliant providers (such as Oracle, Db2, MySQL and PostgreSQL).
Grooper can connect to a Microsoft SQL Server or ODBC-compliant providers (such as Oracle, Db2, MySQL and PostgreSQL).
Line 10: Line 12:
* To export collected data to a database.
* To export collected data to a database.
** This is done using '''Data Exports''' defined using '''''Export Behaviors'''''
** This is done using '''Data Exports''' defined using '''''Export Behaviors'''''


== How To ==
== How To ==
=== Create a Data Connection ===
=== Create a Data Connection ===
'''Data Connections''' can be created in any Grooper '''Project'''.
'''Data Connections''' can be created in any Grooper '''Project'''.
{{#lst:Database Lookup|how to create a data connection}}
Please see '''[[Data_Export#Configuring_a_Data_Connection|Configuring a Data Connection]]'''.
 
=== Use a Data Connection for Database Lookups ===
Please see '''[[Database_Lookup|Database Lookup]]'''.
 
=== Use a Data Connection for Data Export ===
Please see '''[[Data_Export#Configuring_Export_Behaviors_for_Data_Export|Configuring Export Behaviors for Data Export]]'''.


==== Known Issues ====
==== Known Issues ====


The Grooper installer ships with various pre-requisite components which are installed before the Grooper application.  This includes CLR type mappings for various SQL data types.  However, to keep the installer package lightweight, less common CLR types were not included. This includes geometry and geography data types.
The Grooper installer ships with various prerequisite components which are installed before the Grooper application.  This includes CLR type mappings for various SQL data types.  Without additional components installed, users may experience the following error when attempting to preview database tables with unsupported CLR Types (such as geometry and geography data types):
 
<pre>
InvalidOperationException: DataReader.GetFieldType(24) returned null.
</pre>
 
To support additional CLR Types (including geometry and geography data types), users need to install the following prerequisite from Microsoft:


In order to preview SQL database tables with geometry or geography data types, you will need to install the following package:
* https://www.microsoft.com/en-us/download/details.aspx?id=100451
* https://www.microsoft.com/en-us/download/details.aspx?id=100451


=== Use a Data Connection for Database Lookups ===
== Words of caution on ODBC Data Connections ==
 
{|class="attn-box"
|
&#9888;
|
'''''BE AWARE: You will need to connect to an ODBC data source on both the web server and any machine hosting Activity Processing services'''''


Coming soon
ODBC data sources must be connected to from the Windows ODBC Data Sources Administrator before creating a '''Data Connection''' in Grooper.  This must be done on the web server ''and'' any client machines hosting '''Activity Processing''' services.
* To create and configure the '''Data Connection''' from Design you need the ODBC connection on the web server.
* To run activities like '''Export''' you need it on whatever machine is hosting the '''Activity Processing''' services.
|}


=== Use a Data Connection for Data Export ===
{|class="attn-box"
|
&#9888;
|
'''''BE AWARE: Not all ODBC databases are fully supported'''''


Coming soon
Grooper officially supports the following ODBC databases:
* MSSQL
* Oracle
* DB2
* MySQL
* PostgreSQL


[[Category:Articles]]
While other database versions may also function with ODBC, they could potentially encounter issues, particularly with more advanced features or newer updates.
[[Category:Version 2023]]
|}
[[Category:Stub]]

Revision as of 10:56, 31 January 2025

This article is about an older version of Grooper.

Information may be out of date and UI elements may have changed.

20252023

STUB

This article is a stub. It contains minimal information on the topic and should be expanded.

database Data Connections connect Grooper to Microsoft SQL and supported ODBC databases. Once configured, Data Connections can be used to export data extracted from a document to a database, perform database lookups to validate data Grooper collects and other actions related to database management systems (DBMS).

  • Grooper supports MS SQL Server connectivity with the "SQL Server" connection method.
  • Grooper supports Oracle, PostgreSQL, Db2, and MySQL connectivity with the "ODBC" connection method.

Grooper can connect to a Microsoft SQL Server or ODBC-compliant providers (such as Oracle, Db2, MySQL and PostgreSQL).

Data Connections are primarily used for two reasons in Grooper

  • To validate data extracted from a document or to populate fields using values stored in a database.
    • This is done using Database Lookups defined on Data Models.
  • To export collected data to a database.
    • This is done using Data Exports defined using Export Behaviors

How To

Create a Data Connection

Data Connections can be created in any Grooper Project. Please see Configuring a Data Connection.

Use a Data Connection for Database Lookups

Please see Database Lookup.

Use a Data Connection for Data Export

Please see Configuring Export Behaviors for Data Export.

Known Issues

The Grooper installer ships with various prerequisite components which are installed before the Grooper application. This includes CLR type mappings for various SQL data types. Without additional components installed, users may experience the following error when attempting to preview database tables with unsupported CLR Types (such as geometry and geography data types):

InvalidOperationException: DataReader.GetFieldType(24) returned null.

To support additional CLR Types (including geometry and geography data types), users need to install the following prerequisite from Microsoft:

Words of caution on ODBC Data Connections

BE AWARE: You will need to connect to an ODBC data source on both the web server and any machine hosting Activity Processing services

ODBC data sources must be connected to from the Windows ODBC Data Sources Administrator before creating a Data Connection in Grooper. This must be done on the web server and any client machines hosting Activity Processing services.

  • To create and configure the Data Connection from Design you need the ODBC connection on the web server.
  • To run activities like Export you need it on whatever machine is hosting the Activity Processing services.

BE AWARE: Not all ODBC databases are fully supported

Grooper officially supports the following ODBC databases:

  • MSSQL
  • Oracle
  • DB2
  • MySQL
  • PostgreSQL

While other database versions may also function with ODBC, they could potentially encounter issues, particularly with more advanced features or newer updates.