Import Descendants (Import Provider): Difference between revisions

From Grooper Wiki
No edit summary
Tag: Manual revert
No edit summary
Line 7: Line 7:
* [[CMIS Import#About CMIS Import]] - This portion of the "CMIS Import" article briefly covers the differences between '''''Import Descendants''''' and '''''Import Query Results'''''.
* [[CMIS Import#About CMIS Import]] - This portion of the "CMIS Import" article briefly covers the differences between '''''Import Descendants''''' and '''''Import Query Results'''''.
* [[CMIS Import#Import Descendants]] - This portion of the "CMIS Import" article explains '''''Import Descendants'''''.
* [[CMIS Import#Import Descendants]] - This portion of the "CMIS Import" article explains '''''Import Descendants'''''.
<!---


== About ==
== About ==


'''Import Descendants''' is an [[Import Provider]] used to import objects from a CMIS Repository that are "children" or "descendants" of a base CMIS Folder.  This is done using a SQL-style "filter" to select the items that will be imported.
"Import Descendants" is one of the [[CMIS Import]] providers in Grooper. It is used to import files from '''CMIS Repositories''' for Batch processing in Grooper.
:*<li class="fyi-bullet"> While less common, Import Descendants can also import ''folders'' from CMIS Repositories. However, since importing files is most common, we focus on importing ''files'' in this article.


* <code>AT_LEVEL</code> selects items at a specific level
Just like any other Import Provider, Import Descendants is used to submit "Import Jobs". Import Jobs are how Grooper brings in files from a storage location for processing. For example, it's how PDFs from a Windows folder get into Grooper or messages from an email inbox get into Grooper. When an Import Job runs, Grooper first creates a Batch and then creates a Batch Folder for each imported file. A copy of the file is attached to the Batch Folder. This becomes the Batch Folders "attachment" and is used when applying activities like "Split Pages".
* <code>MATCHES</code> allows RegEx against property values
:*<li class="fyi-bullet"> When files are imported into Grooper, a link to that file is stored on the Batch Folder. This link maintains a connection between the file's source location and the document in Grooper. This link also makes "Sparse imports" possible. See the [[Sparse Import]] article for more.


=== Example ===


<tabs>
=== Similarities and differences between Import Query Results and Import Descendants ===
<tab name="Step 1">
===== Create a Batch =====
The easiest way to use Import Descendants is by creating a new batch.
* In Grooper Design Studio or Grooper Dashboard, create a new batch by pressing "Batch > CMIS Import > Import Descendants...".


Import Descendants is generally regarded as a "simpler" version of "[[Import Query Results]]".


[[image:1556571123332-495.png|center]]
<big>Similarities</big>
* Both providers import files from a CMIS Repository.
* Both providers have the same Batch Creation settings.
* Both providers are capable of "Sparse" imports by changing the "Import Mode" to "Sparse".
* Both providers can dispose of files on import (using the "Delete Item", "Move Item", or "Update Properties")


<big>Differences</big>


</tab>
The biggest difference is in how the providers determine which files are imported (import criteria).
<tab name="Step 2">
* Import Descendants will import all files from a target location. ''This includes all files in all subfolders if present''. You can, however, set a "Base Folder" within the CMIS Repository.
===== Choose the Repository =====
* Import Query Results will import files that match a [[CMIS Query]]. This is a specialized query language based on SQL syntax. This gives you many more options for import conditions, using a "WHERE" clause in the query. CMIS Queries also give you the capability to restrict imports to a folder location without importing files in subfolders (This is something Import Descendants ''cannot'' do).
:*<li class="fyi-bullet"> Import Descendants does have an "Import Filter" it can use to set import conditions. It also uses a SQL-like syntax. However, it is not as advanced as the CMIS Queries that Import Query Results uses. '''Because of this, if you can use Import Query Results, you should.'''


If you have multiple CMIS repositories available, you'll need to choose the one from which you wish to import.
<big>CMIS Repositories that can only use Import Descendants</big>
* Select the appropriate repository from the "Repository" property.


Certain CMIS Bindings are '''not queryable''' using CMIS Queries. Because of this, certain CMIS Repositories '''''cannot''''' utilize Import Query Results. The following CMIS Repositories must use Import Descendants to import file content:
* FTP
* SFTP
* NTFS (only if the directory has ''not'' been indexed by the Windows Search service)


[[image:1556571692162-486.png|center|900px]]
== 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:
* [[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


[[image:1556632783258-847.png|center|900px]]
Regardless of the platform, you configure Import Descendants largely the same. Just pick a CMIS Repository and a base folder in that repository.


== About "Sparse" imports ==


</tab>
== Batch Creation options ==
<tab name="Step 3">
===== Analyze and Import =====


Now we can test it out.
== File disposition options ==
* Pressing "Analyze" will run a search against your repository with your configured settings.
* Pressing "Import" will create a batch of documents that were imported using your configured settings.
 
Using the "Starting Step" property, you can choose from your published Batch Processes the step where your batch should be created. For example, in the screenshot below, the batch will be created at the "Image Review" step of a Batch Process.
 
 
[[image:1556632834217-872.png|center|900px]]
 
 
</tab>
</tabs>


<!---
=== Example Queries ===
=== Example Queries ===



Revision as of 15:44, 23 May 2025

This is a redirect page.

Import Descendants is one of two Import Providers that use cloud CMIS Connections to import document content into Grooper. Import Descendants imports files from a settings_system_daydream CMIS Repository folder location, including any files in any sub-folders (i.e. all "descendant" files).

For information on Import Descendants visit the following resources:

About

"Import Descendants" is one of the CMIS Import providers in Grooper. It is used to import files from CMIS Repositories for Batch processing in Grooper.

  • While less common, Import Descendants can also import folders from CMIS Repositories. However, since importing files is most common, we focus on importing files in this article.

Just like any other Import Provider, Import Descendants is used to submit "Import Jobs". Import Jobs are how Grooper brings in files from a storage location for processing. For example, it's how PDFs from a Windows folder get into Grooper or messages from an email inbox get into Grooper. When an Import Job runs, Grooper first creates a Batch and then creates a Batch Folder for each imported file. A copy of the file is attached to the Batch Folder. This becomes the Batch Folders "attachment" and is used when applying activities like "Split Pages".

  • When files are imported into Grooper, a link to that file is stored on the Batch Folder. This link maintains a connection between the file's source location and the document in Grooper. This link also makes "Sparse imports" possible. See the Sparse Import article for more.


Similarities and differences between Import Query Results and Import Descendants

Import Descendants is generally regarded as a "simpler" version of "Import Query Results".

Similarities

  • Both providers import files from a CMIS Repository.
  • Both providers have the same Batch Creation settings.
  • Both providers are capable of "Sparse" imports by changing the "Import Mode" to "Sparse".
  • Both providers can dispose of files on import (using the "Delete Item", "Move Item", or "Update Properties")

Differences

The biggest difference is in how the providers determine which files are imported (import criteria).

  • Import Descendants will import all files from a target location. This includes all files in all subfolders if present. You can, however, set a "Base Folder" within the CMIS Repository.
  • Import Query Results will import files that match a CMIS Query. This is a specialized query language based on SQL syntax. This gives you many more options for import conditions, using a "WHERE" clause in the query. CMIS Queries also give you the capability to restrict imports to a folder location without importing files in subfolders (This is something Import Descendants cannot do).
  • Import Descendants does have an "Import Filter" it can use to set import conditions. It also uses a SQL-like syntax. However, it is not as advanced as the CMIS Queries that Import Query Results uses. Because of this, if you can use Import Query Results, you should.

CMIS Repositories that can only use Import Descendants

Certain CMIS Bindings are not queryable using CMIS Queries. Because of this, certain CMIS Repositories cannot utilize Import Query Results. The following CMIS Repositories must use Import Descendants to import file content:

  • FTP
  • SFTP
  • NTFS (only if the directory has not been indexed by the Windows Search service)

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:

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

About "Sparse" imports

Batch Creation options

File disposition options