SharePoint REST Connection

The SharePoint REST Connection shared resource contains all necessary parameters to establish connections between the Microsoft SharePoint plug-in and the Microsoft SharePoint server.

This shared resource can be reused for the SharePoint REST Get Metadata tool and different activities of the plug-in.

General

In the General panel, you can specify the package that stores the SharePoint REST Connection shared resource and the shared resource name.

The following table lists the configurations on the General panel of the SharePoint REST Connection shared resource:

Field	Module Property?	Description
Package	No	(Optional) The name of the package where the new shared resource is added.
Name	No	(Required) The name to be displayed as the label for the SharePoint shared resource in the process.
Description	No	(Optional) A short description for this shared resource.

Shared Connection Configuration

On the Shared Connection Configuration panel, you can provide the information of the Microsoft SharePoint server that the plug-in connects to.

The following table lists the configurations on the Shared Connection Configuration panel of the SharePoint REST Connection shared resource:

Field	Module Property?	Description
SharePointRest SiteCollection	Yes	(Required) The URL of the SharePoint site collection that you want to access. It is the top-level website. The address format must be consistent with the one set on the Microsoft SharePoint server. For example, if the public URL set on the Microsoft SharePoint server is an IP address, the value on the SharePoint website Address must use an IP address. Note: The plug-in supports HTTPS communication between TIBCO ActiveMatrix BusinessWorks™ Plug-in for Microsoft Sharepoint and Microsoft SharePoint server. If you want to use HTTPS, you have to configure IIS for the Microsoft SharePoint server to support HTTP over SSL. Then type the HTTPS URL in this field. For example: https://host_name:Https_Port_Number. The plug-in automatically selects HTTP or HTTPS based on the prefix of the URL, such as `http` and `https` during run time and design time.
Deployment Type	No	(Required) Two types of deployment are supported: On-premisesPremises: Used for connecting to the local Microsoft SharePoint server. Online: Used for connecting to the Microsoft SharePoint online server. Note: By default, On-Premises mode is selected.
Authentication Method	No	(Required) The authentication types that are supported by the plug-in. The authentication types depend on the deployment type that you select from the Deployment Type drop-down. If you select on-premises, the plug-in supports three types of authentication, namely NTLM, Basic and Kerberos. If you select Online, the plug-in supports OnlineFederation and OAuth authentication. The plug-in supports BASIC, NTLM, and KERBEROS authentication methods in Claims-Based Authentication for Microsoft SharePoint 2013/2016. Note: After you set the authentication method on the Microsoft SharePoint server in the central administration website, select the corresponding authentication method in the plug-in.
Client ID	Yes	(Required) It is a unique ID of the SharePoint app and is app-specific ID that is used to connect to the SharePoint Online server. The Client ID is generated during the app registration process, for information on app registration see Creating credentials using SharePoint App.
Client SecretKey	Yes	(Required) The Client SecretKey is generated during the app registration process. You can use this password to connect to the SharePoint Online server.
Tenant ID	Yes	(Required) It is a unique ID of your Microsoft 365 tenant. Note: To know the Tenant ID in Sharepoint Online, go to the https://{tenant}.sharepoint.com/_layouts/15/appprincipals.aspx. All the registered apps are displayed. The Tenant ID is listed under the App Identifier column with respective app in App Display Name column. The Tenant ID looks like <Client ID>@<Tenant ID>.
Kerberos KRB5 Configuration File	Yes	(Required when the KERBEROS authentication method is used.) Click the icon to locate the Kerberos KRB5 configuration file. The Kerberos configuration file contains Kerberos configuration information, including the locations of Key Distribution Centers (KDCs) and admin servers for the Kerberos realms of interest, defaults for the current realm and for Kerberos applications, and mappings of hostnames onto Kerberos realms.
Kerberos Login Configuration File	Yes	(Required when the KERBEROS authentication method is used.) Click the icon to locate the Kerberos Login configuration file. The file contains the configuration information of the log in properties in the Java Authentication Authorization Service (JAAS).
Runtime Username	Yes	(Required) The runtime username that the plug-in activities can use to authenticate against and run. If you have a domain account, you must provide the domain name in this field. The format is domainName\username. If not, you can directly enter your username.
Runtime Password	Yes	(Required) The runtime password that the plug-in activities can use to authenticate against and run.
Design-time Username	Yes	(Required) The design-time username that is used when getting metadata by using the SharePoint REST Get Metadata tool, and to retrieve a Destination topic in the SharePointRESTHTTPNotificationListener activity. If you have a domain account, you must provide the domain name in this field. The format is domainName\username. If not, you can directly enter your username.
Design-time Password	Yes	(Required) The design-time password that is used when to get metadata by using the SharePoint REST Get Metadata tool, and to retrieve a Destination topic in the SharePointRESTHTTPNotificationListener activity.
Proxy Configuration	No	(Optional) Specifies the configuration of the proxy server. For more information, see the "Proxy Configuration" topic in the TIBCO ActiveMatrix BusinessWorks™ Bindings and Palettes Reference. Note: Proxy Configuration is common for both Online and On-Premises Deployment types. Only Basic Proxy authentication is supported. Note: Ensure that the attribute value is empty. Alternatively, remove the basic value for `jdk.http.auth.tunneling.disabledSchemes` Example `jdk.http.auth.tunneling.disabledSchemes =` At the `{{TIBCO_HOME}}\tibcojre64` path, change the following files: Java 11 file at `\11\conf\net.properties` Java 8 file at `\1.8.0\lib\net.properties`
Identity Provider	No	(Optional) Provides the username and password credentials. For more information, see the "Identity Provider" topic in the TIBCO ActiveMatrix BusinessWorks™ Bindings and Palettes Reference guide.

Test SharePoint REST Connection

You can click Test SharePoint REST Connection to test whether the specified configuration fields result in a valid connection to the Microsoft SharePoint server.

Subtopics