Import Descendants (Import Provider): Difference between revisions

From Grooper Wiki
No edit summary
No edit summary
Line 10: Line 10:
== About ==
== 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.
"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. It will import files from a folder structure of an on-premise or cloud-based document storage platform.
:*<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.
:*<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.


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".
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 Folder's "attachment" and is used when applying activities like "Split Pages".
:*<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.
:*<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.


Import Jobs are submitted in one of two ways:
* '''By a user from the Imports page''': Ad-hoc or "user directed" Import Jobs are submitted from the [[Imports Page]], using the "Submit Import Job" button.
* '''From an Import Watcher service''': Automated or "scheduled" Import Jobs are submitted by an '''[[Import Watcher]]''' service according to its Poling Loop or Specific Times specification.
In both cases, an "Import Descendants" can be selected and configured using using the "Provider" property.


=== Similarities and differences between Import Query Results and Import Descendants ===
=== Similarities and differences between Import Query Results and Import Descendants ===
Line 39: Line 43:
* FTP
* FTP
* SFTP
* SFTP
* NTFS (only if the directory has ''not'' been indexed by the Windows Search service)
* NTFS (only if the directory has ''not'' been indexed by the Windows Search service or the Windows Search service is not running)


== Example Import Descendants configuration ==
== Example Import Descendants configuration ==
Line 48: Line 52:
* [[SFTP]] to connect to SFTP directories
* [[SFTP]] to connect to SFTP directories
* [[Exchange]] to connect to Outlook inboxes
* [[Exchange]] to connect to Outlook inboxes
* [[SharePoint]] to connect to SharePoint sites (and Document Libraries)
* [[SharePoint]] to connect to SharePoint sites (and document libraries)
* [[OneDrive]] to connect to OneDrive drives
* [[OneDrive]] to connect to OneDrive drives
* [[Box]] to connect to Box accounts
* [[Box]] to connect to Box accounts

Revision as of 15:55, 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. It will import files from a folder structure of an on-premise or cloud-based document storage platform.

  • 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 Folder's "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.

Import Jobs are submitted in one of two ways:

  • By a user from the Imports page: Ad-hoc or "user directed" Import Jobs are submitted from the Imports Page, using the "Submit Import Job" button.
  • From an Import Watcher service: Automated or "scheduled" Import Jobs are submitted by an Import Watcher service according to its Poling Loop or Specific Times specification.

In both cases, an "Import Descendants" can be selected and configured using using the "Provider" property.

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 or the Windows Search service is not running)

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