Import Descendants (Import Provider)

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:

• CMIS Import - This is an article covering imports using CMIS Connections in general.
• 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.

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.

Batch Creation options

The Batch Creation settings allow you to define which Batch Process you wish to use to process the imported files.

You must configure the "Starting Step" property to assign the Batch Process.

• Use the property's dropdown editor to select a Batch Process Step from a list of Batch Processes.
• Only published Batch Processes will appear in this list.

Other notable Batch Creation properties:

• "Start Paused" - This determines if the Batch starts in a paused state or not. If "False", the first step's tasks will be automatically submitted to Activity Processing services. If "True", you will have to manually start the Batch.
• "Max Items Per Batch" - The default is 2500, meaning each Batch will have a maximum of 2500 Batch Folders before creating a new Batch on import. For users who want more Batches with fewer documents, lower this number.
• "Organize By Date" - This will organize Batches into subfolders in the Production branch in Grooper according to the year / month / day the Batch was created.
• "Priority" and "Increment Priority" - Controls the task processing priority for the Batch. "Increment Priority" is useful when submitting large user-directed imports from the Imports Page to ensure the first Batch created is the first that is fully processed by Activity Processing services.

File disposition options

The "Disposition" settings allow you to do something with the source files after importing them into Grooper. This is important when using an Import Watcher service to schedule imports. If you do not configure a Disposition property, the imported file will remain in the same state after the Import Job completes. This can cause the Import Watcher to repeatedly attempt to import the same file over and over again.

There are three "Disposition" options:

• "Delete Item" - Turning this to "True" will simply delete the source file after the Import Job completes.
  • You may only configure this option if the "Import Mode" is set to "Copy".
• "Move To Folder" - This will move the files to a different folder in the CMIS Repository after the Import Job completes.
• "Update Properties" - This will update one or more file properties after the Import Job completes. Properties are updated by listing them as "key-value pairs" in the "Update Properties" list editor where key=value.
  • Examples:
  • Archive=false Sets the archive attribute on each imported file to "false".
  • IsRead=true Marks each imported email message as read.
  • Status=PENDING Sets a "Status" field on a document in an AppEnhancer application (assuming there is a "Status" field in the application).