Configuring the SharePoint Web Part on SP 2016 (v 1.9)

This page tells you how to configure the Confluence settings in SharePoint. These instructions apply to the SharePoint Connector for Confluence for SP 2016.

Settings Inheritance

The Confluence settings are automatically inherited down the SharePoint site hierarchy. If no Confluence settings have been configured for a SharePoint site, the chain of parent sites will be checked for settings to use. If no parent site has any Confluence settings defined, then the Farm configuration database will be checked for farm-wide settings.

On this page:

Configuring the Confluence Administrative Settings for the entire SharePoint Farm.

Configuring the Confluence settings for the entire SharePoint farm can be a time-saving approach if you wish to configure Confluence integration for multiple SharePoint sites or site collections. This approach allows you to manage the settings in a single, central location, rather than having to duplicate the settings in each site.

In order to save Confluence settings at the farm level, the SharePoint Connector solution must be deployed to the SharePoint Central Administration Site when the SharePoint Connector is first installed.

Open your web browser and open your SharePoint farm's Central Administration site.
Under the 'Application Management' section, select 'Confluence Settings'
The Confluence administration screen appears.
Configure the desired settings to connect to Confluence. For details of the various configuration options, see the Confluence Settings Options section
Click the 'Test Confluence Configuration' button to test your configuration settings.
Click 'OK' to save your changes.

Configuring the Confluence Administrative Settings for a SharePoint Site.

Configuring the Confluence settings against a single SharePoint site requires only site administrator privileges and can be performed against any SharePoint site that has the SharePoint Connector for Confluence solution deployed and activated.

Open the desired SharePoint site in your web browser. From the 'Site Actions' menu (at the top left), select 'Site Settings' and then 'Confluence Settings' in the 'Site Administration' section.
The Confluence administration screen appears.
Configure the desired settings to connect to Confluence. For details of the various configuration options, see the Confluence Settings Options section
Click the 'Test Confluence Configuration' button to test your configuration settings.
Click 'OK' to save your changes.

Confluence Settings Options

Setting	Required	Details
Confluence Site	Yes	The Confluence Base URL of the Confluence server you are connecting to.
Authentication Selection	Yes	Select the method by which the SharePoint server will login to the Confluence server: 'Access Confluence with a single master account': The SharePoint server logs in to the Confluence server using a Confluence administrative account. Individual user permissions for end-users are still enforced by the Confluence server (ie. this does not grant full Confluence access to every SharePoint user!) 'Access Confluence with the Microsoft Secure Store Service': The SharePoint server delegates Confluence authentication to each individual user via the Microsoft Secure Store Service. This option is only available when the SharePoint server is running SharePoint Server 2016. Configure a Secure Store Service application by following the instructions to configure access to Confluence via the Microsoft SSO service and then select the correct application from the drop-down box.
Confluence Username	Only if 'Access Confluence with a single master account' option is selected	The username of the Confluence administrator to use when logging in to Confluence.
Confluence password	Only if 'Access Confluence with a single master account' option is selected	The password of the aforementioned Confluence administrator. The password is encrypted before being stored in the SharePoint content database.
Customize permission checking format	No	Customize the way in which SharePoint users are mapped to Confluence users (by default, it is assumed that the SharePoint username is identical to the Confluence username). For example, enter the following text into the 'User Name Format' field: {domain}\{username} This example will pass the Windows domain name along with the username when authenticating a user to Confluence. This is useful if you have configured Confluence to connect to multiple Active Directory domains and you therefore need to distinguish between two users with the same username in different domains.
Authenticate with Confluence using email	No	Customize the way in which SharePoint users are mapped to Confluence users by taking the SharePoint user's configured email address as their Confluence username.
Confluence SSO Application	Only if the 'Access Confluence with the Microsoft Secure Store Service' option is selected	The unique name of the application in the Secure Store Service that holds the Confluence username and password details.
Web Service Timeout	No	If your Confluence site is especially large, and your users report problems while waiting for the Confluence web parts to load, you can optionally choose to increase the timeout value for retrieving content from Confluence. The default is 100 seconds, but you can increase this to a longer timeout if desired. The value entered into the field is calculated in seconds.
Use custom handler for Confluence images	No	If you have not configured your Confluence server to use a custom authentication scheme (eg. NTLM or Integrated Windows Authentication), your users may report problems where images in the web parts are not visible in SharePoint unless the user has an active browser session in Confluence. Enabling this option will proxy all embedded images in Confluence via SharePoint, bypassing the need for end-users to have an active login. Enabling this option will cause your SharePoint Server to receive additional load, so do not enable this option if your Confluence server does not require it.