Export Provider

From Grooper Wiki
Jump to navigation Jump to search
This guidance is somewhat obsolete in version 2021. Export operations have changed with the incorporation of Export Behaviors. However, Export Providers are somewhat analogous to adding an Export Type to an Export Behavior configuration.

Furthermore, the Document Export activity no longer exists in version 2021. It is replaced with the Export activity.

Visit the Export (Activity) article for more current information.


Export Providers are used by the Document Export activity to define where and how Grooper content is exported.

Which Export Provider you choose will determine where your processed content in Grooper (including documents and their metadata) are exported. They allow you to define the connection type when exporting outside of Grooper, such as file systems, content management repositories, or mail servers.

There are two categories of Export Providers: CMIS Export and Legacy Export

CMIS Export uses Grooper's CMIS+ architecture to export documents to various storage platforms, using CMIS Connections connecting to specific platforms using CMIS Bindings.

The Legacy Export providers only exist to provide backwards compatibility. Their storage platform endpoints have CMIS Binding analogues suitable for CMIS Export. For example, the legacy Mail Export provider has a corresponding IMAP binding, allowing CMIS Export to export to IMAP mail servers. CMIS Export should be prioritized over Legacy Export going forward.

CMIS Export

CMIS Export has two different provider types:

These export providers use connections to storage platforms using Grooper's CMIS+ architecture. Connections are created as "bindings" modeled after the CMIS standard. CMIS Connections can be created to the following storage platforms for Mapped and/or Unmapped Export.

  • The ApplicationXtender document management platform.
  • The FileBound document management platform.
  • Content management systems using CMIS 1.0 or CMIS 1.1 servers.
  • The following Microsoft content platforms
    • The Microsoft Exchange mail server platform.
    • The Microsoft OneDrive cloud storage platform.
    • Microsft SharePoint sites.
  • The Box.com cloud document storage platform.
  • FTP (File Transfer Protocal) and SFTP (SSH File Transfer Protocal) servers.
  • IMAP (Internet Message Access Protocol)mail servers
  • The Microsoft Windows NTFS file system.

Mapped Export differs from Unmapped Export in that information from a Content Model, such as a document's classified Document Type and extracted data in a Data Model, can be exported as well. The metadata is "mapped" from Grooper to the storage platform. Unmapped Export is a simpler export. Processed files are simply exported according to the format you choose in Grooper (such as PDF or TIFF). Metadata is not mapped to any location in the storage platform. However, a metadata "buddy file" can be created alongside the document (such as a CSV or XML file).

For more information on CMIS Export visit the full article.

Legacy Export

The Legacy Export providers are the export providers used for document export operations prior to the switch to Grooper's CMIS+ infrastructure in version 2.72. These are depreciated Grooper components.  Depreciated means they are still available for use, just not recommended.  No further improvements or updates will be made to these provider types. The old components have been replaced by new CMIS Bindings with increased functionality and better performance.  By and large, these legacy providers operate the same as they did in previous versions.

  • There are four Legacy Export providers:
    • File System Export - This provider exports content over a local network to the Windows file system.
    • FTP Export - This provider exports content using the FTP and FTPS protocols.
    • Mail Export - This provider exports content to mail servers using the IMAP protocol.
    • SFTP Export - This provider exports content using the SFTP protocol.

However, going forward, output operations should be implemented using the new CMIS Bindings and CMIS Export.  There are two main differences.  Connection settings found in 'Export Settings in the legacy providers will be entered in the connection settings of whichever Connection Type is selected.  What file path or server you're connecting to and any login credentials necessary will be entered there.  Two, you will need to "import repositories" in order to export to them.  Refer to the CMIS Connection article for information about setting up a CMIS Connection and importing repositories.