SharePoint Connection
The SharePoint Connection shared resource contains all necessary parameters to establish connections among the Microsoft SharePoint plug-in, JMS server, and Microsoft SharePoint server.
This shared resource can be reused for the SharePoint Get Metadata tool and different activities of the plug-in.
General
On the General panel, you can specify the package that stores the SharePoint Connection shared resource and the shared resource name.
The following table lists the configurations on the General panel of the SharePoint 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 Connection shared resource:
| Field | Module Property? | Description |
|---|---|---|
| SharePoint 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, and 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
|
|
Deployment Type |
No |
(Required) Two types of deployment are supported:
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 upon the deployment type that you select from
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 only supports OnlineFederation 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, you can select the corresponding authentication method in the plug-in.
|
| 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 login properties in Java Authentication Authorization Service (JAAS). |
| Runtime Username | Yes | (Required) The runtime user name 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 user name. |
| 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 user name that is used when getting metadata by using the SharePoint Get Metadata tool, and to retrieve a Destination topic in the SharePoint Notification Listener 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 user name. |
| Design-time Password | Yes | (Required) The design-time password that is used when getting metadata by using the SharePoint Get Metadata tool, and to retrieve a Destination topic in the SharePoint Notification Listener activity. |
| JMS Server Connection Configuration
Note: Not available when
Deployment Type is Online.
|
||
| JMS Username | Yes | (Required only when authorization is enabled on the JMS server.) The user name used to access a JMS server. |
| JMS Password | Yes | (Required only when authorization is enabled on the JMS server.) The password used to access a JMS server. |
| Auto-generated JMS Client ID | No | (Required) Whether you want to automatically generate a client ID for the connection to a JMS server. The automatically generated string is in GUID format.
If this check box is not selected, the value specified in the Client ID field is used for the connection. |
| Client ID | Yes | (Optional) The client ID of the JMS connection. Each connection must use a unique client ID.
See documentation of your JMS provider for more information about client IDs. Note: If the value specified in the
Client ID field is already in use, an error occurs when messages are triggered on the Microsoft SharePoint server.
|
| Use JNDI for Connection Factory | No | (Optional) Whether you want to use JNDI (Java Naming and Directory Interface) to query the factory object from the JMS server. |
| JMS Provider URL | Yes | (Required) The URL to JMS service provider. The general syntax is protocol://IP Address:port. To take TIBCO Enterprise Message Service™ as an example, the URL is tcp://x.x.x.x:7222. |
| JNDI Configuration
Note: Not available when
Deployment Type is Online.
The JNDI Context Factory, JNDI Context URL, Topic Connection Factory, Queue Connection Factory, JNDI Username, and JNDI Password fields are displayed after you select the Use JNDI for Connection Factory check box. |
||
| JNDI Context Factory | No | (Required for using JNDI) The initial context factory class for accessing JNDI. The default context factory for TIBCO Enterprise Message Service is
com.tibco.tibjms.naming.TibjmsInitialContextFactory.
|
| JNDI Context URL | Yes | (Required for using JNDI) The URL to the JMS service provider. The general syntax is protocol://IP Address:port. To take TIBCO Enterprise Message Service as an example, the URL is tibjmsnaming://x.x.x.x:7222. |
| Topic Connection Factory | Yes | (Required for using JNDI) The topic connection factory used to create connections for publishing or subscribing messaging. The default value is
TopicConnectionFactory.
|
| Queue Connection Factory | Yes | (Required for using JNDI) The queue connection factory used to create connections for point-to-point messaging. The default value is
QueueConnectionFactory.
|
| JNDI Username | Yes | (Required for using JNDI if authorization is enabled on the JMS server.) The user name used to access the JMS server. |
| JNDI Password | Yes | (Required for using JNDI if authorization is enabled on the JMS server.) The password used to access the JMS server. |
| Connection Factory SSL Password | Yes | (Required for using Secure Sockets Layer (SSL)) The password used to access the JMS server. |
| Use SSL for JMS | No | (Optional) Whether you want to use SSL to support client authentication for the JMS server. |
| SSL Configuration
Note: Not available when
Deployment Type is Online.
The Trusted Certificates Path, Identity File, Identity Password, Connection Factory SSL Password, and Target Host Name fields are displayed after you select the Use SSL for JMS check box. See Configuring SSL for TIBCO Enterprise Message Service for details about how to enable SSL. |
||
| Trusted Certificates Path | No | (Required for using SSL) The path of the certificates where the certificates are available. |
| Identity File | No | The identity file used for two-way SSL authentication for the plug-in.
|
| Identity Password | Yes | The password used to access the identity file. |
| Target Host Name | Yes | (Optional for using SSL) The common name of the JMS server certificate. If you type a value in this field, the plug-in can verify the target host name. |
Test SharePoint Connection
You can click Test SharePoint Connection to test whether the specified configuration fields result in a valid connection to the Microsoft SharePoint server by using the runtime and design-time credentials.
Get JMS Configuration
You can click Get JMS Configuration to retrieve the JMS configuration information from the Microsoft SharePoint server automatically if you have configured the JMS configuration information by using the SharePoint Notification Configuration Management tool, which is installed on the Microsoft SharePoint server. See SharePoint Notification Configuration Management Tool for details about this tool.
- Client ID. You have to type the value manually or select the Auto-generated JMS Client ID check box to generate a client ID.
- JMS Password, JNDI Password, Connection Factory SSL Password, and Identity Password. To protect the privacy of users, you have to type the values manually.
- Trusted Certificates Path and Identity File. The values of these two parameters might be different from those on the Microsoft SharePoint server. You have to type the values manually.
Test JMS Connection
You can click Test JMS Connection to test whether the specified configuration fields result in a valid connection to the JMS server.