Confluence integration

Jamie Kandola
Jamie Kandola
  • Updated

About

The Confluence integration lets you show pages from your Confluence wiki inside your policies and procedures in ControlMap. Your team keeps writing its policy, procedure and governance content in Confluence, while the document, its mappings and its other relationships stay in ControlMap for audit purposes.

In Add Integration, the card is named Confluence Content Widget. It does not collect assets, users or compliance checks. Once it is connected, you can create a document in Documents that pulls in the content of a Confluence page and keeps it in sync.

Before you start

You need these from Confluence:

  • Setting up integrations from the client portal is part of the Pro plan. For details, see the Free, Essentials and Pro plans article.
  • The address of your Confluence site, without a trailing slash. For example, https://ctrlmap.atlassian.net.
  • The user name or email of the Confluence user that ControlMap will connect as. The setup page suggests a service account. ControlMap reads Confluence with the permissions granted to this user.
  • An API token for that user.

Connect Confluence

  1. Go to Monitor › Integrations and select Add Integration.
  2. Search for Confluence and select the Confluence Content Widget card.

The Add Integration window with Confluence typed in the search box and the Confluence Content Widget card, described as embedding content from Confluence wiki in policies and procedures

  1. On the Confluence Connection Settings page, fill in all four fields:
    • Connection Name: a name you will recognise. It starts as "Confluence connection".
    • Base URI (Do not include trailing slashes): your Confluence site address.
    • User Name / Email: the Confluence user name or email.
    • API Token: the user's API token.
  2. Select Save connection. If ControlMap can't connect, it shows "Cannot connect. Please check your user name and user secret". Check your details and try again.

The Add Confluence Content Widget page with the Connection Name, Base URI, User Name / Email and API Token fields, the Cancel and Save connection buttons, and a help panel on the right

The setup is a single page. There are no further steps. To leave without saving, select Cancel. The Connect an integration article covers the parts of Integrations that are the same for every tool, such as finding and opening a connection.

Add Confluence content to a document

Once Confluence is connected, the Confluence option appears in Documents. Until then it is not in the menu.

  1. Go to Documents and open the Actions menu.
  2. Select Add from Confluence. ControlMap creates a document whose content comes from Confluence.
  3. Open the document. It shows a Confluence content viewer, with the note "Content is synchronized from the connected Confluence page."
  4. In the Page id field, enter the ID of the Confluence page. To show more than one page, enter several IDs separated by commas. The pages appear as links.

Until you enter a page ID, the viewer says "Not connected to Confluence. Add the page id to synchronize content from this integration."

Only Compliance Managers and Super Admins can change the page ID, and only while the document is not approved or published.

What you'll see after connecting

The Confluence connection appears as a card on Monitor › Integrations. Because it collects no assets, users or checks, it adds nothing to the other Monitor tabs. Its content shows up in the documents you create with Add from Confluence.

Disconnect or change settings

To change the connection details:

  1. Go to Monitor › Integrations and select the Confluence card.
  2. On the Connection tab, edit a setting. The API token stays hidden.
  3. Select Test connection to check that the saved details still work, then Update Connection to save.

To delete the connection:

  1. Go to Monitor › Integrations.
  2. Select the bin icon on the Confluence card.
  3. When "Delete Integration?" asks you to confirm, choose Yes. Choose No to keep it.

Was this article helpful?

Yes! No