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

Scope Predicate

Where Predicate Grooper.CMIS

Restricts the search scope to the children or descendants of a folder.

Remarks

The Scope Predicate is used in a CMISQL Query to limit search results to items located within a specific folder or its subfolders in a CMIS Repository. This predicate is essential for targeting content within a defined area of the repository, improving both performance and relevance of query results.

A Scope Predicate takes one of two forms, depending on whether you want to include only direct children or all descendants:

IN_FOLDER(FolderId)
IN_TREE(FolderId)
  • IN_FOLDER restricts results to items that are direct children of the specified folder.
  • IN_TREE includes all items that are descendants of the folder, at any depth.

Usage Guidance

  • Set the 'Search Scope' property to select the folder that defines the search boundary.
  • Use the 'Include Subfolders' property to control whether only direct children (IN_FOLDER) or all descendants (IN_TREE) are included.
  • If no folder is specified, the entire repository will be searched.

Examples

To return all PDF files that are immediate children of the '/Import/Faxes' folder (using the NTFS binding): SELECT * FROM File WHERE IN_FOLDER('/Import/Faxes') AND FileExtension='.pdf'

To return emails containing 'Grooper' in the subject, located in the Inbox folder or any of its subfolders (using the Exchange binding): SELECT * FROM Message WHERE IN_TREE('/Inbox') AND Subject LIKE '%grooper%'

The Scope Predicate is a powerful tool for narrowing the focus of a CMISQL Query to a specific folder or branch of the repository. Proper configuration ensures that only relevant items are returned, and can significantly improve query performance in large repositories.

Properties

NameTypeDescription

See Also

CMIS Folder Reference

Used By

CMISQL Query

Notification