Confluence integration

Use the Confluence integration to provide users with a way of searching your organization's Confluence workspace from within your digital workplace.

Contact the Customer Success Team to have this integration enabled in your digital workplace.

The confluence widget showing items return by a search of the term how.

Sections in this article:

Creating a service account in Confluence

The OAuth apps that you must create to use the widget are tied to an Atlassian user. We recommend that you create a service account that is only used for this purpose. This account does not need to have access to your Confluence workspace.

  1. Create an accessible email that the service account can use.
  2. Use this email to create an Atlassian account.

Creating an OAuth app in Confluence

Note:

  • You must create an OAuth app in Confluence for each Confluence widget you set up. 
  • Before beginning this step, you must know the URL of the page where the connected Confluence widget is deployed or will be deployed.
  1. Log into the Atlassian Developer Console with your service account.
  2. Select Create followed by OAuth 2.0 integration.
  3. Enter Igloo Integration as the Name of the app.
  4. Agree to Atlassian's developer terms and select Create.
  5. From the navigation menu, select Distribution followed by Edit.
  6. Edit the following distribution controls:
    • DISTRIBUTION STATUS: Select Sharing.
    • Vendor name: Enter Igloo Software.
    • Privacy policy: Enter https://resources.igloosoftware.com/privacy_policy.
    • PERSONAL DATA DECLARATION: Select No.
  7. Select Save changes.
  8. From the navigation menu, select Permissions.
  9. Configure the User identity API:
    1. Select the Add action.
    2. Select the Configure action.
    3. Select Edit Scopes.
    4. Select the following scopes:
      • View active user profile
      • View user profiles.
    5. Select Save.
  10. From the navigation menu, select Permissions.
  11. Configure the Confluence API:
    1. Select the Add action.
    2. Select the Configure action.
    3. Select Edit Scopes.
    4. Select the following scopes:
      • Read Confluence space summary
      • Read Confluence content properties
      • Read Confluence detailed content
      • Read Confluence content summary
      • Search Confluence content and space summaries
      • Read content permission in Confluence
      • Read user
      • Read user groups
      • Download content attachments
    5. Select Save.
  12. From the navigation menu, select Authorization.
  13. For the OAuth 2.0 (3LO) authorization type, select Add.
  14. Enter the URL of where the Confluence widget is located in your digital workplace as the Callback URL. For example: https://customercare.igloosoftware.com/. Copy this value to a safe location as it will be needed when configuring the integration in your digital workplace.  
  15. Select Save changes.
  16. From the navigation menu, select Settings.
  17. Copy the Client ID and Secret to a safe location. They will be needed when configuring the integration in your digital workplace.

Set up

  1. Place an  Integrations widget on a page, space, or dashboard. For more information, see Placing and setting up a widget. For the best experience, avoid placing this widget in side columns.
  2. Select the placed widget's Edit button.
  3. Under Integration Library, select Igloo Integration Library.
  4. Select  Confluence from the library.
  5. Review and make changes to the settings on the Options and Appearance tabs. You can find details about the widget's settings in the Settings section below.
  6. In the widget editor, select Update to apply your changes.
  7. At the bottom of your page, space, or dashboard, select Publish or Save as Draft to save your changes.

Settings

Options tab

General options
Setting Description
Title

Enter a title for the widget. The title appears as a heading above the widget's contents. You should use the title to provide context to the widget and better structure a page's content by clearly denoting different sections.

When entering a title, you do so only for your currently selected language. If your digital workplace supports multiple languages, you should select  Translation and enter a title for each supported language. 

This field can contain a maximum of 140 characters.
Title link

Enter the URL of a location in your digital workplace. Users who click the widget's title, if it has one, will go to this location. Whether you enter the link as a relative URL or an absolute URL does not matter, it will convert to an absolute URL the next time you edit the widget.

This field can contain a maximum of 2,083 characters.
Description

Enter a description for the widget. The description appears between the title and the widget's contents. You can use this text to provide information to users about the widget.

When entering a description, you do so only for your currently selected language. If your digital workplace supports multiple languages, you should select  Translation and enter a description for each supported language.
Basic configuration options
Setting Description
Atlassian Confluence instance URL

 Enter the URL of your Confluence workspace. Do not include the trailing slash.

Example: 
https://yourworkplace.atlassian.net
Igloo-Atlassian Integration App Client ID

 Enter the Client ID that you copied in step 17 of Creating an OAuth app in Confluence.
Igloo-Atlassian Integration App Client Secret

 Enter the Client Secret that you copied in step 17 of Creating an OAuth app in Confluence.
Igloo-Atlassian Integration App Redirect URI

 Enter the Callback URL that you entered in step 14 of Creating an OAuth app in Confluence.
Advanced options
Setting Description
Maximum number of search results per page

 Enter how many results are shown per page.
Display content type filter

 Select to display the content type filter.
Display space filter

 Select to display the space filter.
Display contributor filter

 Select to display the contributor filter.
Display modified filter

 Select to display the date modified filter.
Display widget in compact mode

 Select to display the widget in compact mode. This option reduces the interface components and allows the widget to better fit in narrow side columns.
Check to load styles from the main Igloo stylesheet

 Select to apply styles from your digital workplace's theme.

Appearance tab

Appearance options
Setting Description
Class

 Enter CSS class selectors to provide additional styling to the widget. For more information, see Applying custom CSS to widgets.
Height

 Select the height of the widget.

The default value is Auto (leftmost slider position) scales the widget's height to fit its contents. You can use the slider to set a fixed height between 50px to 600px in increments of 50px.

Selecting a height less than what is needed to display its contents results in the widget having a vertical scrollbar.

Note

Your digital workplace's theme overwrites many of the settings on the Appearance tab. However, the settings listed above are usable.

How to use it

You must log into the integration using your Atlassian account.

The prompt to connect to confluence.Prompt to authenticate to Atlassian.

The integration requesting authentication to your Atlassian account.

Once logged in, enter your search term in the provided search box and select Search.

You can also apply the following filters (if enabled) before a search to narrow down your search results:

  • Content Type: Select from the available content types: All, Page, Blog Post, Attachment, or Comment.
  • Modified: Select a date or date range to return only content modified during this period.
  • Space: Enter the name of a space you want to search. Select whether Confluence Personal Spaces should be included in search results.
  • Contributor: Enter the name of a contributor to only show their content.