- Amazon S3 Source
- Box Business Source
- Catalog Source
- Confluence Cloud Source
- Confluence Self-Hosted Source
- Database Source
- Dropbox Business Source
- Exchange Enterprise Source
- File System Source
- Generic REST API Source
- Gmail for Work Source
- Google Drive for Work Source
- Jira Software Cloud Source
- Jira Software Self-Hosted Source
- Jive Cloud Source
- Jive Server Source
- Khoros Community Source
- Microsoft Dynamics 365 Source
- OneDrive for Business Source
- OTCS Source
- Push Source
- RSS Source
- Salesforce Source
- ServiceNow Source
- SharePoint Online Source
- SharePoint Online Legacy Source
- SharePoint Server Source
- Sitecore Source
- Sitemap Source
- Twitter Source
- Web Source
- YouTube Source
- Zendesk Source
- Connector Building Best Practices
Add or Edit a Confluence Cloud Source
A Confluence Cloud source is a cloud-based knowledge sharing tool that enables users to create and share content. Members of a Coveo organization with the required privileges can add the source to index the content of their Confluence Cloud instance.
For clients migrating from Coveo Enterprise Search 7.0 (CES 7), the Confluence Cloud source has the same specifications as the Confluence V2 connector.
Source Key Characteristics
|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 operations||Refresh||
A refresh won't take account of deleted, restored, and moved items, and items with modified comments or permissions. Therefore, a rescan or a rebuild is recommended.
Takes place every day by default. 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 therefore rebuild the source to get the space name changed on all space pages.
|Content security options||Determined by source permissions||
Since plugins can't be installed in Confluence Cloud, Coveo can't index permissions for this content.
Add or Edit a Confluence Cloud Source
When adding a source, select the Confluence Cloud option.
A Confluence Cloud source indexes cloud content. If you want to retrieve on-premises (server) content, see Add or Edit a Confluence Self-Hosted Source instead.
In the Add/Edit a Confluence Cloud Source panel, the Configuration tab is selected by default. It contains your source’s general and authentication information, as well as other parameters.
Enter a name for your source.
Use a short and descriptive name, using letters, numbers, hyphens (
-), and underscores (
_). Avoid spaces and other special characters.
Enter the address of the Confluence Wiki site or space that you want to make searchable. Ensure to include the protocol (
To index a complete site, enter the Confluence Cloud server root URL:
where you replace
<INSTANCE_NAME>with your Confluence Cloud instance name.
To index a specific space, enter its URL:
where you replace
<INSTANCE_NAME>with your Confluence Cloud instance name and
<SPACE_KEY>with the desired 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. 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.
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.
Enter an email address corresponding to a dedicated Atlassian account that has access to all the content that you want to index. See Source Credentials Leading Practices.
Since Confluence Cloud permissions aren’t supported, if you select the Everyone option in the Content Security tab, end users of your Coveo-powered search interface will be able to access all items to which this account has access. We therefore strongly recommend to ensure that this account can access public content only.
Enter an API token created with the specified Atlassian account.
Advanced Authentication Options
Check this box to specify how Coveo Cloud should access your Confluence content, depending on the credentials you provided.
Select Use Kerberos authentication when the credentials you entered above exist in both Confluence and Active Directory.
Select Bypass single sign-on (SSO) to bypass your single sign-on authentication service in Confluence and authenticate with the provided native Confluence account.
“Content to Include” Section
Consider changing the default value of the parameters in this section to fine-tune how your Confluence Cloud site is crawled.
Select which spaces you want to index. By default, global space content is indexed and personal space content isn’t.
Select which spaces should be indexed, depending on their status. Options are:
Current (non-archived spaces)
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.
You want to index all spaces with keys starting with an uppercase letter followed by a number, so you enter the following regex:
Select the items to index:
Attachments (binary files attached to a page, blog post, or comment)
Comments (on blog posts and pages)
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.
In the Access tab, determine whether each group and API key can view or edit the source configuration (see Resource Access):
In the Access Level column, select View or Edit for each available group.
On the left-hand side of the tab, if available, click Groups or API Keys to switch lists.
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.
To add the source content or to make your changes effective, on the Sources page, you must click Start initial build or Start required rebuild in the source Status column.
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 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.
Optionally, consider editing or adding mappings.
You can only manage mapping rules once you build the source (see Refresh, Rescan, or Rebuild Sources).
Source Update Best Practice
You can get the
CONFLUENCE_UNREACHABLE_SERVER error message when your Confluence Cloud source rebuilds or is scheduled to perform a rescan during the daily Atlassian Cloud maintenance window (1 AM to 3 AM, in your server’s time zone). During this period, Atlassian may block access to the API while performing maintenance tasks.
If possible, schedule your source’s rescans so that they’re completed outside of the daily maintenance window. If not possible, ignore the errors. The next scheduled rescan outside the maintenance window shall complete normally.