Community

Product DocsMenu

Installing the Coveo Plugin for Atlassian Confluence

The Coveo Legacy connector for Confluence comes with a Confluence plugin. The connector needs the plugin to index permissions associated with each Confluence item so that users only see Confluence content to which they have access in Coveo search results. It is therefore recommended to install the plugin for Confluence 3.5.x, 4.x, and 5.8.5 on-premises installations.

Without the plugin, you must set the permissions globally on the source (see Configuring and Indexing an Atlassian Confluence Source With the Legacy Connector), and all indexed Confluence content is searchable by anyone that has the permissions to view the source content.

Notes:

  • The Coveo plugin cannot be installed in Confluence Cloud and consequently, permissions associated with each Confluence item cannot be indexed.

  • The Coveo plugin is distributed with CES and is not available from the Atlassian Marketplace.

  • CES 7.0.7183+ (November 2014) The Coveo Plugin for Atlassian Confluence is updated to version 1.01 to allow to specify an email security provider inside the Confluence security provider (see Creating a Security Provider for the Atlassian Confluence Legacy Connector).

To install or update the Coveo Confluence Plugin

  1. Log into your Confluence server using a Confluence administrator account.

  2. On the menu, click Browse > Confluence Admin.

  3. If the Administrator Access dialog box appears, enter your administrator account credentials, and then click Confirm.

  4. In the navigation panel on the left, under Atlassian Marketplace, click Manage add-ons.

  5. In the Manage add-ons page, click the Upload add-on link.

  6. In the Upload add-on dialog box:

    1. Click Choose File.

    2. In the Open dialog box, select the [CES_Path]\Bin\Coveo.CES.CustomCrawlers.Confluence.Plugin.jar file from your Coveo Master server, and then click Open.

    3. Click Upload.

  7. In the Installed and ready to go! dialog box, click Close.

    Note: CES 7.0.8225– (March 2016) In the Confluence Manage add-ons page, the Coveo plugin reports being v. 1 even if it is actually version 1.0.1.

    You can see the actual plugin version in the CES index logs by looking for the message in the form: 

    Confluence plugin version is: [pluginVersion]

  8. In the User-installed add-ons list, validate that the Coveo Enhanced Soap API Plugin is listed.

Note: If you reinstall or upgrade the Coveo plugin on your Confluence instance, you must restart the Confluence service to overcome a known Confluence issue that causes Confluence to return an IllegalArgumentException when the Coveo plugin is used, preventing to index your Confluence source (see Broken Webservice when redeploying RPC Plugin Module).

When this issue occurs, you can get error messages similar to the followings depending on your CES version:

  • CES 7.0.8388+ (June 2016) CONFLUENCE_LEGACY_PLUGIN_UNABLE_TO_CONNECT

  • CES 7.0.8225– (March 2016)
    An error occurred while initializing the Blade "[Confluence_Source_Name]" (ID #8): Unexpected exception in method 'InitBlade': 
Coveo.CES.CustomCrawlers.Confluence.ConfluenceFatalException: Unable to connect to the Confluence database ---> Coveo.CES.CustomCrawlers.Confluence.ConfluenceFatalException: 
Unable to connect to the Confluence database ---> Coveo.CES.CustomCrawlers.Confluence.ConfluenceFatalException: Unable to connect to the Coveo enhanced web service ---> 
Coveo.CES.CustomCrawlers.Confluence.ConfluenceIgnorableException: SoapException ---> System.Web.Services.Protocols.SoapException: 
The AXIS engine could not find a target service to invoke!  targetService is coveo-enhanced-service  
    An error occurred while initializing the Blade "[Confluence_Source_Name]" (ID #6): Unexpected exception in method 'InitBlade': Coveo.CES.CustomCrawlers.Confluence.ConfluenceFatalException: Unable to connect to the Confluence database ---> Coveo.CES.CustomCrawlers.Confluence.ConfluenceFatalException: Unable to connect to the Confluence database ---> Coveo.CES.CustomCrawlers.Confluence.ConfluenceFatalException: Unable to connect to the Coveo enhanced web service ---> Coveo.CES.CustomCrawlers.Confluence.ConfluenceIgnorableException: SoapException ---> System.Web.Services.Protocols.SoapException: Tried to invoke method public abstract java.lang.String com.coveo.confluence.plugins.enhancedsoapapi.EnhancedSoapAPI.getPluginVersion(java.lang.String) with arguments java.lang.String.  The arguments do not match the signature.; nested exception is: java.lang.IllegalArgumentException: object is not an instance of declaring class

To uninstall the Coveo Confluence plugin

  1. Log into your Confluence server using a Confluence administrator account.

  2. On the menu, click Browse > Confluence Admin.

  3. If the Administrator Access dialog box appears, enter your administrator account credentials, and then click Confirm.

  4. In the navigation panel on the left, under Atlassian Marketplace, click Manage add-ons.

  5. In the User-installed add-ons list, locate and expand Coveo Enhanced Soap API Plugin.

  6. In the Coveo Enhanced Soap API Plugin section, click Uninstall.

  7. In the Confirm dialog box, click Continue.

  8. Validate the Coveo Enhanced Soap API Plugin is no longer listed in the User-installed add-ons list.

People who viewed this topic also viewed