2023:NTFS (CMIS Binding): Difference between revisions

From Grooper Wiki
Created page with "frame <blockquote style="font-size:14pt">The '''NTFS''' Connection Type is a CMIS Binding that connects Grooper to files and folders in the Windows file system. </blockquote> 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 Impor..."
 
 
(20 intermediate revisions by 3 users not shown)
Line 1: Line 1:
[[image:1559333985695-475.png|frame]]
{{AutoVersion}}


<blockquote style="font-size:14pt">The '''NTFS''' Connection Type is a CMIS Binding that connects Grooper to files and folders in the Windows file system.
[[File:2023_NTFS_CMIS_Binding_00.png|frame]]
</blockquote>
 
<blockquote>{{#lst:Glossary|NTFS}}</blockquote>


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 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.
Line 10: Line 11:
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 [[CMIS Export#Unmapped Export|Unmapped Export]] provider rather than the [[CMIS Export#Mapped Export|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.
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 [[CMIS Export#Unmapped Export|Unmapped Export]] provider rather than the [[CMIS Export#Mapped Export|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.


{|cellpadding="10" cellspacing="5"
{|class="attn-box"
|-style="background-color:#f89420; color:white"
|
|style="font-size:14pt|'''!'''||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.
&#9888;
|
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.
|}
|}
== Version Differences ==
Prior to version 2.72, connections to the Windows file system would have used the File System Import and File System Export providers. While these providers still exists in Grooper as Legacy Import and Legacy Export providers, they are depreciated components and no longer recommended for use. For increased functionality in 2.72, create an NTFS Connection Type and utilize the new CMIS Import and CMIS Export capabilities.


== How To: Create a New NFTS Connection ==
== How To: Create a New NFTS Connection ==
Line 23: Line 22:
<tabs>
<tabs>
<tab name="Step 1">
<tab name="Step 1">
Expand the "Infrastructure" node.  Right click the "CMIS Connections" folder.  Mouse over "Add" and select "CMIS Connection...".
{|
 
[[File:2023_NTFS_CMIS_Binding_How_To_Create_a_New_NTFS_Connection_Step_1_01.png]]
 
[[image:1559583545910-473.png|center]]


|}


</tab>
</tab>
<tab name="Step 2">
<tab name="Step 2">
In the "Connection Properties" panel, select "NTFS" from the "Connection Type" drop down list. Expand the "Connection Settings" heading.  Select "Repositories" and press the ellipsis button at the end of the line.
{|
 
[[File:2023_NTFS_CMIS_Binding_How_To_Create_a_New_NTFS_Connection_Step_2_01.png]]
 
<br>
[[image:1559335275348-258.png|center]]
<br>
 
|-
 
[[File:2023_NTFS_CMIS_Binding_How_To_Create_a_New_NTFS_Connection_Step_2_02.png]]
<br>
<br>
|-
[[File:2023_NTFS_CMIS_Binding_How_To_Create_a_New_NTFS_Connection_Step_2_03.png]]
|}
</tab>
</tab>
<tab name="Step 3">
<tab name="Step 3">
This brings up the "Repository Configuration Collection Editor".  Here, you can enter one or more UNC paths to folders on a network.  Press "Add" to enter a new path, establishing the folder at the end of that path as a repository.
{|




[[image:1559336053051-487.png|center]]
[[File:2023_NTFS_CMIS_Binding_How_To_Create_a_New_NTFS_Connection_Step_3_01.png]]
 
<br>
<br>
|-


There are two optional properties.
There are two optional properties.
Line 50: Line 55:
* '''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 [https://support.microsoft.com/en-us/help/954822/how-to-install-and-configure-the-indexing-service-on-a-windows-server Server 2008], [https://social.technet.microsoft.com/Forums/en-US/3e705b51-7218-407e-b5c8-429e20557ed4/how-to-configure-indexing-service-in-windows-server-2012 Server 2012], or [https://support.microsoft.com/en-us/help/3204979/windows-search-is-disabled-by-default-in-windows-server-2016 Server 2016]. Use Control Panel / Indexing Options to modify the list of directories included in the index.
* '''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 [https://support.microsoft.com/en-us/help/954822/how-to-install-and-configure-the-indexing-service-on-a-windows-server Server 2008], [https://social.technet.microsoft.com/Forums/en-US/3e705b51-7218-407e-b5c8-429e20557ed4/how-to-configure-indexing-service-in-windows-server-2012 Server 2012], or [https://support.microsoft.com/en-us/help/3204979/windows-search-is-disabled-by-default-in-windows-server-2016 Server 2016]. Use Control Panel / Indexing Options to modify the list of directories included in the index.


 
|}
</tab>
</tab>
<tab name="Step 4">
<tab name="Step 4">
After you Save, press the "List Repositories" button to show the folder paths you just added as repositories.
{|




[[image:1559336379650-168.png|center]]
[[File:2023_NTFS_CMIS_Binding_How_To_Create_a_New_NTFS_Connection_Step_4_01.png]]
 


|}
</tab>
</tab>
<tab name="Step 5">
<tab name="Step 5">
Select "Import Repository" to bring in these repositories for Grooper to import and export to the corresponding folders in the connected file system.  The red circle on the upper right corner of the icon will go from red to green once the repository is imported.
{|
 
[[File:2023_NTFS_CMIS_Binding_How_To_Create_a_New_NTFS_Connection_Step_5_01.png]]
 
<br>
[[image:1559336586956-391.png|center]]
<br>
 
|-
 
[[File:2023_NTFS_CMIS_Binding_How_To_Create_a_New_NTFS_Connection_Step_5_02.png]]
<br>
<br>
|-
[[File:2023_NTFS_CMIS_Binding_How_To_Create_a_New_NTFS_Connection_Step_5_03.png]]
|}
</tab>
</tab>
</tabs>
</tabs>


== More on Mapped vs Unmapped Export ==
== Known Issues & Limitations ==
 
While you are not able to export all a document's metadata like you can when connecting to a CMIS content management platform, you can still utilize the [[CMIS Export#Unmapped Export|Unmapped Export]] provider to do things like change the filename to a data field's value in a data model.  You can also create foldering and map their names to variables in a content model.
 
All those mappings would be assigned on the CMIS Content Types of your repository.
 
 
[[image:1559931016185-605.png|center]]
 
 
[[image:1559919370812-528.png|center]]


=== NTFS CMISQL Query Limitations ===
<section begin="ntfs_query_limitations" />
The '''''NTFS''''' connection binding will ''not'' support the <code>CONTAINS()</code> predicate (for full text searching) ''unless'' the Windows file system has been indexed by the Windows Search Service.
<section end="ntfs_query_limitations" />


You cannot, however, export a metadata "buddy file" using [[CMIS Export#Mapped Export|Mapped Export]].  If you also want to export a metadata file, such as a CSV or XML file, you would need to add a second Document Export step to your Batch process, use the [[CMIS Export#Unmapped Export|Unmapped Export]] provider, and adjust the "Metadata Export" settings in Export Settings.
== See Also ==


[[Category:Articles]]
For more information to use your '''CMIS Connection''' once its created, see the following articles:
[[Category:Version 2.72]]
* [[CMIS Export]]
* [[CMIS Import]]

Latest revision as of 10:32, 13 May 2025

This article is about an older version of Grooper.

Information may be out of date and UI elements may have changed.

202520232.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







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.


See Also

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

Retrieved from "https://wiki.grooper.com/index.php?title=2023:NTFS_(CMIS_Binding)&oldid=28548"