Installing and Configuring the Confluence Plugins for SP 2016 (v 1.9)
This page tells you how to install and configure the Confluence plugins that you need for the SharePoint Connector, to integrate with Microsoft SharePoint 2016.
On this page:
1. Install the Confluence Plugins
To install the plugins into Confluence: Go to the Confluence 'Administration Console'. To do this: Starting with version 1.8.3 up to version 1.9.6 of the SharePoint Connector for Confluence, we've included the Windows installers along with the plugin JAR file, so you will no longer be able to install or upgrade this plugin directly from the UPM. You will have to download and unzip the plugin zip file, and then manually upload the JAR file via the UPM in order to install the SharePoint plugin or upgrade an existing version. This does not apply to version 1.9.7 and newer.
2. Configure Confluence and the Plugins
Once you have installed the required plugins into Confluence, you should then configure the plugins and your Confluence site to work and communicate successfully with a SharePoint site. Follow the instructions below. In order for your SharePoint site(s) to communicate with and retrieve content from Confluence, the Remote API (XML-RPC & SOAP) must be enabled in Confluence. Check whether the remote API is enabled and if not, enable it. See the instructions in the Confluence administrator's guide. In this step, you will tell Confluence which SharePoint site(s) it can communicate with. To configure Confluence to work with a SharePoint site: Enter the appropriate details into the following fields: SharePoint Site Alias Enter a simple name that identifies the SharePoint site easily in Confluence. SharePoint-related Confluence macros use this name as a parameter value to identify the SharePoint site on which to run their queries. SharePoint Site URL Enter the base URL of the SharePoint site, for example, Confluence Access URL Enabled You can choose to configure an alternative SharePoint URL for Confluence to use when accessing SharePoint. See the details below. User Name The Windows user account that Confluence will use to access the SharePoint site. Note that this user must be a SharePoint site collection administrator. The user name must follow the syntax Password The password associated with the Windows user account. Make this SharePoint Site the default. Selecting this option makes any Confluence SharePoint macros that do not reference a SharePoint Site Alias, query this SharePoint site. Enable sp-list permission trimming Selecting this option filters the SharePoint List macro results to display only content that the user has permission to access in SharePoint. Click the 'Test Connection' button to test that the connection to the SharePoint site is correct. Note that when the connection test fails for some reasons the first thing you need to ensure is the SharePoint connector component for SharePoint is installed on SharePoint servers. Follow the instruction at one of the below links to install the component according to your SharePoint server version Installing and Configuring the SharePoint Feature on SP 2007 Installing and Configuring the SharePoint Feature on SP 2010 Installing and Configuring the SharePoint Feature on SP 2013 The 'Confluence Access URL Enabled' option on the 'SharePoint Admin' screen allows you to set up a special URL for Confluence to use when accessing SharePoint. There are two choices: The alternative access URL allows you to resolve problems where the SharePoint installation uses an authentication protocol not supported by Confluence, such as NTLMv2 or Kerberos. You can configure SharePoint to run on a separate port that bypasses the unsupported authentication protocol, and then allow Confluence to communicate with SharePoint via this alternative URL. See the recommended configuration for securing Confluence access to SharePoint . To configure Confluence to access SharePoint via an alternative URL: Which URL will the Confluence macros use? Confluence's SharePoint macros will query the SharePoint site via the alternative access URL. However, any links returned by these macros that lead back to the SharePoint site will query the standard access URL. The alternative access URL must be configured externally, as a separate network configuration. In practice, an alternative access URL would be used in situations where Confluence and SharePoint are hosted in the same private network, either behind a firewall or on the same VPN.Enabling Confluence Remote API
Configuring Confluence to Work with a SharePoint Site
Screenshot: The site configuration section of the Confluence 'SharePoint Admin' page
Table: SharePoint Site Configuration Fields Field Description
Each SharePoint alias must be unique. However, do not modify this field when editing\ a pre-configured SharePoint site.SERVERNAME\username
, where:SERVERNAME
is the name of the Windows domain on which the SharePoint site can be accessed. Otherwise, this is the name of the computer hosting SharePoint.username
is the username of the Windows user account used to access the SharePoint site.
If this option is selected, a ' ' appears in the 'Default Site' field of the list of configured SharePoint sites (at the top of the SharePoint Admin page).
If the connection was successful, you will see the message Connection Test: Success.
If the connection was not successful, you will see the message Connection Test: Server unreachable. If you see this message, please ensure that your SharePoint site settings are correct, as described in the table above.Configuring an Alternative SharePoint URL for Confluence
Configuring Confluence to Share Search Results with SharePoint Server
If you have a Microsoft SharePoint Server instead of just SharePoint Foundation, you can configure Confluence to share search results with the SharePoint server. This will allow users to search content in both Confluence and SharePoint from Confluence's search features.
Screenshot: The SharePoint Server search integration section of the Confluence 'SharePoint Admin' page Â
To configure Confluence to share search results with a SharePoint server:
Enter the SharePoint server's Search URL into the 'Search URL' field. This usually has the format
[http://www.example-sharepoint-server.com/searchcenter/Pages/Results.aspx]- Enter the SharePoint Server's Search URL's search parameter into the 'Search Field Name'. This is usually the letter
k
only. - Click the 'Update Search Settings' button.
You will also need to configure the SharePoint side of things. You will come to this step later, as described in  Configuring the SharePoint Federated Search on SP 2016.
After updating the search settings, the Confluence theme will display a drop-down menu next to the Confluence search box, looking like this:
The drop-down menu offers two options:
- 'SharePoint & Confluence' – If you select this option when searching for content via the Confluence search, the search results page will open in SharePoint and will show results from both SharePoint and Confluence.
- 'Confluence Only' – If you select this option when searching for content via the Confluence search, the search results page will open in Confluence and will show results from Confluence only.
Editing an Existing SharePoint Site's Settings
This section describes how to edit the settings for a SharePoint site that has already been configured in Confluence. To edit the existing configuration settings of a SharePoint site in Confluence: Do not change the SharePoint site alias If you only intend to edit an existing SharePoint site's configuration, do not change the 'SharePoint Site Alias' field. If you do change this value, Confluence adds these settings as a new entry in the list of configured SharePoint sites. Screenshot: Example List of Configured SharePoint Sites
A message will be displayed, indicating whether or not the connection was successful.
Next Step
To continue with the installation of the SharePoint Connector, please configure the access to Confluence .