Product DocsMenu

Coveo Platform 7.0 >
Administrator Help > Connectors > Jive Connector > Configuring and Indexing a Jive Source

Configuring and Indexing a Jive Source

A source defines a set of configuration parameters for a specific Jive 6+ server.

Note: In an environment with more than one Jive 6+ server, you need to define one source for each Jive server that you want to index.

To configure and index a Jive 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 Collection).

  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

      Select the connector used by this source. In this case, select Jive.

      Notes:

      • You should not confuse the Jive source with the Jive 5 / SBS / Clearspace source that must be used with Jive versions older than Jive 6.0.

      • When you do not see Jive, your environment does not meet the requirements (see Jive Connector Requirements).

      Addresses

      Enter the root address of the Jive server that you want to index.

      Example: http://acme.community.com/

      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

      CES 7.0.8541+ (September 2016) Select the field set that you created earlier (see Jive Connector Deployment Overview).

      Note: CES 7.0.8388– (June 2016) 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. When you use phrase substitutions in your Jive community (see the Jive document Substituting Phrases in the UI), you must set the following parameters. Otherwise, leave them blank.

      Locale used for phrase substitutions

      Enter the phrase substitution locale that the connector should use. The default locale is default, meaning that the actual machine locale is used.

      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)

      Theme used for phrase substitutions

      Enter the phrase substitution theme that the connector should use. The default theme is custom.

      A metadata called csPhraseSubstitution will be available for use in the mapping file.

    2. In the Metadata Mapping File box, enter the path to the mapping file that should apply to the items in this source (see Creating and Using a Jive Mapping File).

      When you remove the default mapping file ([CES_Path]\Bin\Coveo.CES.CustomCrawler.Jive.Mappings.xml and leave this box empty, the connector maps no metadata to CES fields.

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

      Notes:

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

      • (Jive 6 only) Retrieving unpublished content requires Jive 6 API 3.3+ on the Jive server. When the Jive API does not support retrieving unpublished content, you get the following message in the CES Console:

        Retrieving unpublished content requires at least the version 3.3 of the Jive REST API to be installed on the Jive server.Please update your version (n.n) if you want to use this feature or check the 'OnlyIndexPublishedContent' option.

      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). Not selected by default.

      Notes:

      • CES 7.0.8541– (September 2016) The option is selected by default.

      • Permission changes in Jive for User content type cannot be updated in the index with incremental refresh like for other types of Jive content. When you want to index User content, keep permissions as up-to-date as possible in the index, and optimize the load to your Jive server, it is recommended to create a separate source for User content using parameters suggested in the following table.

        Source Options Main source Users content source
        Index Communities content Yes No
        Index Projects content Yes No
        Index Social Groups content Yes No
        Index System Blogs content Yes No
        Index Users content No Yes
        Refresh Schedule Incremental (Every 5 minutes)
        Full Refresh (Every Sunday)
        Full Refresh (Every day)

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

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

      Index Subfolders

      This parameter is not taken into account for this connector.

      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, perform the following actions if the plugin was installed.

    1. In the Security Provider drop-down list, when you chose to index Jive permissions, select the security provider that you created for this source (see Configuring a Jive Security Provider).

      Note: CES 7.0.8225+ (March 2016) When you want to only index public Jive content, select None.

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

      Note: CES 7.0.8225+ (March 2016) When you want to only index public Jive content, select None.

    3. Click Save to save the source configuration.

  8. When you chose to not index Jive permissions, you can set source level permissions that apply to all documents in the source:

    1. In the navigation panel on the left, click Permissions.

    2. In the Permissions page, select Specify the security permissions to index.

    3. In the Allowed Users and Denied Users boxes, enter the users and groups that you respectively want to allow or deny to see search results from this source. The default is to allow everyone (Active Directory Group).

    4. Click Apply Changes.

  9. When you are ready to start indexing the Jive 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).

What's Next?

People who viewed this topic also viewed