Add or Edit a Confluence Server Source

Confluence is a knowledge sharing tool that enables users to create and share content. Members of the Administrators and Content Managers built-in groups can add the content of a Confluence instance to a Coveo organization.

Note

For clients migrating from Coveo Enterprise Search 7.0 (CES 7), the Confluence Server source has the same specifications as the Confluence V2 connector.

Tip
Leading practice

The number of items that a source processes per hour (crawling speed) depends on various factors, such as network bandwidth and source configuration. See About Crawling Speed for information on what can impact crawling speed, as well as possible solutions.

Source Key Characteristics

Features Supported Additional information
Confluence version 6 to 7

Only the minor versions currently maintained by Atlassian are supported. The latest version to have been tested with Coveo is 7.16.3.

Searchable content types check

Spaces, pages (such as Wiki pages), blog posts, comments on pages and blog posts (included as metadata), and attachments (in pages, blog posts, and comments)

Content update operations Refresh check

Requires the Coveo Confluence Plugin to take account of deleted, restored, and moved items, and items with modified comments or permissions.

Rescan check Takes place every day by default. If you change the name of a Confluence space, the rescan operation detects the change only for pages created or modified after the change. You must rebuild the source to get the space name change on all space pages.
Rebuild check
Content security options Determined by source permissions check

Requires the Coveo Confluence Plugin.

Source creator check
Everyone check

Requirements

Supported Confluence Versions

The source supports 6 to 7.16.3 on-premises installations using the Confluence REST API and Search REST API.

Note

Confluence Data Center is supported.

Atlassian Confluence Server Accessible to Coveo

When the access to communication ports between Coveo and the Confluence server is restricted, the appropriate ports must be opened in the network infrastructure such as in firewalls to allow Coveo to access the content.

Confluence Administrator Account

When you want to index Confluence permissions, you must create a specific Confluence administrator crawling account that will be only used for the source. Otherwise, you will need to also change the source Password value each time the account password changes to prevent authentication errors.

Note

When configuring the source, you must use the credentials of a native Confluence user. Users managed by other identity providers such as Google aren’t supported.

Enabling the Confluence SOAP Remote API (Web Service)

Due to a Confluence REST API limitation, the connector must use the SOAP Remote API to retrieve content permissions. For these permissions to be replicated in a Coveo-powered search interface, a Confluence system administrator must enable the remote API on your Confluence instance.

Add or Edit a Confluence Server Source

When adding a source, in the Add a source of content panel, click the On-Premises or the Crawling Module tab, depending on whether you need to use the Coveo On-Premises Crawling Module to retrieve your content. See Content Retrieval Methods for details.

To edit a source, on the Sources (platform-eu | platform-au) page, click the desired source, and then click Edit in the Action bar.

A Confluence Server source indexes on-premises (server) content. To retrieve cloud content instead, see Add or Edit a Confluence Cloud Source.

"Configuration" Tab

In the Add/Edit a Confluence Server Source panel, the Configuration tab is selected by default. It contains your source’s general and authentication information, as well as other parameters.

General Information

Content Update and Security Requirement

Download and install the Coveo Confluence plugin if you intend to select the Determined by source permissions content security option.

The Coveo Confluence Plugin allows the Coveo Platform to secure your content by replicating the Confluence item permissions system. As a result, through a Coveo-powered search interface, authenticated users only see the items that they’re allowed to access within Confluence.

The plugin is also needed to perform refresh operations.

Source Name

Enter a name for your source.

Tip
Leading practice

A source name can’t be modified once it’s saved, therefore be sure to use a short and descriptive name, using letters, numbers, hyphens (-), and underscores (_). Avoid spaces and other special characters.

Instance URL

Enter the address of the Confluence Wiki site or space that you want to make searchable. Ensure to include the protocol (http:// or https://).

Depending on your use case, use one of the following URL formats:

  • To index a complete Confluence site, add the Confluence server root URL:

    https://MyConfluenceServer:8090/

  • To index a specific space, add its URL:

    https://MyConfluenceServer:8090/display/space1

  • To index a specific space when Confluence isn’t installed at the server root:

    http://server/MyConfluence/display/spacename

Paired Crawling Module

If your source is a Crawling Module source, and if you have more than one Crawling Module linked to this organization, select the one with which you want to pair your source. If you change the Crawling Module instance paired with your source, a successful rebuild is required for your change to apply.

Character Optical Recognition (OCR)

If you want Coveo to extract text from image files or PDF files containing images, check the appropriate box. OCR-extracted text is processed as item data, meaning that it’s fully searchable and will appear in the item Quick View. See Enable Optical Character Recognition for details on this feature.

Note

Contact Coveo Sales to add this feature to your organization license.

"Authentication" Section

If you want to index secured content or index Confluence permissions to replicate them in your search interface, enter the credentials of a dedicated Confluence crawling account that has access to the content that you want to make searchable. See Source Credentials Leading Practices. This account must either have the Space Administrator or Confluence Administrator permission level on the Confluence space, depending on what you want to index:

Content to index Minimum permission level required
Item permissions only Confluence Administrator
Item changes following a refresh operation Space Administrator on all indexed spaces
Item permissions and changes following a refresh operation Confluence Administrator

For more information on Confluence permission levels, see Confluence Admin Permission Levels Explained.

"Content to Include" Section

Consider changing the default value of the parameters in this section to fine-tune how your Confluence site is crawled.

Space Type

Select which spaces you want to index. By default, global space content is indexed and personal space content isn’t.

Space Status

Select which spaces should be indexed, depending on their status. Options are:

  • Current (non-archived spaces)

  • Archived

Space Filter

If you want to index only a subset of a Confluence site, enter a regex that the desired spaces match. This parameter is especially useful when you want to index spaces that have an element in common in their space keys.

Example

You want to index all spaces with keys starting with an uppercase letter followed by a number, so you enter the following regex:

^[A-Z][0-9].*$

Options

Select the items to index:

  • Attachments (binary files attached to a page, blog post, or comment)

  • Comments (on blog posts and pages)

Note

Comments are indexed as page metadata rather than as items.

"Content Security" Tab

Select who will be able to access the source items through a Coveo-powered search interface. For details on this parameter, see Content Security.

"Access" Tab

In the Access tab, set whether each group and API key can view or edit the source configuration (see Resource Access):

  1. If available, in the left pane, click Groups or API Keys to select the appropriate list.

  2. In the Access Level column for groups or API keys with access to source content, select View or Edit.

Completion

  1. Finish adding or editing your source:

    • When you want to save your source configuration changes without starting a build/rebuild, such as when you know you want to do other changes soon, click Add Source/Save.

      Note

      On the Sources (platform-eu | platform-au) page, you must click Launch build or Start required rebuild in the source Status column to add the source content or to make your changes effective, respectively.

    • When you’re done editing the source and want to make changes effective, click Add and Build Source/Save and Rebuild Source.

      Back on the Sources (platform-eu | platform-au) page, you can review the progress of your source addition or modification.

      Once the source is built or rebuilt, you can review its content in the Content Browser.

  2. Optionally, consider editing or adding mappings once your source is done building or rebuilding.

Indexing Page Properties

By default, Coveo doesn’t index pages or blog post properties (metadata.properties). To do so, you must edit your source’s JSON configuration to specify the desired page properties.

In the Configuration tab of the Edit a Source JSON Configuration panel, add "MetadataPropertiesToExpand": "<VALUES>", where <VALUES> are the properties you want to index, separated by commas.

Example: "MetadataPropertiesToExpand": "owner,status"

To refer to a property nested within another, concatenate their names with a dot (.) separator.

Example: "MetadataPropertiesToExpand": "owner.lastname,status"

What’s Next?

What's next for me?