Import Descendants

The 'Repository' property determines the external content source for the import operation. Selecting a CMIS Repository defines the available folders, content types, and filter options for import.

Changing the repository will reset the 'Base Folder' and update the context for the 'Import Filter'.

---

The 'Base Folder' acts as the root node for the import operation. All child and descendant items beneath this CMIS Folder are traversed and considered for import, subject to the criteria defined in the 'Import Filter'.

---

Filters are SQL-style query strings which specify what type of objects will be imported, and what conditions they must meet to qualify for import.
They take the following general form:

SELECT * FROM <ContentType> [WHERE <Criteria>]

The following are examples of valid filters:

Binding	Description	Filter
NTFS	Select all descendant files.	SELECT * FROM File
NTFS	Select all files which are immediate children.	SELECT * FROM File WHERE AT_LEVEL(1)
NTFS	Select files which are not hidden and end with 'PayrollReport.xslx'.	SELECT * FROM File WHERE Hidden=False AND cmis:name LIKE '%PayrollReport.xslx'
SFTP	Select folders at level 1.	SELECT * FROM Folder WHERE AT_LEVEL(1)
SharePoint	Select PDF files larger than 100,000 bytes.	SELECT * FROM Document WHERE FileExtension='.pdf' AND cmis:contentStreamLength>100000
Exchange	Select mail messages having attachments with 'payroll' in the subject.	SELECT * FROM Message WHERE Subject LIKE '%payroll%' AND HasAttachments=True

SELECT Clause

A filter must always begin with 'SELECT *'. Selecting individual properties is not supported.

FROM Clause

The FROM clause indicates the type of object to be imported. If the specified type is a base type, then all types inheriting from that type will be imported. For example, if a SharePoint repository defines two document-based types 'Invoice' and 'Purchase_Order', then the filter SELECT * FROM Document will select both Invoice and Purchase_Order objects. To select Invoice objects only, use SELECT * FROM Invoice.

WHERE Clause

The optional WHERE clause specifies one or more conditions items must match to be included in the import. Multiple conditions are joined with the AND/OR operators, and may be nested with parenthesis () to indicate order of operations. Each condition may be one of the following predicates:

Predicate Type	Description	Example
AT_LEVEL Predicate	Specifies a the level at which an item must exist, relative to the base folder. If an AT_LEVEL predicate is used, it should be the first predicate in the WHERE clause, and must be followed by an AND if other criteria is included.	AT_LEVEL(1)
Comparison Predicate	Specifies a condition for an individual property.	invoice_date < '12/31/2007'
IN Predicate	Specifies a list of allowed values for a property.	FileExtension IN ('.pdf', '.docx', '.xlsx')
MATCHES Predicate	Specifies that a property value must match a regular expression.	cmis:name MATCHES 'Daily Report for \d{4}-\d{2}\\d{2}.xlsx'
Scope Predicate	Restricts the search scope to children or descendants of a folder.	IN_FOLDER(/Inbox) IN_TREE(/Inbox)

The NOT operator may be used to invert the logic of individual predicates or a group of predicates enclosed by (). Note that some CMIS Bindings have limited support for the NOT operator.

WHERE Clause

The WHERE clause specifies optional criteria each object must meet to qualify for import.

The WHERE clause may optionally begin with an AT_LEVEL() predicate, specifying the level at which items must exist below the Base Folder. If an AT_LEVEL predicate is used, it should be the first predicate in the WHERE clause, and must be followed by an AND if other criteria is included. For example, the following query will select all folders which are immediate children of the Base Folder, and have a name starting with 'payroll':

SELECT * FROM Folder WHERE AT_LEVEL(1) AND cmis:name LIKE 'Payroll%'

When querying folders, if no AT_LEVEL() predicate is present, AT_LEVEL(1) will be assumed

Comparison Operators by Property Type

Property Type	Supported Operators	Quoted	Example
String	=, <>, LIKE, IN, MATCHES	Yes	vendor_name LIKE 'acme logistics%'
Decimal	=, <>, <, <=, >, >=, IN	No	invoice_amount <= 1000.00
Integer	=, <>, <, <=, >, >=, IN	No	quantity = 0
Boolean	=	No	tax_exempt = true
DateTime	=, <>, <, <=, >, >=, IN	Yes	invoice_date < '01/01/2018'
ID	=, <>	Yes	type_id='2fadac71-a9a9-4185-9070-e3b23517e518'
URI	=, <>, LIKE	Yes	vendor_website LIKE 'http://www.grooper.com/%'

Comparison Operator Details

Operator	Description	Example
IN	The property value must match one of many values.	FileExtension IN ('.pdf', '.docx', '.xlsx')
LIKE	The property value must contain a substring. The % character serves as a wildcard.	cmis:name LIKE '%Report.xslx'
MATCHES	The property value must match a regular expression.	cmis:name MATCHES 'Daily Report for \d{4}-\d{2}\\d{2}.xlsx'

---

When set, introduces a delay between the time a file was last modified, and the time it becomes eligible for import. The "age" of a document is defined as the amount of time since its Last Modified Date. During import, files with an age below the minimum specified here will be ignored.

Use this property to prevent conflicts when importing from a location where other processes may be simultaneously adding files.

---

If a Content Type is specified, it will take precedence over any property-based mappings.

• When set, all imported documents will be classified as the selected Content Type.
• If left blank, the import will rely on property mappings to determine classification.
• If neither a Content Type nor mappings are provided, documents will be imported unclassified.

> Best Practice: Assign a Content Type when you want all imported items to be treated as a specific document type, regardless of their source metadata.

---

Can be one of the following values:

Name	Value	Description
Copy	0	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	1	Properties will be loaded, but content will not. This mode is much faster than Copy or Move, 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	2	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.

The 'Import Mode' controls how much data is loaded for each imported item:

> Tip: Use 'Sparse' or 'LinkOnly' for high-volume imports or when you want to optimize storage and performance.

---

Use 'Skip Count' to restart an import that was previously stopped, or to perform incremental imports by skipping items already processed.

---

Use 'Max Items' to limit the number of documents or folders imported in a single operation. This can be combined with 'Skip Count' for incremental or staged imports.

---

The 'Batch Creation' property defines rules for grouping imported items into batches, including batch size, structure, and organization. Adjust these settings to match your workflow and processing requirements.

---

The 'Batch Name Options' property allows you to configure naming conventions for new batches, including dynamic values based on process, content type, or other metadata.

---

• This option is only available when 'Import Mode' is set to Copy.
• When enabled, the source item will be deleted from the CMIS Repository after a successful import.
• Useful for polling scenarios with the Import Watcher service, where you want to remove items as they are processed.

> Caution: Deleting items is irreversible. Ensure this option is only enabled when you intend to remove source content.

---

• When set, imported items will be moved to the specified folder in the CMIS Repository after import.
• This is useful for organizing or archiving processed items, especially in automated or watched import scenarios.
• If not set, items remain in their original location unless deleted.

> Note: Moving items is only available when 'Import Mode' is not set to Copy with 'Delete Item' enabled.

---

Can be one of the following values:

Name	Value	Description
Error	0	Am errpr will be raised, causing the operation to fail.
NameUniquely	1	A unique name will be generated by appending a number to the filename.
Overwrite	2	The existing document will be overwritten by this operation.
Skip	3	The add, move, or rename operation will be skipped.

• Determines the conflict resolution strategy when moving items to a folder that already contains an item with the same name.
• Options may include overwriting, renaming, or skipping the item, depending on repository capabilities.

> Tip: Review your repository's behavior for name conflicts to avoid accidental data loss.

---

• Specify a list of key-value pairs, where 'key' is the name or ID of a property, and 'value' is the value to assign.
• Format: one entry per line, in the form key=value.

Examples:

• Useful for setting flags, statuses, or other metadata on imported items.
• Especially helpful when using the Import Watcher service to automate property updates during import.

> Note: Only writable properties on the target CMIS Repository can be updated.