Import Query Results (Import Provider)

Import Query Results is one of two Import Providers that use cloud CMIS Connections to import document content into Grooper. Import Query Results imports files from a settings_system_daydream CMIS Repository that match a "CMISQL query" (a specialized query language based on SQL database queries).

About

"Import Query Results" 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 Query Results 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 below 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

Overall, "Import Descendants" is a "simpler" version of "Import Query Results".

We advise to use Import Query Results over Import Descendants, when possible.
- Import Query Results can do everything Import Descendants can do and more.
- Import Query Results has more robust file filtering capabilities. This allows for more targeted, selective imports.
- Import Query Results is newer (and better maintained) than Import Descendants.
- There are only a handful of scenarios where Import Descendants must be used over 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.

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)

Prereqs: CMIS Repository

A CMIS Repository allows Grooper access to files and folders within a storage platform.

Because Import Query Results 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

Before you can import files from these platforms using Import Query Results, there's some setup required in the Grooper Design page. You must:

Create and configure a CMIS Connection.
Import a folder location as a CMIS Repository.

This will allow you to import files from folders accessed by the CMIS Repository. For information on CMIS Connections and CMIS Repositories, including how to create them in Grooper, visit the CMIS Connection page.

Click here for an interactive walkthrough.

Example Import Query Results configuration

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: SELECT * FROM <a type of document in the CMIS Repository> WHERE <according to certain search conditions>
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 "FROM File" for files in a Windows folder.
- Example: For the Exchange binding you select "FROM Message" to search for email messages.
In the WHERE clause, you can set search parameters based on file properties and metadata values called "CMIS properties". What CMIS properties are "queryable" will also depend on the the CMIS Repository and its CMIS Binding.
- Example: The Exchange binding has a queryable "Subject" property.
- Example: Fields in a Box metadata template are queryable for the Box binding.
- Which CMIS properties are queryable can be determined by (1) navigating to the CMIS Repository in the Grooper node tree (2) going to the "Types" tab (3) selecting the CMIS document type whose properties you want to inspect and (4) reviewing the "Queryable" column for each CMIS property.
The WHERE clause is also used to set the folder scope, using the IN_FOLDER and IN_TREE predicates (where supported).
More information on CMIS Queries (including unsupported query configurations for various CMIS Bindings) can be found in the CMIS Query article.

Example: Submitting Import Query Results from the Imports Page

Click here for a step by step walkthrough.

Go to the Imports Page.
Press the "New Import Job" button.
This brings up the "Submit Import Job" editor.
Enter a description in the Description property (This is required).
Open the "Provider" dropdown (Press the "☰" button).
Select "Import Query Results" from the dropdown list.
Expand the Provider settings to configure it.
Open the "Repository" node selector (Press the "☰" button).
Select the CMIS Repository you wish to import from.
Open the "CMIS Query" editor (Press the "..." button).
Enter the CMIS Query by either:
- 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).
  - 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 Batch Creation settings, as needed.
Configure the file disposition options (Delete Item, Move To Folder, or Update Properties), as needed.
Configure any remaining Import Descendants properties, as needed.
Press the "Submit" button when finished.
Your Import Watcher service will pick up and execute the Import Job.