│ Grooper Help - Version 25.0
25.0.0017 2,127
  • Overview
  • Help Status

Import Query Results

Cmis Import Base Grooper.CMIS

Imports objects from a CMIS Repository, using a CMISQL Query to select items for import.

Remarks

The Import Query Results provider enables importing documents and folders from a CMIS Repository by executing a user-defined CMISQL Query. This approach is ideal when you need precise control over which items are imported, such as importing based on metadata, content type, or other advanced criteria.

How It Works

  • The import process executes the query specified in the 'CMIS Query' property against the selected CMIS Repository.
  • All CMIS Document and CMIS Folder objects matching the query are imported as Batch Folders in Grooper.
  • Imported items are linked to their source via Content Links, supporting both standard and sparse import modes.

Configuration Overview

  • Repository: Select the CMIS Repository to query and import from.
  • CMIS Query: Enter a valid CMISQL Query to define which objects to import. The query can target any supported content type and use WHERE, ORDER BY, and other clauses.
  • Include Previous Revisions: Optionally include previous document versions in the import results.
  • Disable Select Clause Optimization: When enabled, the SELECT clause of your query is used as-is. When disabled (recommended), Grooper will optimize the SELECT clause to ensure all required properties are included for import.

CMIS Query Syntax

The 'CMIS Query' property accepts standard CMISQL Query syntax. For example:

  • SELECT * FROM Document WHERE cmis:name LIKE 'Invoice%'
  • SELECT * FROM Folder WHERE cmis:creationDate > '2023-01-01'
  • SELECT * FROM Message WHERE HasAttachments = true

You can use WHERE, ORDER BY, and JOIN clauses as supported by your repository.

> Note: The available query features depend on the capabilities of the selected CMIS Repository. Some repositories may not support all CMISQL features.

Usage Scenarios

  • Targeted Import: Import only documents or folders matching specific metadata or content type criteria.
  • Bulk Import with Filtering: Efficiently ingest large sets of content while excluding irrelevant items.
  • Advanced Metadata Queries: Use complex WHERE clauses to select items based on multiple properties or relationships.

Best Practices

  • Use the query editor to validate your CMISQL Query and preview results before running a full import.
  • If you need all properties required for import, leave 'Disable Select Clause Optimization' set to false.
  • Review repository capabilities to ensure your query is supported.
  • For large result sets, consider using ORDER BY and pagination features if supported by your repository.

Related Concepts

  • CMIS Repository: Logical container for external content.
  • CMISQL Query: SQL-like query language for selecting items in a CMIS Repository.
  • Batch Folder: Grooper's internal representation of imported documents and folders.
  • Content Link: Reference to the original external content, enabling sparse import and dynamic content access.

Properties

NameTypeDescription
General
Processing Options
Disposition

See Also

CMIS RepositoryContent CategoryContent ModelDocument TypeForm TypePage TypeCMIS Folder ReferenceBatch Creation SettingsBatch Name Settings

Used By

Import JobRoot - Run ImportSpecific TimesPolling Loop

Notification