2.90:CMIS Export

From Grooper Wiki
Revision as of 11:26, 27 December 2019 by Configadmin (talk | contribs)

CIMS Export is one of the Export Providers available to the Document Export activity. It exports content over a CMIS connection, allowing users to export content to various external storage systems.

CMIS Exports can be either "Mapped" or "Unmapped".  Unmapped Export is a simple export of files to folders.  Mapped Export allows you to export files and their metadata (such as data extracted from documents to fields in a data model) to a repository by mapping the connection between objects in a Content Model within Grooper and the "CMIS Content Type".

Version Differences

2.72 CMIS+ Infrastructure

As of 2.72, Grooper utilizes what we call the CMIS+ infrastructure.  This unifies all content platforms under a single framework as CMIS endpoints.  Prior to version 2.72, there was only one type of CMIS Connection, a CMIS connection using CMIS 1.0 or CMIS 1.1 servers. Now, connections to additional non-CMIS document storage platforms can be made via "CMIS Bindings".

The settings and logic used to connect Grooper to an individual storage platform is contained in its corresponding CMIS Binding. For example, the AppXtender Binding contains all the information Grooper uses to connect to the ApplicationXtender content management system. Which binding you use (and therefore which platform you connect to) is set by creating a CMIS Connection and choosing the appropriate binding as the "Connection Type".

Using this architecture, Grooper is able to create a more standardized import and export workflow. You now use CMIS Import and CMIS Export providers regardless of the storage platform. They connect to a CMIS Repository imported from a CMIS Connection and use that as Grooper's import or export path.

Only how you create a CMIS Connection differs from CMIS Binding to CMIS Binding, as each binding has a different way of connecting to it (You don't connect to an Outlook inbox the same way you connect to a Windows file folder, for example).

2.72 Legacy Providers

Old import and export providers should be replaced with this new functionality. While Grooper's older import and export providers are available as "Legacy Import" and "Legacy Export" providers, these components are depreciated. They will still function but will no longer be upgraded in future versions of Grooper.

Grooper can import documents using CMIS Connections via "Import Descendents" and "Import Query Results". Grooper can export via the CMIS Export providers, Mapped Export and Unmapped Export.

2.72 New Connection Types

By creating the CMIS+ architecture, we have been able to create new connections between Grooper and content management systems. Grooper can now connect to Microsoft OneDrive, SharePoint, and Exchange via new CMIS Bindings. Since these were created as CMIS Bindings, they can be used by the CMIS Import and CMIS Export providers. Instead of having to create three new import providers and three new export providers for a total of six brand new components, we can use the already established CMIS import and export providers in the CMIS+ framework. A user can create a CMIS Connection using the OneDrive, SharePoint or Exchange Bindings, and use the same import and export providers for them as any of the other CMIS Bindings.

This will also allow Grooper to create CMIS Bindings to connect to currently unavailable content management systems in the future much quicker and easier.

Use Cases

Grooper has the ability to connect to the following storage platforms via the "Connection Type" property when adding a new CMIS Connection. Storage locations in these platforms are then available to CMIS Export as CMIS Repositories

Unmapped Export

Unmapped Export is the simpler of the two.  Both Unmapped and Mapped Exports will connect to CMIS Repositories (or CMIS bindings at least).  However, "Unmapped Export" exports content as simple folders and files.  You cannot utilize your Content Model to map metadata values to files and folders.  This is a much more "raw" export.  However, you can still export metadata "buddy files" along with your documents.

It is designed for use with CMIS Repositories using a hierarchical file system (HFS), where folders and files are represented by simple object types.  The Microsoft Windows file system, NTFS, is an example of an HFS.  These are basic folder and file structures.  So, they do not require mapped properties upon creation.

  • The following utilize simple HFS repositories and are suitable for "Unmapped Export":
    • NTFS
    • FTP
    • SFTP
    • OneDrive
    • IMAP
    • Exchange

Unmapped Export Property Settings

Because there are no values mapped here, this export provider completely ignores anything in the Content Types folder of your CMIS Repository.  Even if you added mapping information to your CMIS Content Type, Unmapped Export will pay no attention.  Any settings you want to adjust should be done in the Export Settings properties of the Document Export activity.


Property Default Value Information
General Properties
CMIS Repository Select a CMIS repository you have imported already from your CMIS Connections.

Once you select the repository, an additional property will populate to choose the "Target Folder". If nothing is selected, this will be the "Default Base Folder" of the CMIS Connection (The default base folder is set on the CMIS Content Type child objects of the CMIS Connection object in the node tree).

Update Link True If true, the Content Link on the document will be updated to the point at the exported content. It will change from whatever source it was imported from to whatever it was exported to.
Export Options
Content Format Native Here you can change the format of the document upon export, such as exporting it as a PDF. The default property is "Native". However, if no native file version exists Grooper will export a PDF version if possible. If neither a native file version or a PDF version exists, a TIFF file is created. Each Content Format selection has its own editable properties as well.
Metadata Export (none) Adjusting this property will allow you to export a metadata "buddy file" with your documents. It can be one of three values.
  • Text - Exports metadata as a text file as a CSV or INI file type.
  • Custom - Exports a custom named file, which was previously generated and saved by another activity, such as XML Transform.
  • XML - Exports standard Grooper XML representing the document's metadata.
Path Cloning Disabled Enables or disables path cloning. Refer to the Path Cloning article for more information.
Ignore Mapped Items False A Batch Folder object is "unmapped" both if no Content Type is assigned or if the Content Type is assigned but it has no export mappings defined.

If true, the export process will ignore mapped items. If false, mapped items will be exported along with unmapped ones.

Version Differences

New to 2.72, the "Link" object can expose several new CMIS properties to field expressions.

  • Link.Name - Returns cmis:name
  • Link.CreatedBy - Returns cmis:createdBy
  • Link.CreatedTime - Returns cmis:creationDate
  • Link.LastModifiedBy - Returns cmis:lastModifiedBy
  • Link.LastModifiedTime - Returns cmis:lastModificationDate
  • Link.AsDocument.MimeType - Returns cmis:contentStreamMimeType
  • Link.AsDocument.Filename - Returns cmis:contentStreamFilename

There is also a new method available to return CMIS properties in field expressions:

  • Link.GetCustomValue (Name)
    • Returns the value of a CMIS property
    • "Name" can be the ID, query name, or display name of a property
      • Ex: Link.GetCustomValue ("invoice_no")

Mapped Export

Mapped Export is much more powerful. Mapped Export creates a document in a CMIS Repository for each Batch Folder in your Batch.  Using this export provider, you can copy all the relevant data you've collected to wherever you want your documents to go. Or in other words, you can map properties from your Content Model, such as data fields, to an external CMIS repository.

Similar to the pre-2.72 CMIS Export, Mapped Export uses pre-defined mappings.  These mappings are set on the CMIS Content Type object.  Here, we will match fields from the outside content management provider with the associated fields, variables and values from our Content Type in Grooper.  The Grooper Content Type assigned to the Batch Folder determines the rules for exporting each item.  Because of this, all documents processed through Mapped Export must be classified.  You can't get a Content Type without classifying the batch.  So, Grooper wouldn't have any information on how to map the documents.

To perform a Mapped Export, you must enable exporting on the repository's CMIS Content Type. Below shows you to set up the CMIS Content Type object to map values when exporting.

How To:  Set Up the Repository's Export Settings

In the node tree, navigate to the repository you want to export to under your CMIS connection established in the "CMIS Connections" folder under the "Infrastructure" folder.



By default, the "Export Enabled" property is set to "False". Change this to "True" in order to export to the repository.



The "Export Content Type" property is where you assign the Content Type. This can be any element of a Content Model or the whole model itself. Be careful. If you choose a content model not associated with the batch you want to export, you won't actually export any documents. The Content Type you assign on the export step must match the Content Type you assign here. Otherwise, Grooper is going to get real confused. It will probably act like it exported your documents without actually populating anything in the content management system.



Select the "Export Field Mappings" property to assign your mappings.



The "Property Mapping Control" window will pop up. This list will automatically appear based on how you set up your repository in whichever content management system you are using. The example below is an ApplicationXtender connection. It has just one field from our data model tied to it. Document Type can be assigned according to how these documents were classified. Date Created is a read-only value that will be populated in ApplicationXtender when the documents are imported.



If needed, you can also update "Parent Content Types" and adjust folder level settings and mapping as well. You can also change the default base folder and content format here as well.



Press the "Save" button.



Once you've set this up, you can export to the CMIS repository during the Document Export activity using the Mapped Export provider. You will select the CMIS Repository you wish to connect to using the "Export Settings" properties of Document Export.

Once the Document Export activity runs, your documents' extracted data will be mapped to their corresponding locations in whichever content management system you choose, according to how you defined it on the CMIS Content Type.

Furthermore, Grooper now supports transfer of multi-level objects between Grooper and CMIS.  If your content management system is set up as folders with documents inside, Grooper will import and export seamlessly.  If you have a repository with folders A, B, and C with their own levels of foldering and documents inside, Grooper will retain the hierarchical structure when exporting. This is common with student records, personnel files, case files, and well records.


Version Differences

Grooper Version 2.72 introduces simplified field mappings for Mapped Export.  Fields can now be mapped as they are defined at the root of the Data Model.

If your Data Model looks like the one below with fields in several different sections...

 ...when you go to map them to (or from) a CMIS repository, the dropdown list will be structured like your Data Model, from top to bottom with each heading listed before the field. This makes it much easier to find which field you're looking for.

Export Settings

After you have your field mappings set up, you will further configure the export using the properties in the Export Settings properties of the Document Export activity.


Property Default Value Information
General Properties
CMIS Repository Select a CMIS repository you have imported already from your CMIS Connections.

Once you select the repository, an additional property will populate to choose the "Target Folder". If nothing is selected, this will be the "Default Base Folder" of the CMIS Content Type.

Update Link True If true, the Content Link on the document will be updated to the point at the exported content. It will change from whatever source it was imported from to whatever it was exported to.
Export Options
Content Format Native Here you can change the format of the document upon export, such as exporting it as a PDF. The default property is "Native". However, if no native file version exists Grooper will export a PDF version if possible. If neither a native file version or a PDF version exists, a TIFF file is created. Each Content Format selection has its own editable properties as well.
Metadata Export (none) Adjusting this property will allow you to export a metadata "buddy file" with your documents. It can be one of three values.
  • Text - Exports metadata as a text file as a CSV or INI file type.
  • Custom - Exports a custom named file, which was previously generated and saved by another activity, such as XML Transform.
  • XML - Exports standard Grooper XML representing the document's metadata.
Path Cloning Disabled Enables or disables path cloning. Refer to the Path Cloning article for more information.
Ignore Mapped Items False A Batch Folder object is "unmapped" both if no Content Type is assigned or if the Content Type is assigned but it has no export mappings defined.

If true, the export process will ignore mapped items. If false, mapped items will be exported along with unmapped ones.

Retrieved from "https://wiki.grooper.com/index.php?title=2.90:CMIS_Export&oldid=815"