Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.
Comment: fixed formatting
Excerpt
hiddentrue

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.

Enabling Confluence Remote API

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.

Anchor
SPSite
SPSite

Configuring Confluence to Work with a SharePoint Site

In this step, you will tell Confluence which SharePoint site(s) it can communicate with.

To configure Confluence to work with a SharePoint site:

  1. Insert excerpt
    _Navigating to the Confluence Administration Console
    _Navigating to the Confluence Administration Console
    nopaneltrue
  2. Click 'SharePoint Admin' in the 'Administration' section of the left-hand navigation panel to open the 'SharePoint Integration Administration' screen. On this screen you can configure one or more SharePoint sites to work with your Confluence installation.

    Screenshot: The site configuration section of the Confluence 'SharePoint Admin' page
  3. Enter the appropriate details into the following fields:
    Table: SharePoint Site Configuration Fields ||

    Field
    ||
    Description
    ||

    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.
    (info) Each SharePoint alias must be unique. However, do not modify this field when editing\ a pre-configured SharePoint site.

    SharePoint Site URL

    Enter the base URL of the SharePoint site, for example,

    http://www.example-sharepoint-server.com
     

    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 SERVERNAME\username, where:

    Include Page
    _Configuring the Confluence SharePoint Plugin username components
    _Configuring the Confluence SharePoint Plugin username components
    nopaneltrue

    Password

    The password associated with the Windows user account.

    Anchor
    additional-options
    additional-options
    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.
    If this option is selected, a '(tick) ' appears in the 'Default Site' field of the list of configured SharePoint sites (at the top of the SharePoint Admin page).

    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.

  4. Click the 'Test Connection' button to test that the connection to the SharePoint site is correct.

    If the connection was successful, you will see the message (tick) Connection Test: Success.
    If the connection was not successful, you will see the message (error) Connection Test: Server unreachable. If you see this message, please ensure that your SharePoint site settings are correct, as described in the table above.

    Note

    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

  5. Click 'Update SharePoint Settings' to save the configuration settings for your SharePoint site.

Anchor
altURL
altURL

Configuring an Alternative SharePoint URL for Confluence

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:

  • 'Use Standard Access URL' – This is the default value. If you choose this option Confluence will query the SharePoint site via the 'SharePoint Site URL' configured above.
  • 'Use Alternative Access URL' – If you choose this option, the 'Confluence Access URL' field appears on the screen. Enter an alternative URL. Confluence will query the SharePoint site via this URL instead of the 'SharePoint Site URL'.

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:

  1. Set up an alternative URL in SharePoint. (See the recommended configuration for securing Confluence access to SharePoint .)
  2. Select 'Use Alternative Access URL' on the Confluence 'SharePoint Admin' screen shown above.
Info
titleWhich 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.

(warning) 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.

...