Install the Coveo Plugin for Jive

This is for:

Developer System Administrator

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 aren’t available through the regular Jive 6+ APIs.

Note

You can’t 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

Important

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 in to the Jive Administration Console (http://[MyJiveCommunity]/admin):

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

      Jive Admin Version

    2. If you’re using a Jive version between 6 and 8, download the Coveo plugin for Jive 6 to 8 and jump to step 3.

  2. Download the Coveo plugin for Jive 9, if not already done:

    1. On the Sources (platform-ca | platform-eu | platform-au) page, access the Add/Edit a Jive Server Source panel:

      • If you already have created a Jive source, click the source, and then click Edit in the Action bar.

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

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

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

  4. On 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:

    Notes

    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 in to 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 Delete.

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

    Jive-Plugins-Screen

What’s Next?

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