Table of Contents

SharePoint Interface Template

The template defines the parameters for connecting to a SharePoint site collection.

Template Parameters

Refer to the common template parameters.

Field Name Type Description
WebSite External The URL of the SharePoint site to connect to.
IsSharePointOnlineEnvironment External True if SharePoint Online is used. False if SharePoint on premise is used.
BatchSize External The batch size indicates the amount of items a request is send. For example when the batch size is 200 a request is send per 200 items. This parameters is important for SharePoint Online, setting the batch size too high can result in a time-out.
Domain External Only for SharePoint on premise. The domain of the specified user.
Username External Only for SharePoint on premise. The user name of the SharePoint user. This user must have permission to access the site.
Password External Only for SharePoint on premise. The password of the specified user.
ClientID Internal The client ID of the registered app in the Microsoft Azure Portal.
SharePointOnlineAzureADCertificate Internal The subject of the certificate linked to the registered app in the Microsoft Azure portal.
SharePointOnlineTenant Internal The SharePoint online tenant url or id.
Use On Behalf Of Internal True to use the on-behalf-of flow. This flow will try to get an on-behalf-of access token for the current requesting user and invokes the SharePoint action using that token. Requires the Microsoft provider to be used.

Authentication Methods

The Ometa framework offers several authentication methods towards SharePoint. Below is an ordered list of the authentication methods that the framework will use. The first method that is configured in the profile will be used.

Name Necessary Settings Fields Where to use?
Azure AD Certificate
  • ClientID and optionally SharePointOnlineTenant
    If ClientID has a value in the form of **clientId@tenantIdOrUrl**, the field SharePointOnlineTenant is not required.
  • SharePointOnlineAzureADCertificate or Certificate
 SharePoint Online
Username Password
  • Username
  • Password
  • Domain
 SharePoint On-premise

To configure any of the modern authentication methods using a ClientID, refer to this article for a guide.

Microsoft Entra API Permissions

When using an authentication method with a ClientID, the client needs sufficient permissions to invoke the SharePoint queries. This must be configured on the Azure portal in the app registration that matches the ClientID in the profile. If this client has not been set up, refer to this article for more information.

To facilitate reading and writing data using the SharePoint interface using this app, the permissions Sites.FullControl.All or Sites.Selected must be granted on the Azure portal. This setting may take a few minutes to apply, restart the BCS_SharePoint.exe interface process before retrying. Keep in mind that this will interrupt any running method.

Grant Full Control Permission

Afterwards the admin consent should be granted.

Grant Admin Consent.png