Configuring and Indexing a Jive 5/SBS/Clearspace Source

Deprecated

A source defines a set of configuration parameters for a specific Jive 5/SBS/Clearspace server.

Note: In an environment with more than one Jive 5/SBS/Clearspace server, you need to define one source for each Jive 5/SBS/Clearspace server that you want to index.

To configure and index a Jive 5/SBS/Clearspace source

1. On the Coveo server, access the Administration Tool (see Opening the Administration Tool).

2. Select Index > Sources and Collections.

3. In the Collections section:

   1. Select an existing collection in which you want to add the new source.

      OR

   2. Click Add to create a new collection (see Adding a User Identity).

4. In the Sources section, click Add.

   The Add Source page that appears is organized in three sections.

5. In the General Settings section of the Add Source page:

   

   1. Enter the appropriate value for the following required parameters:

      Name

      Enter a descriptive name of your choice for the connector source.

      Example: Corporate Jive

      Source Type

      CES 7.0.7814+ (August 2015) Select the connector used by this source. In this case, select Jive 5 / SBS / Clearspace (deprecated).

      Notes:

      • CES 7.0.7711– (June 2015) Select Jive 5 / SBS / Clearspace.

      • If you do not see Jive 5 / SBS / Clearspace (deprecated), your environment does not meet the requirements (see Jive 5/SBS/Clearspace Connector Requirements).

      Addresses

      Enter the root address of the Jive community from which to start indexing in the form:

      http://[JiveserverName]:[port]/

      where you replace [JiveserverName]:[port] by the host name and port of your Jive community. The default port is 8080. The port is optional when equal to 80.

      Example: To index:

      • All communities: http://JiveSite:8080/

      • Community A: http://JiveSite:8080/ CommunityA

      • Community C: http://JiveSite:8080/CommunityA/CommunityB/CommunityC

      Refresh Schedule

      Select the time interval at which the source is automatically refreshed to keep the index content up-to-date. The recommended Every day option instructs CES to refresh the source everyday at 12 AM.

      Note: You can create new or modify existing source refresh schedules (see Creating or Modifying a Source Schedule).

   2. Review the value for the following parameters that often do not need to be modified:

      Rating

      Change this value only when you want to globally change the rating associated with all items in this source relative to the rating to other sources (see Understanding Search Results Ranking).

      Example: When a source replaces a legacy system, you may want to set this parameter to High, so that in the search interface, results from this source appear earlier in the list compared to those from legacy system sources.

      Document Types

      If you defined a custom document type set for this source, select it (see What Are Document Type Sets?).

      Active Languages

      If you defined custom active language sets, ensure to select the most appropriate for this source (see Adding and Configuring a Language Set).

      Fields

      If you defined custom field sets, ensure to select the most appropriate for this source (see What Are Field Sets?).

6. In the Specific Connector Parameters & Options section of the Add Source page:

   

   1. The following parameters generally do not need to be changed:

      Number of Refresh Threads

      Enter the number of simultaneous downloads handled by the connector. The default value is 2.

      Theme used for phrase substitutions

      When you use phrase substitutions in your Jive community (see the Jive document Substituting Phrases in the UI), enter the phrase substitution theme that the connector should use, and then select the Use Phrase Substitutions check box. The default theme is custom. This parameter is available with CES 7.0.4855+.

      Locale used for phrase substitution

      When you use phrase substitutions in your Jive community (see the Jive document Substituting Phrases in the UI), enter the phrase substitution locale that the connector should use, and then select the Use Phrase Substitutions check box. The default locale is default, meaning that the actual machine locale is used. This parameter is available with CES 7.0.4855+.

      Enter the locale in any of the following three formats:

      • language only (ex: en")

      • Language and country (ex: en_US)

      • Language, country, and variant (ex: en_US_NY)

   2. Select the type of Jive content to index using the following options:

      Only retrieve published items

      Select to only index 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) are not indexed. This parameter is available with CES 7.0.4855+.

      Note: Incremental refresh catches Jive item status changes and respects the configuration of this parameter.

      Use phrase substitutions

      Select to index phrase substitutions. The substituted value is saved in the csPhraseSubstitution field for each document. This parameter is available with CES 7.0.4855+.

      Note: The default phrase substitution feature is designed for an English user interface. When your Jive community includes user interfaces in other languages with phrase substitutions for localized names, the connector cannot directly index these substitutions.

      Example: When you are using a French interface, Space is called Espace. If you add a phrase substitution for Espace", the connector searches for Space and does not find it.

      You can use advanced source parameters to provide a pattern to search for the specific item type (see PhraseSubstitutionsAnnouncementPattern (String)).

      Index Communities content

      Select to index the Jive communities and any item they contain. Selected by default.

      Index Projects content

      Select to index the Jive projects and any item they contain. Selected by default.

      Index Social Groups content

      Select to index the Jive social groups and any item they contain. Selected by default.

      Index System Blogs content

      Select to index the Jive system blogs and any item they contain. Selected by default.

      Index User content

      Select to index the user profiles, personal blogs, and private items (messages, documents and discussions). Selected by default.

   3. Click Add Parameter when you want to show and change the value of advanced source parameters (see Modifying Hidden Jive 5/SBS/Clearspace Source Parameters).

   4. The Option check boxes generally do not need to be changed:

      Index Subfolders

      Keep this check box selected (recommended). By doing so, to recursively index all communities found under the community specified in Addresses.

      Index the document's metadata

      When selected, CES indexes all the document metadata, even metadata that are not associated with a field. The orphan metadata are added to the body of the document so that they can be searched using free text queries. 

      When cleared (default), only the values of system and custom fields that have the Free Text Queries attribute selected will be searchable without using a field query (see Adding a Field to Search On and What Are Field Queries and Free Text Queries?).

      Example: A document has two metadata:

      • LastEditedBy containing the value Hector Smith

      • Department containing the value RH

      In CES, the custom field CorpDepartment is bound to the metadata Department and its Free Text Queries attribute is selected.

      When the Index the document's metadata option is cleared, searching for RH returns the document because a field is indexing this value. Searching for hector does not return the document because no field is indexing this value.

      When the Index the document's metadata option is selected, searching for hector also returns the document because CES indexed orphan metadata.

      Document's addresses are case-sensitive

      Leave the check box cleared. This parameter needs to be checked only in rare cases for systems in which distinct documents may have the same name but different casing.

      Generate a cached HTML version of indexed documents

      When you select this check box (recommended), at indexing time, CES creates HTML versions of indexed documents. In the search interfaces, users can then more rapidly review the content by clicking the Quick View link rather than opening the original document with the original application. Consider clearing this check box only when you do not want to use Quick View links or to save resources when building the source.

      Open results with cached version

      Leave this check box cleared (recommended) so that in the search interfaces, the main search result link opens the original document with the original application. Consider selecting this check box only when you do not want users to be able to open the original document but only see the HTML version of the document as a Quick View. In this case, you must also select Generate a cached HTML version of indexed documents.

7. In the Security section of the Add Source page:

   

   1. In the Security Provider drop-down list, select the security provider that you created for this source (see Configuring a Jive 5/SBS/Clearspace Security Provider).

   2. In the Authentication drop-down list, select the user identity that you created for the Jive community.

   3. Click Save to save the source configuration.

8. In the navigation panel on the left, click General. In the General page:

   1. Modify the Title Selection Sequence so that Use the filename is the first option from the list.

   2. Click Apply Changes.

9. When you are ready to start indexing the Jive 5/SBS/Clearspace source, click Rebuild.

10. Validate that the source building process is executed without errors:

    • In the navigation panel on the left, click Status, and then validate that the indexing proceeds without errors.

      OR

    • Open the CES Console to monitor the source building activities (see Using the CES Console).