Table Mapping

Defines column mappings between a container element in a Data Model and a database table.

Remarks

The Table Mapping class is used to configure how data extracted from a Data Model, Data Section, or Data Table is exported to a database table.

Overview

A Table Mapping specifies:

• The source data element ('Source Scope') to export from, which can be a Data Model, Data Section, or Data Table.
• The target database table ('Target Table') to receive the exported data.
• The mapping of Grooper fields to database columns via the 'Column Mappings' property.
• Optional duplicate detection using 'Match Columns' and the action to take on a match ('Match Action').
• Optionally, columns to read back from the database after insert using 'Return Values'.

How It Works

For each instance of the selected source data element, a row is exported to the specified database table. The mapping between Grooper fields and database columns is defined using expressions, allowing for direct value export or calculated output.

If 'Match Columns' are specified, Table Mapping will check for existing rows in the database where the specified columns match the current record. The action taken on a match is determined by the 'Match Action' property (e.g., skip, update, or error).

When 'Return Values' are configured, values from auto-generated columns (such as identity columns or timestamps) can be read back and assigned to Grooper fields after the insert operation.

Example Usage

• Export one row per document by setting 'Source Scope' to a Data Model.
• Export one row per table row by setting 'Source Scope' to a Data Table.
• Export one row per section instance by setting 'Source Scope' to a Data Section.

Notes

• The Table Mapping object is typically used as part of a data export process, such as the Data Export behavior.
• Expressions in 'Column Mappings' are written in Visual Basic .NET and can reference fields, perform calculations, or format values as needed.
• For more information on mapping expressions, see the documentation for Column Map.

Properties

Name	Type		Description
Source Scope	Data Field Container	►	Specifies the data element to be exported. EditorScope Editor Requiredtrue Set this property to a Data Model, Data Section, or Data Table to define the scope of data to export. If set to a Data Model, one row will be exported per document. If set to a Data Table, one row will be exported for each table row. If set to a Data Section, one row will be exported for each section instance. The selected scope determines which data elements are available for mapping to database columns.
Target Table	String	►	The name of the database table to which data will be exported. EditorTable Name Editor Requiredtrue Enter the name of the target table in the connected database. This table will receive the exported data rows. The list of available tables is determined by the current Data Connection. The table must exist prior to export.
Column Mappings	Column Map	►	Defines the mapping of Grooper fields to database columns. EditorObject Properties Editor ConverterExpandable Converter Use this property to specify how each database column is populated from Grooper data. Each entry maps a database column to an expression, which can reference fields, perform calculations, or format values. For more details and examples, see the documentation for Column Map.
Match Columns	List(Of String)[]	►	Specifies one or more columns to include when checking for duplicate records. EditorColumn Check List ConverterCollection Converter When set, a duplicate check is performed before exporting each row. The system queries the target table for existing rows where the specified columns match the current record. If a match is found, the action taken is determined by the 'Match Action' property. Use this to prevent duplicate data or to update existing records as needed.
Match Action	MatchActions	►	Determines the action to take when a duplicate record is found. DefaultSkip Can be one of the following values: Name Value Description Skip 0 Skip export for records that match an existing row. No changes are made to the database for these records. Use Skip to prevent overwriting or updating existing records in the target table. The export operation for the matching record is skipped. No columns are updated or inserted for that record. This is useful when you want to ensure only new data is added, and existing data remains unchanged. ► Update 1 Update mapped columns in the existing row with values from the current record. Only columns mapped in 'Column Mappings' (excluding 'Match Columns' and 'Return Values') are updated. Use Update to synchronize or refresh data in the target table. The mapped columns (except those in 'Match Columns' and 'Return Values') are updated in the existing row. No new row is inserted for the matching record. This is useful for keeping the database up-to-date with the latest extracted values, such as updating status or address fields. ► Error 2 Raise an error and halt the export process if a matching row is found. No further records are processed. Use Error to enforce strict uniqueness and catch unexpected duplicates. The export process stops immediately if a duplicate is detected. No changes are made for the matching record. This is useful for data quality enforcement, or when duplicates indicate a configuration or extraction issue. ► This property controls what happens if a row in the target table matches the current record based on the 'Match Columns' criteria. Skip: No changes are made for the matching record. Update: The mapped columns in the existing row are updated. Error: An error is raised and the export is halted. This property is only visible when 'Match Columns' are specified.
Return Values	Return Value[]	►	Specifies an optional set of column values to read back from the database after the INSERT operation completes. EditorObject Collection Editor ConverterCollection Converter Use this property to capture values from auto-generated columns, such as identity columns or timestamps, after a row is inserted. The returned values are assigned to the corresponding Grooper fields, allowing you to track database-generated values within your data model.

See Also

Data ModelData SectionData TableColumn MapReturn Value

Used By

Data Export