Add or Edit a Jive Server Source

Members of the Administrators and Content Managers built-in groups can add the content of a Jive community to a Coveo Cloud organization. In a Coveo-powered search interface, the source content is accessible to either everyone, the source creator only, or specific users as determined by source permissions (see Content Security).

By default, a Jive Server source starts a refresh every hour to index Jive Server file changes (additions, modifications, or deletions).

  • While most of the parameters can be configured through the Add/Edit a Jive Server Source panel, other parameters, such as rarely used parameters or new parameters that aren’t yet editable through the user interface, can only be changed or added in the JSON configuration (see Edit a Source JSON Configuration, Add a Hidden Source Parameter, and Jive Source JSON Modification).

    If you have issues with file download requests timing out too early for larger files, you may want to add a RequestTimeout hidden parameter in the parameters section of the source JSON configuration.

  • Source refresh limitations that require you to configure source rescans or rebuilds (see Edit a Source Schedule):

    • Due to a Jive REST API limitation, only changes to the first level of comments on items and replies on discussions are captured by a refresh, meaning that comments on comments and replies on replies can’t currently be retrieved.

    • Since the Jive REST API doesn’t provide the list of deleted File items, a refresh doesn’t take the deletion of File items into account.

Source Features Summary

Features Supported Additional information
Jive version 9
Searchable content types
  • Communities (also known as Spaces), social groups (also known as groups), projects, people and their profile, direct messages (requires Coveo plugin), items (private and public), discussions (private and public), blog posts (for spaces, projects, users, groups and system blogs), announcements, polls, comments (for items, blog posts, and polls), attachments (for items, blog posts, and discussions), ideas (private and public), and videos (private and public).

  • Support phrase substitutions (requires Coveo plugin), tags, and categories.

Content update Refresh

Rescan or rebuild needed to retrieve (due to Jive REST API limitations):

  • Comments on comments and replies on replies

  • Deleted file items.

The Coveo plugin is required to:

  • Remove recently deleted Jive items

  • Properly refresh discussions

Rescan
Rebuild
Content security options Determined by source permissions

Requires the Coveo plugin.

Source creator
Everyone

Requirements

Before configuring your source, you must ensure that your Jive instance is ready to work with Coveo Cloud.

Supported Jive Version

The source supports Jive 9.

Coveo has dropped support for sources indexing Jive 6, 7, or 8 content, but these sources are typically still operational (see Support for Older System Versions).

Jive Administrator Account

When you want to include Jive permissions, you must create a specific Jive administrator account with Full Access permissions that’s only used for the source.

Jive Server Accessible to Coveo Cloud

When the access to communication ports between Coveo Cloud and the Jive 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.

At least, the following ports must be opened:

  • 443: standard port for secured internet connections (HTTPS)

  • 8080: Jive default port

Add or Edit a Jive Server Source

  1. Ensure that your Jive server meets the source requirements (see Requirements).

  2. If not already in the Add/Edit a Jive Server Source panel, access the panel:

    • To add a source, in the main menu, under Content, select Sources > Add Source button > Jive > Jive Server.

      OR

    • To edit a source, in the main menu, under Content, select Sources > source row > Edit in the Action bar.

  3. In the Configuration tab:

    1. Under Supported Versions, check if your version of Jive is supported.

    2. Under Content Update and Security Requirement:

      1. Download the Coveo plugin for Jive by clicking Download Plugin, and then install the plugin on your Jive server.

        If you use Jive 6 or 7, download this plugin instead (see Support for Older System Versions).

      2. Enter appropriate values for the available parameters:

        • Source name

          A descriptive name for your source under 255 characters (not already in use for another source in this organization).

          Jive-Community

        • Character optical recognition (OCR)

          Check this box if you want Coveo Cloud to extract text from image files or PDF files containing images (see Enable Optical Character Recognition). OCR-extracted text is processed as item data, meaning that it’s fully searchable and will appear in the item Quick View (see Search Result Quick View).

          Since the OCR feature is available at an extra charge, you must first contact Coveo Sales to add this feature to your organization license. You can then enable it for your source.

        • Instance URL

          The web address of the Jive instance that you want to index.

          https://<jiveServer>

        • Starting community

          (Optional) The URL of a Jive Community where the crawling begins.

          • Only communities (also known as spaces) under the starting community are indexed.

          • By default, the root community (also known as root space) is used.

          • Content outside the starting community can be indexed if you select the following options in the Content to include section (see Content to include section):

            • Include projects

            • Include social groups (also known as groups)

            • Include system blogs

            • Include people

        • Paired Crawling Module

          If your source is a Crawling Module source and if you have more than one Crawling Module linked to this organization, select the one with which you want to pair your source. If you change the Crawling Module instance with which your source is paired, a successful rebuild is required for your change to apply.

        • Index

          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.

          • To add a source storing content in an index different than default, you need the View access level on the Logical Index domain (see Privilege Management and Logical Indexes Domain).

          • Once the source is added, you can’t switch to a different index.

        • Allow anonymous access

          Select to map the Everyone group in Jive to the Everyone group of the Email identity security provider.

          When selected, all users (authenticated and anonymous) can see the Jive content allowed to Jive Everyone in search results.

  4. In the Authentication section, provide authentication information:

    • Username

      Enter the Jive account with Full Access permissions to the Jive instance.

    • Password

      Type in the corresponding password.

  5. In the Content to Include section, consider changing the default value of the settings in this section when you want to fine-tune how your Jive instance is crawled.

    By default, all Jive content is indexed, regardless of its status (except private users content under the Jive Community domain).

    • Turn off one or more of the following settings when you want to prevent specific Jive places from being included in the index:

      • Communities (also known as spaces)

      • Projects

      • Social groups (also known as groups)

      • System blogs

    • Optionally turn on the following option:

      • People

        Includes user profiles, personal blogs, and private items (items and discussions). Private messages (also known as direct messages) aren’t included.

        Since Coveo can’t index content permissions, we strongly recommend that you do NOT to enable the Include people setting. Private information could then be disclosed, even if private messages aren’t indexed. Also, turning on this setting significantly increases the crawling time. If you need to index people content, you should create a separate source and only turn on the Include people setting.

      • Published items only

        Includes Jive items for which the status is Published. Items with other statuses (such as Draft, Scheduled, Awaiting Moderation, Rejected, Abuse Hidden, Abuse Visible, Archived, Expired, Pending Approval, Deleted, Processing, Error, Unknown) aren’t included.

        Source refresh catches Jive item status changes and respects the configuration of this parameter.

  6. In the 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.

    If you’re creating a Crawling Module source and want to select the Determined by source permissions option, contact the Coveo Support team.

  7. In the Access tab, determine whether each group and API key can view or edit the source configuration (see Understanding Resource Access):

    1. In the Access Level column, select View or Edit for each available group.

    2. 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’re a member, you won’t 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.

  8. Optionally, consider editing or adding mappings (see Adding and Managing Source Mappings).

    You can only manage mapping rules once you build the source (see Refresh, Rescan, or Rebuild Sources).

  9. 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.

      On the Sources page, you must click Start initial build or Start required rebuild in the source Status column to add the source content or make your changes effective, respectively.

      OR

    • Click Add and Build Source/Save and Rebuild Source when you’re done editing the source and want to make changes effective.

      Back on the Sources page, you can review the progress of your Jive source addition or modification (see Adding and Managing Sources).

    Once the source is built or rebuilt, you can review its content in the Content Browser (see Inspect Items With the Content Browser).

</div>

</div>

</div>

What’s Next?

Recommended Articles