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.

NTFS (or New Technology File System), is the main file system used by Windows operating systems. In Grooper, the NTFS binding is used to connect to folder directories in a Windows file system on a networked computer.

The NTFS binding can be selected as a connection option when configuring a CMIS Connection. After configuring the connection, the Windows file system is exposed to Grooper as a CMIS Repository. CMIS Repository nodes are created as children of the CMIS Connection by importing a reference to their source location.

The NTFS CMIS Repository mimics the Windows file system hierarchy as well. Once a CMIS Repository is created, you can import, export, search, and browse files from Grooper.

• The NTFS binding can be used for import operations via CMIS Import using "Import Descendants" or "Import Query Results".
  • Import Query Results can only be used if files and folders are indexed by the Windows Search service. CMIS Queries are not supported unless files and folders have previously been indexed by the Windows Search service. The CMIS Connection's "Enable Search" property must also be enabled.
• It can be used for export operations via CMIS Export.
  • The NTFS binding has minimal writable properties for exported documents: "Name" and four Boolean properties ("Archive", "Hidden", "Read Only" and "System"). As such, this binding is unsuitable for "mapped exports". However, you can still export metadata as a "buddy file" by adding a metadata format in your CMIS Export definition.

⚠	Always use fully qualified UNC paths (ex: \\hostname\path\). DO NOT use local drive letters (ex: C:\path) when entering paths. This will ensure content is imported from and exported to the right machine on the network.

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. 
    • If disabled, Windows Search can be started from the "Services" manager on the machine (Search for "Services" or "Administrative Tools" and open "Services". Find "Windows Search" in the list and start it).
    • If enabled but the folder is not indexed, open the Windows Control Panel and go to "Indexing Options". Select "Modify" to add the folder. The service may take a while to index the contents, depending on how many files there are and how large they are.

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