Add or Edit a Confluence Cloud Source

Members of the Administrators and Content Managers built-in groups can add the content of a Confluence Cloud instance to a Coveo Cloud organization. In a Coveo-powered search interface, the source content is accessible to either everyone or the source creator only (see Content Security).

Because plugins can’t be installed in Confluence Cloud, Coveo can’t include permissions for this content and can’t perform source refreshes.

By default, a Confluence Cloud source starts a rescan every day to retrieve Confluence Cloud item changes (addition, modification, or deletion).

Since June 3rd, 2019, due to a change in Atlassian Cloud sites, Confluence Cloud sources require an Atlassian account and an API token instead of a native user account and a password for authentication. If you have not yet edited your Confluence Cloud source to provide this information, you should do it as soon as possible so that your source continues to retrieve Confluence Cloud content.

For information regarding how to create an API token, see API tokens.

  • You can use the Confluence Cloud connector only when your Confluence content is hosted in Atlassian Cloud.

  • If you change the name of a space in Confluence Cloud, the rescan detects the change only for pages created or modified following the change. You must thus rebuild the source to get the space name change on all space pages (see Refresh, Rescan, or Rebuild Sources).

  • For clients migrating from Coveo Enterprise Search 7.0 (CES 7), the following source has the same specifications as the Confluence V2 connector (see Atlassian Confluence V2 Connector).

  • You can get the CONFLUENCE_UNREACHABLE_SERVER error message when your Confluence Cloud source rebuilds or is scheduled to perform a rescan during the Atlassian Cloud (1 AM to 3 AM daily) maintenance window during which Atlassian may block access to the API while performing maintenance tasks (see Maintenance windows).

    If possible, schedule rescans to start and complete outside of the daily maintenance window (see Edit a Source Schedule). If not possible, ignore the errors. The next scheduled rescan outside the maintenance window shall complete normally.

Source Features Summary

Features Supported Additional information
Confluence Cloud version Latest cloud version  
Searchable content types

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 Refresh

Rescan or rebuild needed to retrieve deleted, restored, and moved items, and items with modified comments or permissions.

Rescan  
Rebuild  
Content security options Determined by source permissions

Source creator  
Everyone  

Add or Edit a Confluence Cloud Source

  1. If not already in the Add/Edit a Confluence Cloud Source panel, access the panel:

    • To add a source, in the main menu, under Content, select Sources > Add source button > Confluence > Confluence Cloud.

      OR

    • To edit a source, in the main menu, under Content, select Sources > source row > Edit in the Action bar.

  2. In the Configuration tab, enter appropriate values for the available parameters:

    • Source name

      A descriptive name for your source under 255 characters (not already in use for another source in this organization).

      ConfluenceCloud-CorporateWiki

    • Instance URL

      A Confluence Wiki site or space address including the protocol (http:// or https://) that you want to make searchable.

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

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

        https://MyConfluenceServer.atlassian.net/wiki/

      • To index a specific Confluence Cloud space, add its URL:

        https://MyConfluenceServer.atlassian.net/wiki/display/space1

          where you replace `MyConfluenceServer` with your Confluence instance name, and `space1` with the desired Confluence space key.
        
    • Character optical recognition (OCR)

      Check this box if you want Coveo Cloud to extract text from image files or PDF files containing images (see Enable Optical Character Recognition). OCR-extracted text is processed as item data, meaning that it’s fully searchable and will appear in the item Quick View (see Search Result Quick View).

      Since the OCR feature is available at an extra charge, you must first contact Coveo Sales to add this feature to your organization license. You can then enable it for your source.

    • Index

      When adding a source, if you have more than one logical (non-Elasticsearch) index in your organization, select the index in which the retrieved content will be stored (see Leverage Many Coveo Indexes). If your organization only has one index, this drop-down menu isn’t visible and you have no decision to make.

      • To add a source storing content in an index different than default, you need the View access level on the Logical Index domain (see Privilege Management and Logical Indexes Domain).

      • Once the source is added, you can’t switch to a different index.

  3. In the Authentication section, when you want to include secured Confluence Cloud content, you must set the appropriate authentication parameters:

    • Atlassian account

      An email address corresponding to a dedicated Atlassian account that has access to all the content that you want to include.

      Remember that Confluence Cloud permissions aren’t supported. As a result, if you select the Everyone source content security option, end users of your Coveo-powered search interface will see all items to which this account has access.

    • API token

      An API token created with the specified Atlassian account (see API tokens).

      Since June 3rd, 2019, due to a change in Atlassian Cloud sites, Confluence Cloud sources require an Atlassian account and an API token instead of a native user account and a password for authentication. If you have not yet edited your Confluence Cloud source to provide this information, you should do it as soon as possible so that your source continues to retrieve Confluence Cloud content.

    • Advanced authentication options

      Select this check box to specify how Coveo Cloud should access your Confluence content, depending on the credentials you provided.

      • Select Use Kerberos authentication when the provided source credentials exist in both Confluence and Active Directory.

      • Select Bypass Single Sign-On to bypass your single sign-on authentication service in Confluence and authenticate with the provided native Confluence account.

  4. In the Content to Include section, consider changing the default value of the parameters in this section when you want to fine-tune how your Confluence Cloud site is crawled:

    • Space type

      Select Global and/or Personal to indicate the types of Confluence Cloud space whose content should be included. By default, only global space content is included.

    • Space status

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

      • Current (only non-archived spaces are retrieved)

      • Archived (only archived spaces are retrieved)

    • Space filter

      The regex to use to filter spaces when you want to include only a subset of a Confluence Cloud site.

      This parameter is useful when you have many spaces to include that have an element in common in their space keys.

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

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

    • Deselect one or more of the following Options when you want to prevent specific Confluence Cloud item types from being included:

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

      • Comments (on blog posts and pages)

        Comments are included as metadata of the page, not as items.

  5. In the 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.

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

    1. In the Access Level column, select View or Edit for each available group.

    2. On the left-hand side of the tab, if available, click Groups or API Keys to switch lists.

    If you remove the Edit access level from all the groups of which you’re a member, you won’t be able to edit the source again after saving. Only administrators and members of other groups that have Edit access on this resource will be able to do so. To keep your ability to edit this resource, you must grant the Edit access level to at least one of your groups.

  7. Optionally, consider editing or adding mappings (see Adding and Managing Source Mappings).

    You can only manage mapping rules once you build the source (see Refresh, Rescan, or Rebuild Sources).

  8. Complete your source addition or edition:

    • Click Add Source/Save 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.

      On the Sources page, you must click Start initial build or Start required rebuild in the source Status column to add the source content or make your changes effective, respectively.

      OR

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

      Back on the Sources page, you can review the progress of your Confluence source addition or modification (see Adding and Managing Sources).

    Once the source is built or rebuilt, you can review its content in the Content Browser (see Inspect Items With the Content Browser).

What’s Next?

Review the default update schedule and optionally change it so that it better fits your needs (see Edit a Source Schedule). By default, your content is rescanned every day.

Recommended Articles