NTFS (CMIS Binding)

This article is about the current version of Grooper. Note that some content may still need to be updated.
2025	2023	2.72

NTFS is a connection option for cloud CMIS Connections. It connects Grooper to files and folders in the Microsoft Windows NTFS file system for import and export operations.

The connected NTFS folder or folders are exposed as a CMIS Repository, mimicking its file system hierarchy as well. Once connected, you can import, export, search, and browse documents from Grooper.

The NTFS binding can be used for import operations via CMIS Import using either "Import Descendants" or "Import Query Results". It can be used for export operations via the Document Export activity.

NTFS folders use a a hierarchical file system (HFS), where folders and files are represented by simple object types.  As such, this binding is suitable for the Unmapped Export provider rather than the Mapped Export provider.  You can still export metadata as a "buddy file" by adjusting the "Metadata Export" property in the Document Export activity's Export Settings.

⚠

Paths should be specified as UNC paths (ex: \\DomainName\Path\).  Grooper does give you the option to search for and use Windows system paths.  However, you probably should not.  These paths may not be accessible to other processors, users or machines.  For example, if you create a repository using a local path to your Documents folder and you export a batch using that NTFS binding to another user on another machine, the batch process is going to look for a repository on their local drive, not yours.

How To: Create a New NFTS Connection

Click here for an interactive walkthrough

There are two optional properties.

• Read Only - Change this to "True" if you want these folders to be read only.  This can be useful to prevent unintentional changes to the file system if you only need the connection to a file system for imports.
• Enable Search - Set this to "True" to enable search functionality.  If this option is enabled, the contents of Base Path must be indexed by the Windows Search service. This means (a) Windows Search must be running on the storage server; and (b) the directory represented by Base Path must be included in the index.  Refer to Microsoft documentation for instructions on how to enable Windows Search on Server 2008, Server 2012, or Server 2016. Use Control Panel / Indexing Options to modify the list of directories included in the index.

Known Issues & Limitations

NTFS CMISQL Query Limitations

The NTFS connection binding will not support the CONTAINS() predicate (for full text searching) unless the Windows file system has been indexed by the Windows Search Service.

Importing and Exporting using NTFS

Importing

Submitting an Import Job

Click here for an interactive walkthrough

1. On the Grooper Home Screen, click the Imports icon.

2. You will need to have an Import Watcher service installed and running before submitting an Import Job.

1. Click the Add New Import Jobs button.
2. Within the Submit Import Job window, you will need to add a Description.
   • This will not have any affect on your Batch or Batch Process.
3. Select the Import Descendants Provider.
4. Next, choose your NTFS Repository.
5. Configure your Base Folder if need be.
6. Import Filter will be defaulted to SELECT * FROM File . This selects all files from the import location.
7. Expand the Batch Creation property and expose the Starting Step sub-property. Choose a step from your published Batch Process where you want Grooper to begin processing once the Batch is imported.
8. The Batch is named after the date and time which it is imported; you have options to add additional configurations such as:
   • Prefix
   • Suffix
   • Segments
   • Changes to the Date Format
9. When everything is finished, click "Submit" to submit the Import Job.
10. Grooper will display the details of your Import Job, including the status which you should see go from "Ready" to "Working", and finally to "Completed".

Exporting

Configure an Export Behavior

Click here for an interactive walkthrough

1. Click ... at the end of the Behaviors property to begin configuring.

   • Export Behaviors can be configured on any Content Type Node Object; either Content Models, Document Types, or Content Categories.

2. Click the Add button within the Behaviors List window and choose Export Behavior from the dropdown list.
3. Next, set up the Export Definition. Click ... at the end of the Export Definitions property.
4. Click the Add button within the Definitions List Window and select CMIS Export.
5. To choose the Repository you'll be exporting to, click ☰ at the end of the CMIS Repository property
6. Select the NTFS Repository.
7. To choose a specific folder where the Batch content will be exported to, click ... at the end of the Target Folder property; otherwise, your Documents will be exported to the root folder of the NTFS Repository.
8. Select the Target Folder.
9. Define the Object Type by clicking ☰ and selecting an option from the dropdown menu.
10. Configure Read Mappings, Write Mappings, and the Export Format if need be.
11. Click OK when satisfied with the Export Definition.
12. Click OK to finalize the Export Behavior.
13. Save.

See Also

For more information to use your CMIS Connection once its created, see the following articles:

• CMIS Export
• CMIS Import