Add/Edit a Source - Panel
- Amazon S3 Source
- Box (Personal) Source
- Box Business V2 Source
- Box Business Legacy Source
- Confluence Cloud Source
- Confluence Legacy Source
- Confluence Self-Hosted Source
- Database Source
- Dropbox (Personal) Source
- Dropbox Business Source
- Exchange Enterprise Source
- Exchange Online (Personal) Source
- File System Source
- Generic REST API Source
- Gmail for Work Source
- Gmail (Personal) Source
- Google Drive (Personal) Source
- Google Drive for Work Source
- Jira Software Cloud Source
- Jira Software Self-Hosted Source
- Jive Cloud Source
- Jive Server Source
- Lithium Source
- Microsoft Dynamics Source
- OneDrive for Business Source
- Push Source
- RSS Source
- Salesforce Source
- SharePoint Online Source
- SharePoint Online Legacy Source
- SharePoint Server Source
- Sitecore Source
- Sitemap Source
- Twitter Source
- Web Source
- YouTube Source
- Zendesk Source
Add/Edit Confluence Legacy Source - Panel
Deprecated The Confluence legacy source is not available by default in Coveo Cloud V2 licenses. You must contact Coveo Support to request the source. The only relevant use case for this source is when your Confluence instance version is between 5.5 and 5.7. 5.5 to 5.7 are versions that are no longer supported by Confluence and not supported by the second generation Confluence source (see Add/Edit Confluence Self-Hosted Source - Panel).
The second generation Confluence source uses the Confluence REST API (see Add/Edit Confluence Self-Hosted Source - Panel). It is strongly recommended to use the new Confluence source with the benefit of source refresh support and significantly better source creation and update performance, among other things.
When you have the required privileges, you can add the content of a Confluence instance (5.5 to 5.8.5 on-premises installations) to your Coveo Cloud organization. The source can be shared, private, or secured (see Source Permission Types).
The Coveo Confluence Plugin available for on-premises Confluence instances allows the Coveo Cloud Platform to manage permissions associated with each Confluence items so that users only see Confluence content in Coveo search results to which they have normally access in Confluence itself.
By default, a Confluence source starts a rescan every hour to retrieve Confluence item changes (addition, modification, or deletion).
The Confluence legacy source does not support refreshes. A source rescan or rebuild is required to keep your content up to date.
If you change the name of a space in Confluence, the rescan detects the change only for pages created or modified following the change. You must rebuild the source to get the space name change on all space pages (see Refresh, Rescan or Rebuild Sources).
Source Features Summary
|Confluence version||5.5 to 5.8.5|
|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)
|Rescan||Rebuild needed to apply space name changes (if any) to all space pages.|
Requires the Coveo plug-in.
Supported Confluence Versions
The source supports 5.5 to 5.8.5 on-premises installations using the Confluence SOAP remote API (Web service).
Confluence Administrator Account
When you want to include Confluence permissions, you must create a specific Confluence administrator account that will be only used for the source.
When configuring the source, you must use the credentials of a native Confluence user. Users managed by other identity providers such as Google are not supported.
The actions that you must perform before configuring source parameters:
Enable the Confluence Remote API
The Confluence source requires the Confluence SOAP remote API (Web service) to be enabled on your Confluence server (see the Atlassian item Enabling the Remote API).
Install the Coveo Plugin
When you want to include permissions, you must download and install the Coveo Confluence plugin on your Confluence server:
Download the Coveo plugin for Confluence.
On your Confluence server, proceed the installation of the plugin (see Installing the Coveo Plugin for Atlassian Confluence).
Indexing permissions associated with each Confluence object is recommended as it allows the Coveo search interface to only show Confluence items to which the end-user performing the search has access in Confluence.
Atlassian Confluence Server Accessible to Coveo Cloud
When the access to communication ports between Coveo Cloud and the Confluence server is restricted, the appropriate port(s) must be opened in the network infrastructure such as in firewalls to allow Coveo Cloud to access the content.
Add or Edit a Confluence Legacy Source
Ensure your Confluence instance meets the source requirements (see Requirements).
If not already in the Add/Edit a Confluence Source panel, go to the panel:
To add a source, in the main menu, under Content, select Sources > Add source button > Confluence > Confluence Legacy.
To edit a source, in the main menu, under Content, select Sources > source row > Edit in the Action bar.
In the Configuration tab, enter appropriate values for available parameters:
A descriptive name for your source under 255 characters (not already in use for another source in this organization).
One or more Confluence Wiki site and space addresses including the protocol (http:// or https://) that you wish to make searchable.
Depending on your use case, use one of the following URL formats:
To index a complete Confluence (on-premises) site, add the Confluence server root URL:
To index specific on-premises spaces, add their URL:
To be able to include item permissions, all your URLs must be located on a single Confluence site. Create separate sources for separate sites.
You can enter specific space addresses for deployments where Confluence is not installed at the server root, respecting the following format:
Select who can see items from this source in a search interface that includes this source in its scope (see Source Permission Types):
Private: Only you, when you are authenticated to the search interface with the identity with which you create the source.
Secured: Only users authenticated in the search interface will see the source items for which they have read permission.
When you want to include secured Confluence content or include permissions, you must fulfill the following parameters:
The username of a dedicated Confluence administrator account who has access to all the content that you wish to include.
The corresponding password.
Web service URL
When the source security is Secured, the address of the Confluence server in the following format:
The URL should be the same address as the one you specified in the Instance URL box.
Enhanced web service URL
When the source security is Secured, the URL pointing to the Coveo web service provided by the Coveo Confluence Plugin on the Confluence server in the following format:
In the Configuration Access tab, determine whether each group and API key can view or edit the source configuration. 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.
If you remove the Edit access level from all the groups of which you are a member, you will not 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.
Optionally, consider editing or adding mappings (see Edit the Mappings of a Source: [SourceName]).
You can only manage mapping rules once you build the source (see Add/Edit a Source - Panel).
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.
In the Sources page, you need to click Start initial build or Start initial rebuild in the source Status column to respectively add the source content and make your changes effective.
Click Add and Build Source/Save and Rebuild Source when you are done editing the source and want to make changes effective.
Back in the Coveo Cloud administration console Sources page, you can review the progress of your Confluence source addition or modification (see Sources - Page).
Once the source is built or rebuilt, you can review its content in the content browser (see Content Browser - Page).
Review the default refresh schedule in which a source rescan starts every hour (see Edit a Source Schedule: [SourceName] - Panel).