Configuring and Indexing a Yammer Source

A source defines a set of configuration parameters for a specific Yammer network.

To configure and index a Yammer 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 into three sections.

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

   

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

      Name

      A descriptive name of your choice for the connector source.

      Example: Yammer Enterprise

      Source Type

      The connector used by this source. In this case, select Yammer.

      Note: If you do not see Yammer in the Source Type list, ensure that your environment meets the requirements (see Yammer Connector Requirements).

      Addresses

      The URL of your Yammer network.

      Example: https://www.yammer.com/[companyDomain]

   2. The following parameters often 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 the source indexes a legacy repository, you may want to set this parameter to Low, so that in the search interface, results from this source appear lower in the list compared to those from active repository 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 created a custom Yammer field set for this source, select it. Otherwise, leave the Default Scheme (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 (see Creating or Modifying a Source Schedule) . Because the incremental refresh takes care of maintaining the source up-to-date, you can select a longer interval such as Every Sunday (see What Should Be the Frequency of Source Refresh Schedules?).

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

   

   1. In the Mapping File box, optionally enter the path to a mapping file that should apply to the items in this source.

      Leave this box empty to use the default mappings that should be appropriate in most cases.

      CES 7.0.8225+ (March 2016) When the default mappings do not fulfill your needs, you can use the Coveo.CES.CustomCrawlers.Yammer.MappingFile.xml file (located in the Coveo Enterprise Search 7 Bin folder) as a starting point or contact Coveo Support for assistance. Your XML mapping file must respect the standard Coveo mapping file schema (see Standard Mapping File Schema).

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

      Index Subfolders

      Keep this check box selected (recommended). By doing so, all subfolders from the specified server address are indexed.

      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 Authentication drop-down list, select the Yammer crawling user identity that you created for this source (see Yammer Connector Deployment Overview).

   2. In the Security Provider drop-down list, select the Yammer security provider that you created for this source (see Configuring a Yammer Security Provider).

   3. Click Save and Start to save the source configuration and build the source.

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