Export Definition

Defines export connectivity to external systems such as file systems, content management repositories, databases, mail servers, and more.

Remarks

An Export Definition configures how Grooper exports documents, folders, and data to external systems. It is typically assigned within an Export Behavior on a Content Type or directly on an Export activity.

When an export operation runs, the Export Definition is responsible for:

• Transferring content and metadata from Grooper to the target system.
• Creating and attaching a Content Link to the exported Batch Folder or document, so Grooper can reference the exported item for future updates, auditing, or round-trip scenarios.
• Handling duplicate name conflicts using the 'Conflict Resolution' setting, which controls whether to error, generate a unique name, overwrite, or skip when a name collision occurs.
• Reporting export statistics, such as bytes exported, and providing diagnostic information for troubleshooting.

Export Definitions are extensible: you can implement custom export logic by deriving from this class and overriding the export method. This enables integration with virtually any external system that supports document or data ingestion.

Common scenarios include:

• Exporting documents to a network file share or Windows file system.
• Publishing content to an enterprise content management system or document repository.
• Sending documents as email attachments via a mail server.
• Writing extracted data to a database or line-of-business application.

For more information, see Export Behavior, Content Link, and the documentation for specific export provider implementations.

Properties

Name	Type		Description
Link Name	String	►	Specifies the name under which a Content Link should be saved. DefaultExport The 'Link Name' property determines the label assigned to the Content Link created during export. This name is used to identify the exported content link on the Batch Folder or document. If not set, a default value such as "Export" is typically used. You can use different link names to distinguish between multiple export destinations or export runs. The link name appears in the Grooper UI and can be referenced in downstream activities or scripts. Example: Set 'Link Name' to "CMIS Export" to clearly indicate that the link references a CMIS Repository export. Use different names like "Archive Export" or "Cloud Export" if exporting to multiple systems. <em>Tip: Use a descriptive link name to make it easier for users and automation to identify the correct exported content, especially when multiple links are present on a Batch Folder.</em>

Derived Types

There are 6 implementations of Export Definition.

CMIS Export	Defines an export to a CMIS Repository.
Data Export	Defines an export mapping between this content type and a database connection.
File Export	Exports content over a local network to the Windows file system.
FTP Export	Exports content using the FTP protocol.
Mail Export	Exports content to mail servers using the IMAP protocol.
SFTP Export	Exports content using the SFTP protocol.

Used By

Export Behavior