Parameter query for SharePoint

This chapter outlines how to specify the query parameter when using Microsoft SharePoint Online as repository.

Property	Mandatory	Type	Description
type	Yes	String	As this chapter describes the parameter for Microsoft SharePoint Online, the value is sharepoint.
query	Yes	String	The query to be executed against Microsoft SharePoint Online to find documents. It should include an exclusion criterion for documents that have already been processed. Refer to the SharePoint Documentation on KQL for the required syntax.

warning

Remember to always include an exclusion criterion for the documents in the query!

tip

We recommend including the SharePoint site in the query to restrict the search to the site where the documents to be processed are stored. To achieve this, use the parameter SPSiteURL:

... AND SPSiteURL:"https://<tenant>.sharepoint.com/sites/sap" ...

Example SharePoint query with all properties

Here is a full specified example of the query parameter object for Hyland Nuxeo.

query:
  type: sharepoint
  query: (ContentType:"Document") AND title:"My Doc" AND SPSiteURL:"https://<tenant>.sharepoint.com/sites/sap"

Integration with aqilink: Utilizing Properties

tip

This chapter is relevant only if you also use the SAP-certified interface aqilink (Document Exchange) to store documents from SAP to Microsoft SharePoint Online. In this case, you can leverage the data model of aqilink to create the query and the recommended exclusion criteria.

In this case, we recommend including the name of the SAP Repository Connection (defined in the sapHttp.yaml file) as a criterion in the query. This ensures that only documents from the relevant SAP Content Repository are processed by the task. The name is stored in the SAPSource property. Documents stored through aqilink will also have the content type SAP Component, so you can also use the ContentType parameter to narrow the search.

Example

query:
  type: sharepoint
  query: (ContentType:"SAP Component") AND SAPSource:"sharepoint-al" AND SPSiteURL:"https://<tenant>.sharepoint.com/sites/sap"