Export Definition: Difference between revisions

From Grooper Wiki
← Older editNewer edit →
m Dgreenwood moved page Export Definitions (Property) to Export Definition Types without leaving a redirect
No edit summary
Line 1: Line 1:
<blockquote>{{#lst:Glossary|Export Definition}}</blockquote>
<blockquote>{{#lst:Glossary|Export Definition}}</blockquote>


== How To: Set up an Export Definition ==
== About Export Definitions ==
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.  
 
'''Export Definitions''' are key to exporting document content from Grooper to an end destination, such as file systems, content management systems, and databases.
 
* One or more Export Definitions are added to an '''Export Behavior'''.
* The '''Export''' activity executes each Export Definition for each Batch Folder.
 
Export Definitions functionally determine three things:
 
* '''Destination''' – Where the document content ends up upon export. In other words, the storage platform you are exporting to.
* '''Content''' – What document content is exported: attached file content, Batch Page images, full text/OCR data, and/or extracted data from a Data Model.
* '''File Format''' – What format the exported content takes, such as a PDF file or XML data file.
** <li class="fyi-bullet"> Not applicable to Data Export. Files are not generated from document content for this Export Definition. Only Data Model data is exported. </li>
 
=== How To: Add an Export Definition to an Export Behavior ===
 
An Export Definition, as the name implies, defines the connection to a storage destination outside of Grooper. How this connection is made varies depending on the export method.


[https://app.supademo.com/demo/cmbi4gtoh00l4z20i9fe12mvj Click here for an interactive walkthrough]
[https://app.supademo.com/demo/cmbi4gtoh00l4z20i9fe12mvj Click here for an interactive walkthrough]


# Click <code> ... </code> on the Export Definitions property to bring up the Export Definitions list window.
# Click <code>...</code> on the Export Definitions property to open the Export Definitions list window.
# Click the Add button to access the dropdown list.
# Click the '''Add''' button to access the dropdown list.
# Select an Export Definition from the list.
# Select an Export Definition from the list.
#* You can have more than one Export Definition configured on an Export Behavior.
#* You can have more than one Export Definition configured on an Export Behavior.


== Types of Export Definitions ==
=== Types of Export Definitions ===
=== CMIS Export ===
 
With a CMIS Export, Batch Contents are exported from Grooper to a CMIS Repository via CMIS Connection.
==== CMIS Export ====
 
With a CMIS Export, document content is exported from Grooper to a CMIS Repository via a CMIS Connection.


[https://app.supademo.com/demo/cmbje0r0603pf1d0it7ruag2g Click here for an interactive walkthrough]
[https://app.supademo.com/demo/cmbje0r0603pf1d0it7ruag2g Click here for an interactive walkthrough]


# Click the add button within the Export Definitions list window and select CMIS Export.
# Click the '''Add''' button within the Export Definitions list window and select '''CMIS Export'''.
# Click the hamburger icon on the CMIS Repository property to expose the Node Object list and click through until selecting the desired CMIS Repository.
# Click the hamburger icon on the '''CMIS Repository''' property to expose the Node Object list, then navigate to and select the desired CMIS Repository.
#* <li class="fyi-bullet"> You will need to have a CMIS Connection created and a Repository imported FIRST before configuring this Export Definition. </li>
#* <li class="fyi-bullet"> You will need to have a CMIS Connection created and a Repository imported FIRST before configuring this Export Definition. </li>
# Define the CMIS Content being exported by selecting the Object Type.
# Define the CMIS content being exported by selecting the '''Object Type'''.
# The Target Folder property is defaulted to the root of the Repository; if you want to export to a specific folder, configure this property.
#* <li class="fyi-bullet"> Most typically, this will be the CMIS type that corresponds to a "document" for the destination CMIS Repository. </li>
# Configure additional properties if necessary.
# The '''Target Folder''' property defaults to the root of the repository. Configure this property if you want to export to a specific folder.
# When finished, click OK.
# Configure one or more [[Export Format]]s.
#* <li class="fyi-bullet"> There are Export Format options for PDF and TIFF, as well as JSON and other text-based files suitable for data extracted from a document's Data Model. </li>
# Configure additional properties as needed.
# Click '''OK''' when finished.
 
==== Data Export ====


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


[https://app.supademo.com/demo/cm7tkuuvd259bhilggjc1819e Click here for an interactive walkthrough]
[https://app.supademo.com/demo/cm7tkuuvd259bhilggjc1819e Click here for an interactive walkthrough]


# Click the '''Add''' button within the Export Definitions list window and select '''Data Export'''.
#* <li class="fyi-bullet"> You will need to have created a Data Connection within Grooper before configuring the Export Definition. </li>
# Expand the '''Connection''' dropdown (click the ☰ button) and select the Data Connection from the Node selector.
# Configure '''Table Mappings'''.
# Configure '''Custom Statements''' (optional).
# Click '''OK''' when finished.


# Click the add button within the Export Definitions list window and select Data Export.
==== File Export ====
#:*<li class ="fyi-bullet"> You will need to have created a Data Connection within Grooper before configuring the Export Definition </li>
# Select the Connection property and click <code> "☰" </code> to expose the Node Object menu and select the Data Connection
# Configure Table Mappings
# Configure Custom Statements
# Click OK when finished.


=== File Export ===
With File Export, document content is exported from Grooper to a folder within a Windows file system.
For File Export, Documents are exported form Grooper to a folder within a Windows file system.


[https://app.supademo.com/demo/cmbktvg4x004sya0ihhmxmwu5 Click here for an interactive walkthrough]
[https://app.supademo.com/demo/cmbktvg4x004sya0ihhmxmwu5 Click here for an interactive walkthrough]


# Click the add button within the Export Definitions list window and select File Export.
# Click the '''Add''' button within the Export Definitions list window and select '''File Export'''.
# Enter the UNC path of the folder where you plan to export your documents within the Target Folder property.
# Enter the UNC path of the target folder in the '''Target Folder''' property.
# If you have a specific sub-folder where you would like to export your Documents to, define it within the Relative Path property.
# If you want to export to a specific subfolder, define it in the '''Relative Path''' property.
# 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.
# Configure one or more [[Export Format]]s.
# When finished, click OK.
#* <li class="fyi-bullet"> There are Export Format options for PDF and TIFF, as well as JSON and other text-based files suitable for data extracted from a document's Data Model. </li>
# Click '''OK''' when finished.
 
{| class="attn-box"
|
&#9888;
|
'''''File Export is old. CMIS Export is better.'''''
 
The File Export definition is an older method of exporting to the Windows file system in Grooper.
 
* File Export exists for backward compatibility.
* It can still be used for simple exports to Windows folders, but no further development of this feature will occur.
 
For better long-term support, use the [[CMIS Export]] definition with an [[NTFS]] CMIS Repository to export documents to Windows file folders.
|}


=== FTP Export ===
==== FTP Export ====
The FTP Export Definition sends Documents from Grooper to an FTP site using an FTP Protocol.
 
The FTP Export Definition sends documents from Grooper to an FTP site using the FTP protocol.


[https://app.supademo.com/demo/cm7utzdsi2w4ahilgezfulorx Click here for an interactive walkthrough]
[https://app.supademo.com/demo/cm7utzdsi2w4ahilgezfulorx Click here for an interactive walkthrough]


# Click the add button within the Export Definitions list window and select FTP Export
# Click the '''Add''' button within the Export Definitions list window and select '''FTP Export'''.
# Enter the name of the FTP Server URL
# Enter the FTP server URL.
# Click OK.
# Configure one or more [[Export Format]]s.
#* <li class="fyi-bullet"> There are Export Format options for PDF and TIFF, as well as JSON and other text-based files suitable for data extracted from a document's Data Model. </li>
# Click '''OK'''.
 
{| class="attn-box"
|
&#9888;
|
'''''FTP Export is old. CMIS Export is better.'''''
 
The FTP Export definition is an older method of exporting to FTP sites in Grooper.
 
* FTP Export exists for backward compatibility.
* It can still be used for simple exports to FTP folders, but no further development of this feature will occur.
 
For better long-term support, use the [[CMIS Export]] definition with an [[FTP]] CMIS Repository to export documents to SFTP folders.
|}
 
==== SFTP Export ====


=== SFTP Export ===
SFTP Export sends document content to an SFTP site using the SFTP protocol.
SFTP Export exports Documents to an SFTP site through an SFTP Protocol.


[https://app.supademo.com/demo/cmbp5piiu02fq460irkicdwzc Click here for an interactive walkthrough]
[https://app.supademo.com/demo/cmbp5piiu02fq460irkicdwzc Click here for an interactive walkthrough]


# Click the add button within the Export Definitions list window and select SFTP Export.
# Click the '''Add''' button within the Export Definitions list window and select '''SFTP Export'''.
# Enter the host name for the server.
# Enter the server host name.
# Click OK.
# Configure one or more [[Export Format]]s.
#* <li class="fyi-bullet"> There are Export Format options for PDF and TIFF, as well as JSON and other text-based files suitable for data extracted from a document's Data Model. </li>
# Click '''OK'''.
 
{| class="attn-box"
|
&#9888;
|
'''''SFTP Export is old. CMIS Export is better.'''''
 
The SFTP Export definition is an older method of exporting to SFTP sites in Grooper.
 
* SFTP Export exists for backward compatibility.
* It can still be used for simple exports to SFTP folders, but no further development of this feature will occur.
 
For better long-term support, use the [[CMIS Export]] definition with an [[SFTP]] CMIS Repository to export documents to SFTP folders.
|}
 
==== Mail Export (seldom used) ====


=== Mail Export ===
Mail Export (formerly IMAP Export) exports documents as email messages to a mail server using the IMAP protocol. The export operation appends each document as a new message in the specified mail folder.
Mail Export (formerly called IMAP Export) exports Documents to a mail server using IMAP protocol.


[https://app.supademo.com/demo/cmbl63fup00a5ug0ixkploizh Click here for an interactive walkthrough]
[https://app.supademo.com/demo/cmbl63fup00a5ug0ixkploizh Click here for an interactive walkthrough]


# Click the add button within the Export Definitions list window and select Mail Export.
# Click the '''Add''' button within the Export Definitions list window and select '''Mail Export'''.
# Enter the name of the Mail Server.
# Enter the mail server name.
# Enter the username and password needed for Grooper to access the mail server.
# Enter the username and password Grooper will use to access the mail server.
# Click OK.
# Click '''OK'''.

Revision as of 17:27, 9 February 2026

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.

About Export Definitions

Export Definitions are key to exporting document content from Grooper to an end destination, such as file systems, content management systems, and databases.

  • One or more Export Definitions are added to an Export Behavior.
  • The Export activity executes each Export Definition for each Batch Folder.

Export Definitions functionally determine three things:

  • Destination – Where the document content ends up upon export. In other words, the storage platform you are exporting to.
  • Content – What document content is exported: attached file content, Batch Page images, full text/OCR data, and/or extracted data from a Data Model.
  • File Format – What format the exported content takes, such as a PDF file or XML data file.
    • Not applicable to Data Export. Files are not generated from document content for this Export Definition. Only Data Model data is exported.

How To: Add an Export Definition to an Export Behavior

An Export Definition, as the name implies, defines the connection to a storage destination outside of Grooper. How this connection is made varies depending on the export method.

Click here for an interactive walkthrough

  1. Click ... on the Export Definitions property to open 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, document content is exported from Grooper to a CMIS Repository via a 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, then navigate to and select 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.
    • Most typically, this will be the CMIS type that corresponds to a "document" for the destination CMIS Repository.
  4. The Target Folder property defaults to the root of the repository. Configure this property if you want to export to a specific folder.
  5. Configure one or more Export Formats.
    • There are Export Format options for PDF and TIFF, as well as JSON and other text-based files suitable for data extracted from a document's Data Model.
  6. Configure additional properties as needed.
  7. Click OK when finished.

Data Export

A Data Export sends extracted data from documents 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. Expand the Connection dropdown (click the ☰ button) and select the Data Connection from the Node selector.
  3. Configure Table Mappings.
  4. Configure Custom Statements (optional).
  5. Click OK when finished.

File Export

With File Export, document content is exported from 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 target folder in the Target Folder property.
  3. If you want to export to a specific subfolder, define it in the Relative Path property.
  4. Configure one or more Export Formats.
    • There are Export Format options for PDF and TIFF, as well as JSON and other text-based files suitable for data extracted from a document's Data Model.
  5. Click OK when finished.

⚠

File Export is old. CMIS Export is better.

The File Export definition is an older method of exporting to the Windows file system in Grooper.

  • File Export exists for backward compatibility.
  • It can still be used for simple exports to Windows folders, but no further development of this feature will occur.

For better long-term support, use the CMIS Export definition with an NTFS CMIS Repository to export documents to Windows file folders.

FTP Export

The FTP Export Definition sends documents from Grooper to an FTP site using the 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 FTP server URL.
  3. Configure one or more Export Formats.
    • There are Export Format options for PDF and TIFF, as well as JSON and other text-based files suitable for data extracted from a document's Data Model.
  4. Click OK.

⚠

FTP Export is old. CMIS Export is better.

The FTP Export definition is an older method of exporting to FTP sites in Grooper.

  • FTP Export exists for backward compatibility.
  • It can still be used for simple exports to FTP folders, but no further development of this feature will occur.

For better long-term support, use the CMIS Export definition with an FTP CMIS Repository to export documents to SFTP folders.

SFTP Export

SFTP Export sends document content to an SFTP site using the 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 server host name.
  3. Configure one or more Export Formats.
    • There are Export Format options for PDF and TIFF, as well as JSON and other text-based files suitable for data extracted from a document's Data Model.
  4. Click OK.

⚠

SFTP Export is old. CMIS Export is better.

The SFTP Export definition is an older method of exporting to SFTP sites in Grooper.

  • SFTP Export exists for backward compatibility.
  • It can still be used for simple exports to SFTP folders, but no further development of this feature will occur.

For better long-term support, use the CMIS Export definition with an SFTP CMIS Repository to export documents to SFTP folders.

Mail Export (seldom used)

Mail Export (formerly IMAP Export) exports documents as email messages to a mail server using the IMAP protocol. The export operation appends each document as a new message in the specified mail folder.

Click here for an interactive walkthrough

  1. Click the Add button within the Export Definitions list window and select Mail Export.
  2. Enter the mail server name.
  3. Enter the username and password Grooper will use to access the mail server.
  4. Click OK.
Retrieved from "https://wiki.grooper.com/index.php?title=Export_Definition&oldid=32403"