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, provide 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. There is no option to download only certain pages or exclude specific pages.

Images attached to pages are to be downloaded along with them.

In the integration settings, you can enable downloading other attached files in acceptable formats. The same formats are acceptable as for manual upload.

Images are always downloaded.

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.

Set up integration

To import data from Confluence:

1. Go to the Integrations section and click Connect → Confluence.

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

2. Specify the integration settings:

   

   • Integration name: serves as a prefix for the names of sources downloaded from this integration.

   • Segments: specifies segments to assign to sources downloaded from this integration. Segments can be used to group sources with a common theme. You can specify segments when querying the knowledge base to search within those segments only. For more details, see the Segments section.

   • Space name (not a space key).

   • Parameters to access Confluence:

     • If you use Confluence Data Center or Confluence Server, paste a link to your Confluence and a personal access token.

       How to get an access token

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

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

     • If you use Confluence Cloud, specify your site (subdomain) on atlassian.net.

   • Download files attached to pages: enable this to download page attachments in acceptable formats. This setting does not affect downloading images: they are downloaded anyway.

   • 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: enable to re-index the knowledge base after each synchronisation.

   note

   All settings can be modified later, except for the space name and Confluence link for Confluence Cloud; once connected, these fields become uneditable.

3. Click Connect.

4. If you connect Confluence Cloud, a page prompting you to approve the access request will open in a new tab. Sign in to Confluence Cloud and allow the Tovie Data Agent application to access your data.

   info

   Access is valid for one year. After that, you’ll need to approve it again.

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

In addition to integration data, you can also upload files manually.

After loading the data, you need to index the knowledge base.

info

To learn more about forced synchronisation and changing settings, see Manage integrations.