Grooper Help - Version 25.0
25.0.0017 2,127
  • Overview
  • Help Status

Data Export

Export Definition Grooper.Activities

Defines an export mapping between this content type and a database connection.

Remarks

The Database Export behavior enables you to map extracted data from Grooper documents to one or more tables in an external database using a configured Data Connection.

This behavior is typically assigned to a Content Type to automate the export of structured data to a database as part of a batch process. It supports exporting to multiple tables, executing custom SQL statements, and targeting alternate databases when needed.

How It Works

  • The 'Connection' property specifies the Data Connection used for export. This determines the target database server and authentication.
  • The 'Table Mappings' property defines how data from the document's Data Model is mapped to one or more database tables. Each mapping specifies the table, columns, and the data elements to export.
  • The 'Custom Statements' property allows you to define custom SQL statements to be executed during export. These can be used for advanced scenarios such as updating related tables, logging, or calling stored procedures.
  • The 'Alternate Database' property lets you specify an expression to dynamically select a different database at runtime (supported for MS SQL only). This is useful for multi-tenant or partitioned environments.

Configuration Steps

  1. Set the 'Connection' property to the desired Data Connection.
  2. Add one or more 'Table Mappings' to define how document data is exported to database tables.
  3. (Optional) Add 'Custom Statements' for additional SQL operations.
  4. (Optional) Configure 'Alternate Database' if you need to export to different databases based on document data.

Example Use Cases

  • Exporting invoice data to an accounting system's database.
  • Writing extracted form data to multiple related tables (e.g., header and line items).
  • Executing custom SQL to update status flags or trigger downstream processes after export.
  • Dynamically routing exports to different databases based on document type or metadata.

Validation and Error Handling

  • The behavior validates that a Data Connection is set and that at least one table mapping or custom statement is defined.
  • If 'Alternate Database' is set, the connection must be an MS SQL Data Connection.
  • Errors during export (such as connection failures or SQL errors) are logged and will halt the export for the affected document.

> TIP: Use 'Table Mappings' for standard data export scenarios, and 'Custom Statements' for advanced or custom SQL logic.

For more information, see Export Definition, Data Connection, and Table Mapping.

Properties

NameTypeDescription

See Also

Notification