Using the SharePoint 2010 Web Parts (v 1.4)

Owned by Almuth Boehme [Communardo]
Aug 19, 2016
7 min read

This page tells you how to embed Confluence content into SharePoint pages, when your SharePoint and Confluence sites are connected via the Confluence SharePoint Connector. The instructions on this page apply to SharePoint 2010.

The SharePoint Connector provides SharePoint web parts that you can use to display Confluence pages, blog posts and page/blog trees in SharePoint. Users can view the Confluence content from within SharePoint and click through from SharePoint to Confluence.

Quick guide to adding Confluence content on SharePoint pages

  • Go to a web part page in SharePoint and edit the page.
  • Click 'Add a Web Part' in the zone where you want to put your Confluence web part.
  • Scroll down to find the Confluence web parts:
    • Select the 'Confluence Page' web part if you want to embed a single Confluence page.
    • Select the 'Confluence Pages Tree View' web part if you want to embed a hierarchical tree of pages from a Confluence space.
  • The web part is now part of your SharePoint page. Click the web part's dropdown menu and select 'Modify Shared Web Part' or 'Edit Web Part'.
  • The web part editor appears. Select the required space, and the page if relevant.
  • Click 'OK'.

The rest of this page gives more details of the above procedure.

On this page:

Adding a SharePoint Web Part

Below is a summary of how to add the Confluence web parts in SharePoint. For detailed instructions on the SharePoint side of things, please refer to the SharePoint online help.

To add a SharePoint web part, you need SharePoint 'Design' permission level or better.

You can add web parts to a SharePoint 'web part page'. Many of the pages in SharePoint are web part pages, including the home page in any SharePoint site. You can also create web part pages in a document library that has the 'Web Part Page' document template. Such a document library typically has the name 'Pages'.

To add the Confluence web parts in SharePoint,

  1. Go to a web part page in SharePoint.
  2. Edit the page. (Click 'Page' then 'Edit Page' in the ribbon, or click 'Site Actions' then 'Edit Page'.)
  3. The page opens in edit mode, showing the web part zones defined for the page. Click 'Add a Web Part' in the zone where you want your web part to reside.
  4. The web part selection dialogue appears. Select 'Confluence Web Parts' in 'Categories' column.
  5. The list of Confluence web parts appears in the 'Web Parts' column. Select the one you want. Details of each web part are below.
  6. Click 'Add'.

Screenshot 1: The 'Edit Page' option in the SharePoint ribbon

Screenshot 2: Selecting the Confluence web parts

Using the Confluence Page Web Part

You can use the Confluence Page web part to display a specific page from Confluence in SharePoint.

To add and customise the Confluence Page web part,

  1. Add the 'Confluence Page' web part, following the instructions above.
  2. The web part is now part of your SharePoint page. Click the web part's dropdown menu and select 'Edit Web Part'.
  3. The 'Confluence Page' web part editor appears on the right of the screen. Select the required space from the 'Space' dropdown list.
  4. A hierarchical (tree view) list of pages appears. Select the required page, or enter the page name into the 'Page Title' text box.
  5. Click 'OK' or 'Apply' to make the page show in the web part.

See our guide to web part connections for information on connecting this web part to other web parts.

Screenshot 3: The 'Confluence Page' web part editor on the right of the screen

As shown in the above screenshot, the 'Confluence Page Selection' web part editor displays the following information:

  • The Confluence 'Host' comes from the settings in SharePoint's 'Confluence Settings' page (found under 'Site Settings').
  • The list of Confluence spaces shows only those spaces that the user has permission to see, based on the Confluence space permissions.

Using the Confluence Pages Tree View Web Part

You can use the Confluence Pages Tree View web part to display a hierarchical view of pages from a specific Confluence space.

To add and customise the Confluence Pages Tree View web part,

  1. Add the 'Confluence Pages Tree View' web part, following the instructions above.
  2. The web part is now part of your SharePoint page. Click the web part's dropdown menu and select 'Edit Web Part'.
  3. The 'Confluence Pages Tree View' web part editor appears on the right of the screen. Select the required space from the 'Space' dropdown list.
  4. Select the 'Show Space List' option:
    • If you select this option, the web part on the SharePoint page will display a dropdown menu allowing users to select a different space.
    • If you do not select this option, users will see only the page tree for the space that you selected. They will not be able to choose a different space.
  5. Select the 'Only show the home page and its children' option:
    • If you select this option, the web part will only display pages in the tree view that are saved as children of the home page of the selected space.
    • If you do not select this option, all pages in the space will be shown.
  6. Click 'OK' or 'Apply' to make the page tree show in the web part.

See our guide to web part connections for information on connecting this web part to other web parts.

Screenshot 4: The 'Confluence Pages Tree View' web part editor on the right of the screen

As shown in the above screenshot, the 'Confluence Space Selection' web part editor displays the following information:

  • The Confluence 'Host' comes from the settings in SharePoint's 'Confluence Settings' page (found under 'Site Settings').
  • The list of Confluence spaces shows only those spaces that the user has permission to see, based on the Confluence space permissions.

Screenshot of SharePoint Page with Two Web Parts

This screenshot shows a SharePoint page containing a Confluence Web Page web part and a Confluence Pages Tree View web part.

Screenshot 5: A SharePoint page with the two Confluence web parts

Using the Confluence Blog Post Web Part

You can use the Confluence Blog Post web part to display a specific blog post from Confluence in SharePoint.

To add and customise the Confluence Blog Postweb part,

  1. Add the 'Confluence Blog Post' web part, following the instructions above.
  2. The web part is now part of your SharePoint page. Click the web part's dropdown menu and select 'Modify Shared Web Part'.
  3. The 'Confluence Blog Post Selection' web part editor appears. Select the required space from the 'Space' dropdown list.
  4. A hierarchical (tree view) list of blog posts appears. Select the desired blog post.
  5. Click 'OK' or 'Apply' to make the page show in the web part.

See our guide to web part connections for information on connecting this web part to other web parts.

Screenshot 6: The Confluence Blog Post web part

Showing the Latest Blog Post

You can configure the Confluence Blog Post web part to always display the most recent blog post in a Confluence space. This option is available when editing the web part. Instead of selecting a blog post to display from the hierarchical list of blog posts, simply select the 'Display latest blog' option. After saving your changes, the web part will immediately update to display the contents of the most recent blog post in the selected space.

Screenshot 7: Configuring the "Display Latest Blog" option

Using the Confluence Blog Posts Tree View Web Part

You can use the Confluence Blog Post Tree View web part to display a hierarchical view of blog posts in a specific Confluence space, sorted chronologically.

To add and customise the Confluence Blog Posts Tree View web part,

  1. Add the 'Confluence Blog Posts Tree View' web part, following the instructions above.
  2. The web part is now part of your SharePoint page. Click the web part's dropdown menu and select 'Modify Shared Web Part'.
  3. The 'Confluence Space Selection' web part editor appears. Select the required space from the 'Space' dropdown list.
  4. Select the 'Show Space List' option:
    • If you select this option, the web part on the SharePoint page will display a dropdown menu allowing users to select a different space.
    • If you do not select this option, users will see only the page tree for the space that you selected. They will not be able to choose a different space.
  5. Click 'OK' or 'Apply' to make the page tree show in the web part.

See our guide to web part connections for information on connecting this web part to other web parts.

Screenshot 8: The Confluence Blog Posts Tree View web part

Hiding and Showing Comments

By default, when displaying a Confluence page using the Confluence Page web part, or a Confluence blog post using the Confluence Blog Post web part, any comments on the page or blog post will also be displayed.

Screenshot 9: Displaying page comments in the Confluence Page web part


To prevent the comments from displaying, edit the web part and ensure that the 'Display Comments' option is not selected.

Screenshot 10: Disable the 'Display Comments' option to hide any comments on the page

Hiding and Showing Attachments

By default, when displaying a Confluence page using the Confluence Page web part, or a Confluence blog post using the Confluence Blog Post web part, any attachments on the page or blog post will also be displayed in a collapsible section at the top of the web part.

Screenshot 11: Disable the 'Display Attachments' option to hide any attachments on the page

To prevent the attachments from being displayed, edit the web part and ensure that the 'Display Attachments' is not selected.

RELATED TOPICS

SharePoint Connector User's Guide
Configuring the SharePoint Web Part on SP 2010