CMIS Import (Import Provider) - Revision history

Dgreenwood: /* Example Import Query Results configuration */

2025-05-28T20:59:14Z

Example Import Query Results configuration

← Older revision		Revision as of 15:59, 28 May 2025
Line 200:		Line 200:

	Import Query Results relies on a "CMIS Query" to import files from a CMIS Repository. The CMIS Query (aka CMISQL Query) uses a syntax structure similar to a SQL query. Instead of querying rows in a database based on column values, you're querying documents in a storage location based on file property and metadata values.		Import Query Results relies on a "CMIS Query" to import files from a CMIS Repository. The CMIS Query (aka CMISQL Query) uses a syntax structure similar to a SQL query. Instead of querying rows in a database based on column values, you're querying documents in a storage location based on file property and metadata values.
	* The general CMIS Query format is: <code>'''SELECT * FROM''' ''a type of document in the CMIS Repository'' '''WHERE''' ''according to certain search conditions''</code>		* The general CMIS Query format is: <code>'''SELECT * FROM''' ''<a type of document in the CMIS Repository>'' '''WHERE''' ''<according to certain search conditions>''</code>
	* What "type of document" in can search for in the FROM clause is determined by the storage platform and the CMIS Binding.		* What "type of document" in can search for in the FROM clause is determined by the storage platform and the CMIS Binding.
	** Example: For the NTFS binding you select "<code>FROM File</code>" for files in a Windows folder.		** Example: For the NTFS binding you select "<code>FROM File</code>" for files in a Windows folder.

Dgreenwood: /* Example Import Query Results configuration */

2025-05-28T20:44:51Z

Example Import Query Results configuration

← Older revision		Revision as of 15:44, 28 May 2025
Line 228:		Line 228:
	#* Typing it into the Query Editor.		#* Typing it into the Query Editor.
	#* Or, using the Query Editor's property grid to construct the query (The text will populate the Query Editor as you configure these properties).		#* Or, using the Query Editor's property grid to construct the query (The text will populate the Query Editor as you configure these properties).
			#**<li class="fyi-bullet"> A more in depth explanation of the Query Editor and CMIS Queries can be found in the [[CMIS Query]] article.
	# Configure the Import Mode property, as needed.		# Configure the Import Mode property, as needed.
	# Configure the Batch Creation settings, as needed.		# Configure the Batch Creation settings, as needed.

Dgreenwood: /* Under review */

2025-05-28T20:43:37Z

Under review

← Older revision		Revision as of 15:43, 28 May 2025
Line 234:		Line 234:
	# Press the "Submit" button when finished.		# Press the "Submit" button when finished.
	# Your Import Watcher service will pick up and execute the Import Job.		# Your Import Watcher service will pick up and execute the Import Job.

	~~== Under review ==~~

	~~This section is under review by the editor.~~

	~~=== Import Query Results ===~~
	~~==== The Same, But Different ====~~
	The Import Query Results provider's configuration panel is almost identical to the Import Descendants provider's configuration panel. ''Both'' providers share the same Processing Options, Disposition, and Batch Creation property settings. See the [[#Import Descendants\|Import Descendants]] section for brief descriptions of these property sections.


	The big difference between the two providers is the highlighted CMIS Query property. This allows users to enter a SQL-like query (called a CMISQL query) to selectively import documents from their source, based on certain metadata properties. Only files returned by the query will be imported.
	* For example, you may want to only import documents of a certain file type(s). You could include the file extension(s) as the query condition (or one of many conditions).
	* For another example, you can use CMISQL queries to easily filter email messages when importing from an inbox. If you only wanted to import messages from a certain sender, from an certain folder, with a certain subject line and only ones that have not been read, you could filter out any emails that didn't meet those query conditions by comparing metadata properties (like "Sender" and "Subject") to your criteria.

	~~{\|class="attn-box"~~
	\|
	~~'''⚠'''~~
	\|Only certain external storage platforms are currently queryable with the CMIS Query property. The following CMIS Binding sources cannot be queried currently. As such, they are not suitable for Import Query Results. You should instead use Import Descendants for the following CMIS Bindings.

	~~:• FTP~~
	~~:• SFTP~~
	~~:• NTFS (If the folder path is not indexed by the Windows Search service and/or Windows Search is not running on the storage server)~~
	\|}

	~~[[File:2023_CMIS_Import_02_About_CMIS_Import_02_3_Import_Query_Results_The_Same_But_Different_01.png]]~~


	Just like with Import Descendants, there are some minimum requirements before configuring Import Query Results. A '''CMIS Connection''' object must be created and a '''CMIS Repository''' must be imported.

	~~[https://app.supademo.com/demo/cm8ergggh03ij12zdakzyt3jp Click here for an interactive walkthrough]~~



	~~==== CMIS Query Configuration ====~~
	~~Upon pressing the ellipsis button at the end of the CMIS Query property, the CMIS Query Editor window will appear.~~

	This interface allows you to configure the CMISQL query based on available metadata from the CMIS Binding. For example, the Exchange binding has a selection of queryable metadata for email messages, such as the email's subject, sender and date the message was received.

	~~[https://app.supademo.com/demo/cm8g1l4us17x112zdo9ti0ae3 Click here for an interactive walkthrough]~~

	~~For an in depth explanation of the CMIS Query Editor and how to use it to craft a CMISQL query, please visit the [[CMIS Query]] article.~~

Dgreenwood: /* Example Import Descendants configuration */

2025-05-28T20:43:22Z

Example Import Descendants configuration

@@ Line 190: / Line 190: @@
 # Select the CMIS Repository you wish to import from.
 # Select a Base Folder, as needed.
 # Configure the Import Mode property, as needed.
 # Configure the Batch Creation settings, as needed.

Dgreenwood: /* Example Import Descendants configuration */

2025-05-28T13:56:12Z

Example Import Descendants configuration

← Older revision		Revision as of 08:56, 28 May 2025
Line 174:		Line 174:
	* Unless you configure the "Base Folder" property, Import Descendants will start at the root of the CMIS Repository and continue down the folder structure.		* Unless you configure the "Base Folder" property, Import Descendants will start at the root of the CMIS Repository and continue down the folder structure.
	* When using Import Descendants, setting the "Base Folder" to a terminal branch in the folder structure (a folder with no subfolders) is the only way to import files from a folder without importing descendant files (because there are none in this case).		* When using Import Descendants, setting the "Base Folder" to a terminal branch in the folder structure (a folder with no subfolders) is the only way to import files from a folder without importing descendant files (because there are none in this case).
			**<li class="fyi-bullet"> A more technical way of saying this is Import Descendants does not support the <code>IN_TREE</code> CMIS search predicate. It only supports the <code>IN_FOLDER</code> predicate.

	<big>Example: Submitting Import Descendants from the Imports Page</big>		<big>Example: Submitting Import Descendants from the Imports Page</big>

Dgreenwood: /* Example Import Descendants configuration */

2025-05-28T13:52:01Z

Example Import Descendants configuration

← Older revision		Revision as of 08:52, 28 May 2025
Line 171:		Line 171:

	Regardless of the platform you're accessing with a CMIS Repository, you configure Import Descendants largely the same. Just pick a CMIS Repository and configure the rest of Import Descendants as needed.		Regardless of the platform you're accessing with a CMIS Repository, you configure Import Descendants largely the same. Just pick a CMIS Repository and configure the rest of Import Descendants as needed.
			* Import Descendants will import all files in the base folder, ''including all descendant files in any subfolders if present.''
			* Unless you configure the "Base Folder" property, Import Descendants will start at the root of the CMIS Repository and continue down the folder structure.
			* When using Import Descendants, setting the "Base Folder" to a terminal branch in the folder structure (a folder with no subfolders) is the only way to import files from a folder without importing descendant files (because there are none in this case).

	<big>Example: Submitting Import Descendants from the Imports Page</big>		<big>Example: Submitting Import Descendants from the Imports Page</big>

Dgreenwood: /* Under review */

2025-05-27T22:01:33Z

Under review

← Older revision		Revision as of 17:01, 27 May 2025
Line 196:		Line 196:

	This section is under review by the editor.		This section is under review by the editor.
	~~=== Import Descendants ===~~
	~~==== Configuration Panel ====~~

	~~[https://app.supademo.com/demo/cm8d4b2wt1f812ugqwtbi17bu Click here for an interactive walkthrough]~~

	~~==== General Settings ====~~

	~~[https://app.supademo.com/demo/cm8ddjcr91rb92ugqp7k9phqo Click here for an interactive walkthrough]~~

	~~Back top the Import Descendants configuration screen, the '''CMIS Repository''' object is used to point Grooper to this folder location for import.~~

	*The Repository property is configured to assign the '''CMIS Repository''' where the documents are located.
	** Here the '''CMIS Repository''' named "Import and Export" connecting to the "Import and Export" folder of the local drive.

	*The Base Folder property is configured to traverse the folder structure of the '''CMIS Repository'''.
	** Here, we don't want to import ''all'' documents from ''every'' folder in the "Import and Export" folder. We just want to import from the "Grooper Import Folder".

	*The Import Filter property allows you to perform some basic import filtering to selectively choose which documents you want to import.
	** <code>SELECT * FROM File</code> is the default filter. It will import all files from the selected folder location.
	** This is a SQL-like query to specify conditions for document import.
	**<li class="attn-bullet"> BE AWARE: Import Descendants has limited filtering compared to e Import Query Results.
	*** Import Query Results was created to expand on this functionality. It provides more filtering options for the CMIS Connection Types supported by Import Query Results.
	*** Import Descendants DOES NOT support the "IN_FOLDER" or "IN_TREE" predicates. Import Descendants will ''always'' import ''all'' documents in ''all'' subfolders from the base folder.
	*The Content Type property allows you to optionally assign the incoming documents with a '''Document Type'''.
	** You can use this property to assign a default classification for all incoming documents.

	~~[[File:2023_CMIS_Import_02_About_CMIS_Import_02_1_Import_Descendants_General_Settings_02(1).png]]~~

	=== Import Query Results ===		=== Import Query Results ===

Dgreenwood at 22:00, 27 May 2025

2025-05-27T22:00:50Z

← Older revision		Revision as of 17:00, 27 May 2025
Line 61:		Line 61:
	* NTFS (only if the directory has ''not'' been indexed by the Windows Search service or the Windows Search service is not running)		* NTFS (only if the directory has ''not'' been indexed by the Windows Search service or the Windows Search service is not running)
	<section end="import_query_results_and_descendants_similarities"/>		<section end="import_query_results_and_descendants_similarities"/>
	~~<section begin="shared_cmis_import_settings"/>~~

	== Prereqs: CMIS Repository ==		== Prereqs: CMIS Repository ==

Line 84:		Line 82:

	[https://app.supademo.com/demo/cm8ddjcr91rb92ugqp7k9phqo Click here for an interactive walkthrough.]		[https://app.supademo.com/demo/cm8ddjcr91rb92ugqp7k9phqo Click here for an interactive walkthrough.]
			<section begin="shared_cmis_import_settings"/>
	== Settings shared between Import Descendants and Import Query Results ==		== Settings shared between Import Descendants and Import Query Results ==

Dgreenwood: /* Example Import Descendants configuration */

2025-05-27T21:59:50Z

Example Import Descendants configuration

← Older revision		Revision as of 16:59, 27 May 2025
Line 172:		Line 172:
	== Example Import Descendants configuration ==		== Example Import Descendants configuration ==

	~~Because Import Descendants imports from a CMIS Repository, you can import from numerous storage platforms determined by the "CMIS Binding" used. These CMIS Bindings include:~~		Regardless of the platform you're accessing with a CMIS Repository, you configure Import Descendants largely the same. Just pick a CMIS Repository and configure the rest of Import Descendants as needed.
	* [[NTFS]] to connect to Windows folders
	* [[FTP]] to connect to FTP directories
	* [[SFTP]] to connect to SFTP directories
	* [[Exchange]] to connect to Outlook inboxes
	* [[SharePoint]] to connect to SharePoint sites (and document libraries)
	* [[OneDrive]] to connect to OneDrive drives
	* [[Box]] to connect to Box accounts
	* [[AppXtender]] to connect to AppEnhancer applications

	Regardless of the platform, you configure Import Descendants largely the same. Just pick a CMIS Repository and ~~a base folder in that repository~~.

	<big>Example: Submitting Import Descendants from the Imports Page</big>		<big>Example: Submitting Import Descendants from the Imports Page</big>
Line 197:		Line 187:
	# Open the "Repository" node selector (Press the "☰" button).		# Open the "Repository" node selector (Press the "☰" button).
	# Select the CMIS Repository you wish to import from.		# Select the CMIS Repository you wish to import from.
	# Configure the Import Mode property as needed.		# Select a Base Folder, as needed.
			# Configure the Import Mode property, as needed.
	# Configure the Batch Creation settings, as needed.		# Configure the Batch Creation settings, as needed.
	# Configure the file disposition options (Delete Item, Move To Folder, or Update Properties), as needed.		# Configure the file disposition options (Delete Item, Move To Folder, or Update Properties), as needed.
Line 203:		Line 194:
	# Press the "Submit" button when finished.		# Press the "Submit" button when finished.
	# Your Import Watcher service will pick up and execute the Import Job.		# Your Import Watcher service will pick up and execute the Import Job.


	== Under review ==		== Under review ==

Dgreenwood: /* Settings shared between Import Descendants and Import Query Results */

2025-05-27T21:59:08Z

Settings shared between Import Descendants and Import Query Results

@@ Line 62: / Line 62: @@
 <section end="import_query_results_and_descendants_similarities"/>
 <section begin="shared_cmis_import_settings"/>
 == Settings shared between Import Descendants and Import Query Results ==
@@ Line 147: / Line 169: @@
 <br clear=all>
 <section end="shared_cmis_import_settings"/>
 == Example Import Descendants configuration ==