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

  • 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 Server 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 Key Characteristics

Features Supported Additional information
Jive version 9

Only the minor versions currently maintained by Jive are supported. The latest version to have been tested with Coveo is 9.0.

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 operations Refresh

Takes place every hour by default. Due to Jive REST API limitations, rescan or rebuild is required to retrieve:

  • 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

Before you start, ensure that your Jive instance meets the source requirements.

When adding a source, in the Add a source of content panel, click the On-Premises or the Crawling Module tab, depending on whether you need to use the Coveo On-Premises Crawling Module to retrieve your content. See Content Retrieval Methods for details.

To edit a source, on the Sources page, click the desired source, and then, in the Action bar, click Edit.

“Configuration” Tab

In the Add/Edit a Jive Server Source panel, the Configuration tab is selected by default. It contains your source’s general and authentication information, as well as other parameters.

General Information

Content Update and Security Requirement

Download and install the Coveo Jive plugin if you intend to select the Determined by source permissions content security option.

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

Source Name

Enter a name for your source.

A source name can’t be modified once it’s saved, therefore be sure to use a short and descriptive name, using letters, numbers, hyphens (-), and underscores (_). Avoid spaces and other special characters.

Instance URL

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

Starting Community

Optionally, enter the URL of a Jive Community where the crawling should begin. Coveo indexes the content of the communities (also known as spaces) under the starting community.

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

Content outside the starting community can be indexed thanks to the options in the Content to include section.

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 paired with your source, a successful rebuild is required for your change to apply.

Character Optical Recognition (OCR)

If you want Coveo Cloud to extract text from image files or PDF files containing images, check the appropriate box. OCR-extracted text is processed as item data, meaning that it’s fully searchable and will appear in the item Quick View. See Enable Optical Character Recognition for details on this feature.

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 Manage Privileges and Logical Indexes Domain).

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

Allow Anonymous Access

Check this box to map the Everyone group in Jive to the Everyone group of the Email security identity provider.

When you check this box, all items accessible to the Everyone group in Jive become public. In other words, any user (authenticated or anonymous) of your search interface can find these items in their search results.

“Authentication” Section

Enter the credentials of a Jive account with Full Access permissions to the Jive instance. See Source Credentials Leading Practices.

“Content to Include” Section

This section allows you to specify whether you want to index some additional types of content. Communities (also known as spaces), projects, social groups (also known as groups), and system blogs are indexed by default.

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

People

Check the People box to index user profiles, personal blogs, and private items (items and discussions). Private messages (also known as direct messages) aren’t included.

Since it’s not possible to apply permissions to people items, we strongly recommend that you DON’T check the People box. Your Jive user profiles probably contain private information, and checking this box would make this data available to all search interface users.

Moreover, enabling this parameter significantly increases the crawling time. If you need to index people content, you should create a separate Jive Server source specifically to index this content.

Published Items Only

Check this box if you want to index only the items whose status is Published.

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

Active Directory Permissions

This option is available with Crawling Module sources only. If you’re creating or editing an source of type On-Premises, skip to “Content Security” tab.

When you check this box and provide the required Active Directory information in the fields that appear, Active Directory permissions are indexed and replicated in your search interface.

For this option to be enforced, you must also select the Determined by source permissions option in the Content Security tab.

Active Directory Username and Active Directory Password

Enter credentials to grant Coveo Cloud access to your Active Directory.

Expand Well-Known SIDs

Check this box if you want the users included in your Active Directory well-known security identifiers to be granted access to the indexed content. Expect an increase in the duration of the security identity provider refresh operation. Supported well-known SIDs are: Everyone, Authenticated Users, Domain Admins, Domain Users, and Anonymous Users.

If your entire content is secured with the Everyone or Authenticated users well-known, it’s more cost-effective resource-wise to index it with a source whose content is accessible to everyone than to expand the well-known with a source that indexes permissions.

Enable TLS

Check this box to use a TLS protocol to retrieve your security identities. If you do, we strongly recommend selecting StartTLS if you can. Since LDAPS is a much older protocol, you should only select this value if StartTLS is incompatible with your environment.

Email Attributes

By default, Coveo Cloud retrieves the email address associated to each security identity from the mail attribute. Optionally, you can specify additional or different attributes to check. Should an attribute contain more than one value, Coveo Cloud uses the first one.

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

“Access” Tab

In the Access tab, determine whether each group and API key can view or edit the source configuration (see 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.

Completion

  1. Finish adding or editing your source:

    • 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, click Add Source/Save.

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

      OR

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

      Back on the Sources page, you can review the progress of your source addition or modification.

    Once the source is built or rebuilt, you can review its content in the Content Browser.

  2. Optionally, consider editing or adding mappings.

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

What’s Next?

Recommended Articles