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

SharePoint

Custom Binding Grooper.Cloud

Defines a connection to SharePoint.

Remarks

SharePoint provides a CMIS-compliant interface to Microsoft SharePoint, supporting both online (SharePoint 365) and on-premises deployments.

Authentication Modes

The 'Authentication Method' property determines how Grooper authenticates with SharePoint. Supported HTTP Authentication Method types include:

  • SharePoint OAuth.
    Used for SharePoint Online (365).

    • Configure 'Client ID', 'Client Secret', and 'Tenant ID' to connect using an Azure AD application registration.
    • Supports modern authentication and is required for cloud-based SharePoint.
  • NTLM Authentication
    Used for on-premises SharePoint servers.

    • Configure 'Username' and 'Password' to connect as a specific Windows user.
    • Supports integrated Windows authentication.
  • Basic Authentication
    Supported for legacy on-premises SharePoint servers (not recommended for production).

    • Configure 'Username' and 'Password'.
    • May require enabling basic auth on the SharePoint server.

Only one authentication method can be active at a time.
The available options depend on whether the 'Base URL' points to SharePoint Online or an on-premises server.

Repository Structure

  • Each SharePoint site or subsite is exposed as a logical repository.
  • Document libraries and folders within a site are presented as a hierarchical folder structure.
  • The 'Enable Subsites' property controls whether subsites beneath the base URL are included in the repository view.
    • If enabled, all subsites and their document libraries are accessible.
    • If disabled, only the root site and its libraries are available.
  • The 'Enable Library Types' property controls whether custom content types in document libraries are exposed as CMIS types.

CMIS Type Exposure

  • Folder Type:
    SharePoint folders are exposed as the cmis:folder type.
  • Document Type:
    SharePoint documents are exposed as the cmis:document type.
  • Document Library Custom Types:
    When the 'Enable Library Types' property is enabled, custom content types defined in SharePoint Document Libraries are exposed as additional CMIS types.
    These custom types appear as children of the standard cmis:document and cmis:folder types, allowing you to work with documents and folders that have custom metadata fields and structure defined in SharePoint.
    For example, a library with a custom "Invoice" content type will expose a corresponding CMIS type beneath cmis:document, with all associated custom fields available for query and mapping.
    These are not secondary types in the CMIS sense, but are primary types that extend the base document or folder type.
  • No Secondary Types:
    This binding does not expose any CMIS secondary types.

Search Capabilities and Supported CMISQL Syntax

  • Metadata Search:
    You can search on any standard or custom property exposed by the selected CMIS type using the WHERE clause in CMISQL. Supported predicates include =, <>, <, >, <=, >=, LIKE, IN, and IS NULL/IS NOT NULL (with some restrictions).
  • Full-Text Search:
    Full-text search is supported using the CONTAINS() predicate in CMISQL. For SharePoint Online and most on-premises environments, this is translated to SharePoint's [Keyword Query Language (KQL)] for site-wide searches, and to CAML for document library queries (where supported).
    • KQL supports keyword, phrase, and wildcard searches, as well as logical operators (AND, OR, NOT).
    • CAML-based queries (used for document libraries) do not support the CONTAINS() predicate or full-text search.
  • Scope Predicates:
    The IN_FOLDER() and IN_TREE() predicates are supported for site-wide (KQL) queries, but are not supported for document library (CAML) queries.
  • LIKE Operator:
    The LIKE operator is supported for string properties, but only prefix and infix wildcards are supported. Suffix wildcards (e.g., %foo) and single-character wildcards (_) are not supported.
  • IN Predicate:
    The IN predicate is supported for string and ID properties.
  • Limitations:
    • Some advanced CMISQL features, such as JOINs and secondary types, are not supported.
    • Not all SharePoint fields are queryable; only those exposed as CMIS properties can be used in queries.
    • For document library queries, only metadata search is available; full-text search is not supported at the library level.
    • The NOT operator is not supported for groups of predicates in CAML queries.
  • Examples:
    • SELECT * FROM cmis:document WHERE Title LIKE '%invoice%' AND CreatedBy = 'jsmith'
    • SELECT * FROM CustomType WHERE Amount > 1000 AND Status IN ('Open', 'Pending')
    • SELECT * FROM cmis:document WHERE CONTAINS('contract AND \"service agreement\"')

For more information, see the SharePoint Developer Documentation.

Properties

NameTypeDescription
General
Options

See Also

Used By

Notification