Export Definition Types

From Grooper Wiki

Export Behaviors are defined by adding and configuring one or more Export Definitions (See Export Definition Types or the Export Definitions section of the Export article). An Export Definition defines export parameters to external systems, such as file systems, content management repositories, databases, or mail servers.

How To: Set up an Export Definition

An Export Definition, as the name states, defines the connection to a storage destination outside of Grooper. How this connection is made varies from method to method.

Click here for an interactive walkthrough

  1. Click ... on the Export Definitions property to bring up the Export Definitions list window.
  2. Click the Add button to access the dropdown list.
  3. Select an Export Definition from the list.
    • You can have more than one Export Definition configured on an Export Behavior.

Types of Export Definitions

CMIS Export

With a CMIS Export, Batch Contents are exported from Grooper to a CMIS Repository via CMIS Connection.

Click here for an interactive walkthrough

  1. Click the add button within the Export Definitions list window and select CMIS Export.
  2. Click the hamburger icon on the CMIS Repository property to expose the Node Object list and click through until selecting the desired CMIS Repository.
    • You will need to have a CMIS Connection created and a Repository imported FIRST before configuring this Export Definition.
  3. Define the CMIS Content being exported by selecting the Object Type.
  4. The Target Folder property is defaulted to the root of the Repository; if you want to export to a specific folder, configure this property.
  5. Configure additional properties if necessary.
  6. When finished, click OK.

Data Export

A Data Export sends extracted data from Grooper to a SQL database via a Data Connection

Click here for an interactive walkthrough


  1. Click the add button within the Export Definitions list window and select Data Export.
    • You will need to have created a Data Connection within Grooper before configuring the Export Definition
  2. Select the Connection property and click "☰" to expose the Node Object menu and select the Data Connection
  3. Configure Table Mappings
  4. Configure Custom Statements
  5. Click OK when finished.

File Export

For File Export, Documents are exported form Grooper to a folder within a Windows file system.

Click here for an interactive walkthrough

  1. Click the add button within the Export Definitions list window and select File Export.
  2. Enter the UNC path of the folder where you plan to export your documents within the Target Folder property.
  3. If you have a specific sub-folder where you would like to export your Documents to, define it within the Relative Path property.
  4. If you want to export your Documents as a JSON file, Text File, or a PDF, you can do so by adding an Export Format.
  5. When finished, click OK.

FTP Export

The FTP Export Definition sends Documents from Grooper to an FTP site using an FTP Protocol.

Click here for an interactive walkthrough

  1. Click the add button within the Export Definitions list window and select FTP Export
  2. Enter the name of the FTP Server URL
  3. Click OK.

SFTP Export

SFTP Export exports Documents to an SFTP site through an SFTP Protocol.

Click here for an interactive walkthrough

  1. Click the add button within the Export Definitions list window and select SFTP Export.
  2. Enter the host name for the server.
  3. Click OK.

Mail Export

Mail Export (formerly called IMAP Export) exports Documents to a mail server using IMAP protocol.

Click here for an interactive walkthrough

  1. Click the add button within the Export Definitions list window and select Mail Export.
  2. Enter the name of the Mail Server.
  3. Enter the username and password needed for Grooper to access the mail server.
  4. Click OK.