Add or Edit a Jive Server Source
Add or Edit a Jive Server Source
When you have the required privileges, you can add the content of a Jive community to a Coveo organization.
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||
|Content update operations||Refresh||
Takes place every hour by default. A rescan or rebuild is required to retrieve:
The Coveo plugin is required to:
|Content security options||Determined by source permissions||
Requires the Coveo plugin.
Before configuring your source, you must ensure that your Jive instance is ready to work with Coveo.
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.
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
When the access to communication ports between Coveo and the Jive server is restricted, the appropriate port(s) must be opened in the network infrastructure such as in firewalls to allow Coveo to access the content.
At least the following ports must be opened:
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.
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.
Content Update and Security Requirement
If you use Jive 6, 7, or 8 download this plugin instead.
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 (
Enter the web address of the Jive instance that you want to index.
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 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.
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.
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).
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
A source refresh catches Jive item status changes and respects the configuration of this parameter.
Active Directory Permissions
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.
Active Directory Username and Active Directory Password
Enter credentials to grant Coveo access to your Active Directory.
Expand Well-Known SIDs
Select this option if you want the users that are 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:
Domain Users, and
Select this option 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.
By default, Coveo retrieves the email address associated to each security identity from the
"Content Security" Tab
When using the Everyone content security option, see Safely Apply Content Filtering for information on how to ensure that your source content is safely filtered and only accessible by intended users.
In the Access tab, set whether each group and API key can view or edit the source configuration (see Resource Access):
If available, in the left pane, click Groups or API Keys to select the appropriate list.
In the Access Level column for groups or API keys with access to source content, select View or Edit.
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.
When you’re done editing the source and want to make changes effective, click Add and Build Source/Save and Rebuild Source.
Once the source is built or rebuilt, you can review its content in the Content Browser.
The best way to ensure that your indexed content is seen only by the intended users is to enforce content security by selecting either the Source creator or Determined by source permissions option when available.
However, if you need to configure your source so that the indexed source content is accessible to Everyone, you should adhere to the following leading practices to ensure that your source content is safely filtered and only accessible by the appropriate users:
Configure query filters: Apply filter rules on a query pipeline to filter the source content that appears in search results when a query goes through that pipeline.
Use condition-based query pipeline routing: Apply a condition on a query pipeline to make sure that every query originating from a specific search hub is routed to the right query pipeline.
Following the above leading practices results in a workflow whereby the user query is authenticated server side via a search token that enforces the search hub from which the query originates, which can’t be modified by users or client-side code. The query then passes through a specific query pipeline based on a search hub condition, and the query results are filtered using the pipeline filter rules.
Configure Query Filters
Filter rules allow you to enter hidden query expressions to be added to all queries going through a given query pipeline.
They’re typically used to add a field-based expression to the constant query expression (
You apply the
@objectType=="Solution" query filter to the pipeline to which the traffic of your public support portal is directed.
As a result, the
@objectType=="Solution" query expression is added to any query sent via this support portal.
Therefore, if a user types
Speedbit watch wristband in the searchbox, the items returned are those that match these keywords and whose
objectType has the
Items matching these keywords but having a different
objectType value aren’t returned in the user’s search results.
To learn how to configure query pipeline filter rules, see Manage Filter Rules.
You can also enforce a filter expression directly in the search token.
Use Condition-Based Query Pipeline Routing
The most recommended and flexible query pipeline routing mechanism is condition-based routing.
When using this routing mechanism, you ensure that search requests are routed to a specific query pipeline according to the search interface from which they originate, and the authentication is done server-side.
To accomplish this:
Apply a condition to a query pipeline based on a search hub value, such as Search Hub is Community Search or Search Hub is Agent Panel. This condition ensures that all queries that originate from a specific search hub go through that query pipeline.
Authenticate user queries via a search token that’s generated server side and that contains the search hub parameter that you specified in the query pipeline.
Configure the Search Token
When using query filters to secure content, the safest way to enforce content security is to authenticate user queries using a search token that’s generated server side. For instance, when using this approach, you can enforce a search hub value in the search token. This makes every authenticated request that originates from a component use the specified search hub, and therefore be routed to the proper query pipeline. Because this configuration is stored server side and encrypted in the search token, it can’t be modified by users or client-side code.
Implementing search token authentication requires you to add server-side logic to your web site or application. Therefore, the actual implementation details will vary from one project to another.
The following procedure provides general guidelines:
If you’re using the Coveo In-Product Experience (IPX) feature, see Implementing Advanced Search Token Authentication.
You can specify other parameters in the search token, such as a query
For more information and examples, see Search Token Authentication.
If you encounter issues, modifying the default values of hidden source parameters may help resolve them.
If you’re using the Crawling Module to retrieve your content, consider subscribing to deactivation notifications to receive an alert when a Crawling Module component becomes obsolete and stops the content crawling process.