Installing the Coveo Plugin for Jive

The Jive source comes with an optional Coveo plugin that you can install on your Jive server to allow the Jive source to access Jive features that are not available through the regular Jive 6+ APIs.

You cannot install the Coveo plugin in Jive Cloud.

Plugin Benefits

The Jive source can work without the plugin, but using the plugin enables the following source features:

  • Retrieving permissions
  • Retrieving direct messages
  • Removing recently deleted Jive items from the index during a refresh
  • Proper refresh of discussions
  • Phrase substitutions

The plugin stores deleted item information on the Jive server in a database to allow source refreshes to remove deleted items from the index. The Coveo crawler reads the deleted items in this database and then clears them. If no source is set to include the Jive site content, the plugin database grows indefinitely.

Install the Coveo Plugin on Your Jive Server

  1. Using an administrator account, with a browser, log into the Jive Administration Console (http://[MyJiveCommunity]/admin):

    1. Check the Jive version number in the upper right corner of the Jive interface.

    2. If you are using a Jive version between 6.2 and 7.x, download the Coveo plugin for Jive 6.2 to 7.x and jump to step 3.

  2. If not already done, download the Coveo plugin for Jive 9:

    1. In the Sources page, access the Add/Edit a Jive Server Source panel:

      • If you already have created a Jive source, double-click the source row or select the source row and then, in the Action bar, click Edit.

      • If not, click Add Source > Jive > Jive on-premises.

    2. In the Add/Edit a Jive Server Source panel, in the Configuration tab, click the Download Plugin button.

  3. In the Jive Administration Console menu, select System > Plugins > Add Plugin.

  4. In the Available Plugins page:

    jiveAvailablePlugins

    1. Under Install a new Plugin, click Choose File.

    2. Browse to the folder you downloaded the plugin, select the file, and then click Upload.

  5. Grant access to the Coveo plugin using the administrator credentials you want the Coveo source to retrieve the content with:

    • By default, for security reasons, no accounts can connect to the Coveo for Jive plugin.
    • You need these credentials when you configure the Jive Server source (see Add/Edit a Jive Server Source - Panel).
    1. In the Administration Console, select System > Management > System Properties.

    2. At the top of the System Properties page, in the Add new property box:

      jiveAddNewProperty

      1. In the Property Name box, enter coveo.services.allowed.username.
      2. In the Property Value box, enter the user name of the selected source credentials.
      3. Click Save Property.
  6. Stop and restart the Jive service (from the command prompt: /etc/init.d/jive-application restart).

Uninstall the Coveo Plugin

  1. Using an administrator account, with a browser, log into the Jive Administration Console (http://[MyJiveCommunity]/admin).

  2. In the Jive Administration Console menu, select System > Plugins > Installed Plugins.

  3. Locate coveo-for-jive in the plugins list and click the JiveXButton button.

  4. In the confirmation prompt that appears, click OK to delete the plugin.

    jivePluginsScreen

What’s Next?

Create a Jive Server source and enter the credentials of the Jive administrator account in the Authentication section (see Add/Edit a Jive Server Source - Panel).