Integrate Confluence

Integration enables importing data from Confluence into the knowledge base, automatically synchronising and re-indexing data.

note

If Confluence is hosted on your own infrastructure, allow network access to the Confluence API from Tovie Data Agent to enable integration.

Data to be downloaded

All pages of the Confluence space you specify are to be downloaded to the knowledge base, excluding comments and attachments. There is no option to download only certain pages or exclude specific pages.

caution

Make sure that the pages of the space do not contain confidential information. All downloaded data are available for indexing and use. Your customers or employees can access them when they ask questions to the knowledge base.

Confluence access token

To provide the knowledge base with access to Confluence, obtain a personal access token:

1. In Confluence, click your profile picture at the top right, then choose Settings.
2. Select Personal access tokens in the sidebar.
3. Click Create token. Fill in the parameters and click Create.
4. Copy the token.

For more information about access tokens, see the Confluence documentation.

Set up integration

To import data from Confluence:

1. Go to the Integrations section and click Connect.

   If you selected Connect Confluence integration when creating a project, you are redirected to the new integration page automatically.

   

2. Specify the integration settings:

   • Name: it is displayed in the Sources section as a prefix to the names of pages downloaded via the integration.

   • Automatically synchronise data: enable to keep the knowledge base up to date, disable for a one-time download.

     tip

     Avoid placing incorrect or sensitive data in your selected Confluence space, as it will automatically appear in the knowledge base during the next synchronisation.

   • Automatically restart indexing: start indexing after each auto synchronisation.

   • Confluence link: domain, for example, https://example.atlassian.com.

   • Space: space name.

   • Personal Access Token: see the Confluence access token subsection above.

   note

   All settings can be modified later.

3. Click Connect.

The integration status immediately after the setup is “Updating”. When the status changes to “Connected”, you can view the downloaded pages in the Sources section.

info

In addition to Confluence data, you can upload files manually section.

After downloading the data, the knowledge base needs to be indexed.

Force synchronisation

You can manually initiate downloading updated data from Confluence at any time, regardless of the automatic synchronisation settings.

1. Go to the Integrations section.

2. Click next to the integration and select Synchronise.

   

3. To make updated data available to users accessing the knowledge base, start re-indexing. To do this, click Index at the top of the page.

Change settings

To change the integration settings, go to the Integrations section, click next to the integration, and select Edit.

Delete integration

To delete the integration and all its data from the knowledge base:

1. Go to the Integrations section, click next to the integration and select Delete.

2. Go to the Sources section and delete the pages downloaded from the integration:

   1. In the search bar, enter the integration name, which serves as a prefix to the page names.
   2. Select all found pages and click the Delete button above the list of sources.

3. To start re-indexing, click Index at the top of the page.

note

Deleting certain sources from an active integration is not practical: they will be downloaded again with the next synchronisation.