Product DocsMenu

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

Configuring and Indexing a Jive Source

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

Note: In an environment with more than one Jive server, you need to define one source for each Jive server that you wish 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 wish 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.

  5. In the Add Source page:

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

      Rating
      Change this value only when you want to globally change the rating associated with all items in this source relative to the rating of other sources (see Understanding Search Results Ranking).
      Example: When this source is for a legacy system, you may want to set this parameter to Low, 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.
      Fields
      If you defined custom field sets, ensure to select the most appropriate for this source (see What Are Field Sets?).
      Refresh Schedule
      Time interval at which the index is automatically refreshed to keep the index content up-to-date. By default, the Every day option instructs CES to refresh the source everyday at 12 AM.
      Note: Live indexing does not catch changes to security and file attachment elements. Only a refresh does.
      Number of Refresh Threads
      Determines 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 6.5.4856+.

      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 6.5.4856+.

      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. Enter the appropriate value for the following required parameters:

      Name
      A descriptive name of your choice for the connector source.
      Example: Corporate Jive
      Source Type
      The connector used by this source. In this case, select Jive.
      Note: If you do not see Jive in the Source Type list, ensure that your environment meets the requirements (see Jive Connector Requirements).
      Addresses

      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 portal. The default port is 8080. The port is optional when equal to 80.

      Examples:

      All communities: http://JiveSite:8080/

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

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

    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. This parameter is available with CES 6.5.4856+.

      Note: Live indexing 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 6.5.4856+.

      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.

    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
      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. This option is cleared by default.
      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.
    6. In the Authentication drop-down list, select the user identity that you previously created for this source.

    7. Click Save to save the source configuration.

  6. In the navigation panel on the left, click General.

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

  8. In the navigation panel on the left, select Permissions.

  9. In the Permissions page:

    1. In the Permissions options, select Use a Security Provider.

    2. In the Security Provider drop-down list, select the security provider that you created for this source.

      Note: When you want to manually specify the permissions that will be set on documents from the source, you must select the Specify the security permissions to index option, and then enter allowed and denied users and groups for the source.

    3. Click Apply Changes.

  10. When you are ready to start indexing the Jive source, click Rebuild.

  11. 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?

When your Jive server uses CA SiteMinder for user authentication, add parameters to the connector (see Adding CA SiteMinder Parameters to the Jive Connector).