Import Query Results

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

Remarks

Executes a CMISQL Query against a CMIS Repository, and imports all matching CMIS Document or CMIS Folder objects.

Inherits from: Import Provider

Properties

The following 17 properties are defined.

Property Name Description
General
Repository Type: CMIS Repository

The repository from which content will be imported.

CMIS Query Type: String

Defines a query which selects the objects to be imported.

Include Previous Revisions Type: Boolean, Default: False

Specifies whether the query results should include previous revisions of documents.

Disable Select Clause Optimization Type: Boolean, Default: False

Controls whether the SELECT clause of the CMISQL query will be automatically optimized for the import operation. If set to True, the SELECT clause will be optimized to (a) eliminate unnecessary property values, and (b) include any missing property values. If set to False, the SELECT clause will be left unaltered.

Content Type Type: Content Type

Optionally assigns a Content Type to imported batch folders. If a Content Type is specified, this will take precedence over mappings. If no Content Type is specified, the import will rely on mappings. If no Content Type is specified and no mappings exist, the document will be imported unclassified.

Processing Options
Import Mode Type: ImportModes, Default: Full

The mode to be used when importing items. Can be one of the following values:

  • Full - Both properties and content will be loaded. This is the slowest import mode, because the full content of each document is copied during a single-threaded import process. As such, this mode is not well-suited for high-volume imports, but provides some useful advantages in low-volume import scenarios. For example, Normal mode allows items to be deleted immediately on import, which can be important when using the Import Watcher service. Also, Normal mode avoids the need for any follow-up load operations in the Batch Process.
  • Sparse - Properties will be loaded, but content will not. This mode is much faster than a Full import, because no content files are copied into Grooper. Instead, a link is saved on each Grooper document, and content is retrieved on demand directly from the CMIS Repository. This type of document is called a sparse document. Sparse documents can be used just like any other document, with the caveat that display and processing speeds may be reduced. After a sparse import, document content can be loaded in parallel using the Execute / CMIS Document Link - Load command.
  • LinkOnly - No content or properties will be loaded. This is the fastest import mode. It imports nothing more than a link to each document, and offloads all property and content loading to parallel operations in the Batch Process. After a LinkOnly import, document properties and/or content can be loaded using the Execute / CMIS Document Link - Load command.

Skip Count Type: Int32, Default: 0

Indicates the number of items to skip at the beginning of the sequence. Use this property to restart an import which was previously stopped.

Max Items Type: Int32, Default: 0

Indicates the maximum number of items to process. This can be used with Skip Count to perform incremental imports.

Disposition
Delete Item Type: Boolean, Default: False

Enables or disables deletion of the input item after import. This option can only be enabled when the Import Mode is set to 'Full'. Deleting objects on import is particularly useful when using the Import Watcher service to periodically query/poll for new documents. See documentation on the Import Watcher service for more information.

Move To Folder Type: CMIS Folder

Specifies the an optional folder to which items should be moved after import. Moving objects on import is particularly useful when using the Import Watcher service to periodically query/poll for new documents. See documentation on the Import Watcher service for more information.

Update Properties Type: String

Defines one or more property values to be updated on import. Specifies a list of key-value pairs, where 'key' is the name or ID of a property, and 'value' is the value to which the property should be set. The list should be formatted so that there is on entry per line, with each entry in the form key=value. For example, the following entry, when used with the NTFS binding, would set the Archive attribute of each imported file to False:

Archive=False

As another example, the following entry would set the Status field on a SharePoint document to 'IMPORTED'.

Status=Imported

Updating properties on import is particularly useful when using the Import Watcher service to periodically query/poll for new documents. See documentation on the Import Watcher service for more information.

Batch Creation
Starting Step Type: Batch Process Step

The step within a batch process where batches will be started.

Folder Levels Type: List of Folder Level Info

Defines the number of folder levels which will be translated into subfolders within the Grooper Batch.

Maximum Items per Batch Type: Int32, Default: 2500

The maximum number of items to be imported into a single batch.

Priority Type: Int32, Default: 3, Range: 1 - 5

The priority of the batch. The Priority value controls the order in which tasks are processed, with the value 1 representing the highest priority level, and the value 5 representing the lowest priority level. (i.e. Items of priority 1 are processed before items of Priority 2, and so on). The batch must be paused before this property can be edited.

Batch Name Prefix Type: String

An optional prefix to be prepended onto each batch name.

Example

Given the date is 01-02-2019 and the time is 1:39:00 PM, entering "Tommy Oliver's AP batch_:_" will result in the batch being named:

"Tommy Oliver's AP batch_:_ 2019-01-02 01:39:00 PM"

Start Paused Type: Boolean, Default: True

If true, created batches will be started in a paused state.

See Also

Batch Process Step, CMIS Folder, CMIS Repository, Content Type, Folder Level Info

Used By

Import Watcher