NTFS (CMIS Binding) - Revision history

Dgreenwood at 17:11, 13 May 2025

2025-05-13T17:11:13Z

← Older revision		Revision as of 12:11, 13 May 2025
Line 4:		Line 4:

	<blockquote>{{#lst:Glossary\|NTFS}}</blockquote>		<blockquote>{{#lst:Glossary\|NTFS}}</blockquote>
			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 ~~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 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 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~~.		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".
	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~~.		**<li class="attn-bullet"> Import Query Results can only be used if files and folders are indexed by the Windows Search service. [[CMIS Query\|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]].
			**<li class="attn-bullet"> 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.

	{\|class="attn-box"		{\|class="attn-box"
Line 15:		Line 18:
	⚠		⚠
	\|		\|
	~~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~~.		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.
	\|}		\|}

Line 26:		Line 29:

	* '''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.		* '''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 ~~[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.
			**<li class="attn-bullet"> 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 ==		== Known Issues & Limitations ==
Line 36:		Line 38:
	=== NTFS CMISQL Query Limitations ===		=== NTFS CMISQL Query Limitations ===
	<section begin="ntfs_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~~.		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" />		<section end="ntfs_query_limitations" />


	== Importing and Exporting using NTFS ==		== Importing and Exporting using NTFS ==
	=== Importing ===		=== Importing ===
	==== Submitting an Import Job ====		==== Submitting an Import Job ====
	[https://app.supademo.com/demo/cm9n2t9uz5j8tljv58htislij Click here for an interactive walkthrough]		[https://app.supademo.com/demo/cm9n2t9uz5j8tljv58htislij Click here for an interactive walkthrough]


	# On the Grooper Home Screen, click the Imports icon.		# On the Grooper Home Screen, click the Imports icon.
Line 67:		Line 66:
	==== Configure an Export Behavior ====		==== Configure an Export Behavior ====
	[https://app.supademo.com/demo/cmah9gkot014pw60ie70tnn4s?step=1 Click here for an interactive walkthrough]		[https://app.supademo.com/demo/cmah9gkot014pw60ie70tnn4s?step=1 Click here for an interactive walkthrough]


	# Click <code>...</code> at the end of the Behaviors property to begin configuring.		# Click <code>...</code> at the end of the Behaviors property to begin configuring.

Dgreenwood: Removed redirect to NTFS (CMIS Connection Type)

2025-05-13T15:33:58Z

Removed redirect to NTFS (CMIS Connection Type)

← Older revision		Revision as of 10:33, 13 May 2025
Line 1:		Line 1:
	#~~REDIRECT~~ [[NTFS (CMIS Connection ~~Type)~~]]		{{AutoVersion}}
			[[Category:CMIS Connection Type]]
			[[File:2023_NTFS_CMIS_Binding_00.png\|frame]]

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

			{\|class="attn-box"
			\|
			⚠
			\|
			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 ==

			[https://app.supademo.com/folder/cm8hct0vr002uy30i3j1q5zrp 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 [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.





			== Known Issues & Limitations ==

			=== 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" />


			== Importing and Exporting using NTFS ==
			=== Importing ===
			==== Submitting an Import Job ====
			[https://app.supademo.com/demo/cm9n2t9uz5j8tljv58htislij Click here for an interactive walkthrough]


			# On the Grooper Home Screen, click the Imports icon.
			::#<li class="fyi-bullet"> You will need to have an Import Watcher service installed and running before submitting an Import Job. </li>
			# Click the Add New Import Jobs button.
			# 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.
			# Select the Import Descendants Provider.
			# Next, choose your NTFS Repository.
			# Configure your Base Folder if need be.
			# Import Filter will be defaulted to <code> SELECT * FROM File </code>. This selects all files from the import location.
			# 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.
			# 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
			# When everything is finished, click "Submit" to submit the Import Job.
			# 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 ====
			[https://app.supademo.com/demo/cmah9gkot014pw60ie70tnn4s?step=1 Click here for an interactive walkthrough]


			# Click <code>...</code> at the end of the Behaviors property to begin configuring.
			#:*<li class="fyi-bullet"> Export Behaviors can be configured on any Content Type Node Object; either Content Models, Document Types, or Content Categories. </li>
			# Click the Add button within the Behaviors List window and choose Export Behavior from the dropdown list.
			# Next, set up the Export Definition. Click <code> ... </code> at the end of the Export Definitions property.
			# Click the Add button within the Definitions List Window and select CMIS Export.
			# To choose the Repository you'll be exporting to, click <code> ☰ </code> at the end of the CMIS Repository property
			# Select the NTFS Repository.
			# To choose a specific folder where the Batch content will be exported to, click <code> ... </code> at the end of the Target Folder property; otherwise, your Documents will be exported to the root folder of the NTFS Repository.
			# Select the Target Folder.
			# Define the Object Type by clicking <code> ☰ </code> and selecting an option from the dropdown menu.
			# Configure Read Mappings, Write Mappings, and the Export Format if need be.
			# Click OK when satisfied with the Export Definition.
			# Click OK to finalize the Export Behavior.
			# Save.

			== See Also ==

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

Randallkinard: Randallkinard moved page NTFS (CMIS Binding) to NTFS (CMIS Connection Type): new naming convention

2024-04-17T19:55:47Z

Randallkinard moved page NTFS (CMIS Binding) to NTFS (CMIS Connection Type): new naming convention

New page

#REDIRECT [[NTFS (CMIS Connection Type)]]