Microsoft SharePoint policy

A Microsoft SharePoint policy contains the connection details that are used by a Microsoft SharePoint Input or Microsoft SharePoint Request node when connecting to a Microsoft SharePoint application.

You can use a Microsoft SharePoint Request node in a message flow to connect IBM® App Connect Enterprise to Microsoft SharePoint applications and issue requests to create, retrieve, update, or delete objects such as files, folders, folder items, lists, list items, list item attachments, sites, and users. You can use a Microsoft SharePoint Input node in a message flow to accept input from Microsoft SharePoint. The Microsoft SharePoint policy controls, at run time, access to the Microsoft SharePoint application.

The Microsoft SharePoint policy is created when you configure a connection between a Microsoft SharePoint Input or Microsoft SharePoint Request node and Microsoft SharePoint by using the Connector Discovery wizard. During the process of discovery, account credentials are stored in the vault and connection details are stored in the Microsoft SharePoint policy. The policy is created with a type of Microsoft SharePoint, and the name of the policy is returned to the node and specified in the Connection tab, in the format {policyProjectName}:policyName.

You can also create, update, or delete a Microsoft SharePoint policy by using the Manage Discovery Connector Policies and Credentials wizard, which you can access by right-clicking the policy project in the IBM App Connect Enterprise Toolkit and then clicking New > Discovery Connector policies and credentials.

You must deploy this policy before message flows that use the policy are started. If you redeploy a Microsoft SharePoint policy, all message flows that are using the policy are stopped and restarted.

For more information about using Microsoft SharePoint policies, see Using Microsoft SharePoint with IBM App Connect Enterprise.

Table 1. Properties of the Microsoft SharePoint policy
Property	Property name in .policyxml file	Description of properties
Microsoft SharePoint Application Type	applicationType	This property is reserved for future use and must be set to the value `online`.
Microsoft SharePoint Application Version	applicationVersion	This property is reserved for future use and must be set to the value `v1`.
Microsoft SharePoint Authentication method	authenticationMethod	This property specifies the type of authentication that is used for the connection between IBM App Connect Enterprise and Microsoft SharePoint. This value can be set to `BASIC_OAUTH`, `SAML`, or `NTLM_v1`.
SharePoint online URL or SharePoint on premises host and port	endpointUrl	The URL that provides a direct sign-in to a Microsoft SharePoint service. For example, `https://myorganization.sharepoint.com` or the on premises web application URL that provides a direct sign-in to a Microsoft SharePoint service. For example, `https://mySharePointHost:8443`.
Site collection path	siteCollectionUrl	The site collection URL in Microsoft SharePoint relative to the Microsoft SharePoint URL. For example, `/sites/mySiteCollection`.
Credential Name	credentialName	This property specifies the name of the credential that is used for the connection to Microsoft SharePoint. The specified credential can be defined during connector discovery and stored in the vault. Alternatively, you can specify an existing credential that was configured by using the mqsicredentials command or the server.conf.yaml file, or loaded through an external credential provider.
Domain	domainName	The domain that you use to log in to your on premises Microsoft SharePoint account.
Work Station	workstationName	The name of the workstation or server where Microsoft SharePoint is installed.
Proxy name	proxyId	This property specifies the name of the HTTP Proxy policy that contains details of the HTTP Proxy server URL and the HTTPProxy credential used to make the connection.