Data Export (Export Definition) - Revision history

Dgreenwood at 22:42, 6 February 2026

2026-02-06T22:42:49Z

Show changes

Dgreenwood at 22:56, 5 February 2026

2026-02-05T22:56:07Z

Show changes

Dgreenwood: /* Example */

2026-02-05T22:28:32Z

Example

← Older revision		Revision as of 17:28, 5 February 2026
Line 64:		Line 64:
	For an invoice document, you might configure two table mappings:		For an invoice document, you might configure two table mappings:

	# ~~'''~~Header Mapping~~'''~~: Maps invoice header fields (Invoice Number, Date, Total, etc.) to an "Invoices" table		# Header Mapping: Maps invoice header fields ("Invoice Number", "Date", "Total", etc.) to an "Invoices" table
	# ~~'''~~Line Items Mapping~~'''~~: Maps the Line Items [[Data Table]] to an "InvoiceItems" table, exporting one row per line item		# Line Items Mapping: Maps the "Line Items" Data Table to an "InvoiceItems" table, exporting one row per line item

	Table mappings are executed in the order listed. At least one table mapping or custom statement must be defined for export to occur.		Table mappings are executed in the order listed. At least one table mapping or custom statement must be defined for export to occur.

Dgreenwood: /* Configuration basics */

2026-02-05T22:27:27Z

Configuration basics

← Older revision		Revision as of 17:27, 5 February 2026
Line 34:		Line 34:
	== Configuration basics ==		== Configuration basics ==

	Data Export is primarily configured using the "Connection" and "Table Mappings" settings.		Data Export is primarily configured using the '''Connection''' and '''Table Mappings''' settings.

	More advanced scenarios are accommodated by the "Alternate Databases", "Match Columns" (and "Match Actions") and "Custom Statements" settings.		More advanced scenarios are accommodated by the '''Alternate Databases''', '''Match Columns''' (and '''Match Actions''') and '''Custom Statements''' settings.

	=== Primary configuration settings ===		=== Primary configuration settings ===

Dgreenwood: /* Match Columns and Match Actions */

2026-02-05T22:24:49Z

Match Columns and Match Actions

← Older revision		Revision as of 17:24, 5 February 2026
Line 75:		Line 75:
	==== Match Columns and Match Actions ====		==== Match Columns and Match Actions ====

	Match Columns and Match Actions work together to control how Data Export handles duplicate records during the export process~~. These settings are configured on each Table Mapping~~.		These settings are configured in the '''Table Mapping''' settings of a Data Export. '''Match Columns''' and '''Match Actions''' work together to control how Data Export handles duplicate records during the export process.

	===== Match Columns =====		===== Match Columns =====
Line 134:		Line 134:
	* '''Match Action''': Error		* '''Match Action''': Error
	* '''Result''': Stops export if a person with the same SSN and date of birth already exists		* '''Result''': Stops export if a person with the same SSN and date of birth already exists


	*<li class="fyi-bullet">'''Note:''' When Match Columns are used, the "Rows Updated" statistic is tracked instead of "Rows Exported" to reflect the number of existing records processed.		*<li class="fyi-bullet">'''Note:''' When Match Columns are used, the "Rows Updated" statistic is tracked instead of "Rows Exported" to reflect the number of existing records processed.

Dgreenwood: /* Configuration basics */

2026-02-05T22:21:21Z

Configuration basics

@@ Line 34: / Line 34: @@
 == Configuration basics ==
-=== Connection ===
+Data Export is primarily configured using the "Connection" and "Table Mappings" settings.
 The "Connection" property specifies the [[Data Connection]] used for export. This determines the target database server, authentication method, and connection settings.
@@ Line 42: / Line 50: @@
 * If the connection is not set, export will not be performed
-=== Table Mappings ===
+==== Table Mappings ====
 The "Table Mappings" property defines the list of table export operations to perform. Each [[Table Mapping]] specifies:
@@ Line 52: / Line 60: @@
 * Optional return values to read back after insert
-==== Example ====
+===== Example =====
 For an invoice document, you might configure two table mappings:
@@ Line 61: / Line 69: @@
 Table mappings are executed in the order listed. At least one table mapping or custom statement must be defined for export to occur.
-=== Custom Statements (Optional) ===
+=== Advanced configuration settings ===
 The "Custom Statements" property allows you to define custom SQL statements to execute during export. These are useful for:
@@ Line 72: / Line 148: @@
 Custom statements are executed '''after''' all table mappings have completed. They can reference data from the document's [[Data Model]] using expressions, allowing for dynamic SQL generation.
-==== Example ====
+===== Example =====
 After exporting an invoice, you might execute a custom statement to update a "LastProcessed" timestamp in a tracking table:
@@ Line 82: / Line 158: @@
 </pre>
-=== Alternate Database (Optional) ===
+==== Alternate Database ====
 The "Alternate Database" property allows you to specify an expression that calculates the name of an alternate database to which data will be exported. This is useful for:
@@ Line 92: / Line 168: @@
 '''Important notes:'''
-* This feature is only supported for MS SQL [[Data Connection]]s
+* This feature is only supported for MS SQL Data Connections
 * The alternate database must have the same schema as the primary database
-* The expression can reference fields from the document's [[Data Model]]
+* The expression can reference fields from the document's Data Model
-* If left blank, the default database from the [[Data Connection]] is used
+* If left blank, the default database from the Data Connection is used
-==== Example ====
+===== Example =====
 To route exports to a customer-specific database:

Dgreenwood: /* Configuration */

2026-02-05T22:10:20Z

Configuration

← Older revision		Revision as of 17:10, 5 February 2026
Line 32:		Line 32:
	# (''Only if configured'') If any Table Mapping has "Return Values" configured, saves the updated data back to the document		# (''Only if configured'') If any Table Mapping has "Return Values" configured, saves the updated data back to the document

	== Configuration ==		== Configuration basics ==

	=== Connection ===		=== Connection ===

Dgreenwood: /* Step 3: Configure the Data Connection */

2026-02-05T21:24:08Z

Step 3: Configure the Data Connection

← Older revision		Revision as of 16:24, 5 February 2026
Line 201:		Line 201:

	# With the Data Export definition selected in the Object Collection Editor, locate the "Connection" property		# With the Data Export definition selected in the Object Collection Editor, locate the "Connection" property
	# Click the dropdown or ellipsis button to select your [[Data Connection]]		# Click the dropdown or ellipsis button to select your Data Connection
	# Choose the connection that points to your target database		# Choose the connection that points to your target database
	# Click '''OK''' to confirm		# Click '''OK''' to confirm

	{{Tip\|If you haven't created a [[Data Connection]] yet, you'll need to add one to your ~~repository~~ first. ~~Navigate to your project's Connections folder~~, add a new Data Connection, and configure the server, database, and authentication settings.}}		*<li class="fyi-bullet">Tip: If you haven't created a [[Data Connection]] yet, you'll need to add one to your Project first. Right click the Project or any of its subfolders, add a new Data Connection, and configure the server, database, and authentication settings.

	=== Step 4: Configure Table Mappings ===		=== Step 4: Configure Table Mappings ===

Dgreenwood: /* Step 1: Add an Export Behavior to your Content Type */

2026-02-05T21:22:49Z

Step 1: Add an Export Behavior to your Content Type

← Older revision		Revision as of 16:22, 5 February 2026
Line 177:		Line 177:
	=== Step 1: Add an Export Behavior to your Content Type ===		=== Step 1: Add an Export Behavior to your Content Type ===

	# In the Grooper repository tree, navigate to your [[Content Type]]		# In the Grooper repository tree, navigate to your Content Type
			#*<li class="fyi-bullet">Most typically Export Behaviors are added to '''Content Models''' but can be added to '''Content Categories''' and '''Document Types''' for more Document Type-specific export scenarios.
	# If the Content Type does not already have an '''Export Behavior''', add one:		# If the Content Type does not already have an '''Export Behavior''', add one:
	#* Right-click the [[Content Type]] and select '''Add Behavior'''		#* Right-click the Content Type and select '''Add Behavior'''
	#* Choose '''Export Behavior''' from the list of available behaviors		#* Choose '''Export Behavior''' from the list of available behaviors
	#* Click '''OK'''		#* Click '''OK'''

	The Export Behavior will appear in the "Behaviors" ~~section of~~ the Content Type's property grid.		The Export Behavior will appear in the "Behaviors" collection in the Content Type's property grid.

	=== Step 2: Add a Data Export definition ===		=== Step 2: Add a Data Export definition ===

Dgreenwood: /* Alternate Database */

2026-02-05T21:20:03Z

Alternate Database

← Older revision		Revision as of 16:20, 5 February 2026
Line 82:		Line 82:
	</pre>		</pre>

	=== Alternate Database ===		=== Alternate Database (Optional) ===

	The "Alternate Database" property allows you to specify an expression that calculates the name of an alternate database to which data will be exported. This is useful for:		The "Alternate Database" property allows you to specify an expression that calculates the name of an alternate database to which data will be exported. This is useful for: