Coveo for Sitecore v5 is now available!

Enabling the External Source in Sitecore

This page assumes that you have already indexed an external source in the Coveo Entreprise Search (CES) Administration Tool. For more information on how to do that, see Configuring an External Source.

After having indexed your external source in the CES Administration Tool, you need to enable it in Sitecore.

This page assumes that you have already indexed an external source in the Cloud Coveo Platform. For more information on how to do that, see Configuring an External Source.

After having indexed your external source in the Coveo Cloud Platform, you need to enable it in Sitecore.

To enable the source that you have just created

  1. Access your Coveo Search Page item.

  2. In the Publish tab, select the Experience Editor.

  3. Open the Coveo Search box by clicking on the page.
  4. Click on Edit Properties. It should be the first option.

  5. In the Control Properties panel, in Results scope, under Filter expression rules, add the rule or where syssource field is equal to <name of your source>.

    The Rule Set Editor is only available to Enterprise edition users. To learn how to add a filter expression rule programmatically, see Setting Up External Sources Programmatically.

  6. Scroll to External Content, and type in the name of your source.

  7. Click OK. The page should refresh, showing you results coming from Sitecore and your external source.

To enable the source that you have just created

  1. Open your search page in the Sitecore Experience Editor.

  2. Select the Searchbox Components placeholder. It is located immediately below the Coveo Searchbox component.

  3. Click Add here.
  4. Select the External Content component and click Select.

  5. Create or select a data source for your External Content component.

  6. In the floating toolbar, select Edit the rendering’s data source. It should be the leftmost option in the toolbar.
  7. In the External Content section, type the name of your external source.

  8. Click OK.

  9. If you have added a Query Filter component to your search page, select it. Otherwise, select the Coveo Search Interface component.
  10. In the floating toolbar of the selected component, select Edit the rendering’s data source. It should be the leftmost option in the toolbar.

  11. In the Query Filter section, under Filter expression rules, add the rule or where source field is equal to <name of your external source>.

    You can only capture items from external sources by adding this or rule to the default condition sent by the search interface. If you are filtering content on your tabs, you need to add a similar or rule on your tabs data source as well.

    The Rule Set Editor is only available to Enterprise edition users.

  12. Determine whether the source field name is currently translated (see Field Name Translation Default Behavior).
  13. If necessary, disable translation of the source field name (see Field Name Translation Default Behavior).

    If the source field name is translated, the field name source you specified in your filtering rule is also translated in the advanced query (aq) parameter of the search API call, as illustrated below.

    Having the field name you specified translated this way makes your or filtering rule ineffective.

  14. Refresh your search page in the Experience Editor. The page should now show results coming from Sitecore and your external source.

  15. Publish your search page.

Only if you are using the April 2016 release of Coveo for Sitecore (4.0.171), add the following pipeline in your Coveo.CloudPlatformClient.Custom.config file, in the sitecore node.

<pipelines>
   <getSearchUserIdentities>
   <!-- The AddAnonymousEmailUserIdentity allows to retrieve the public documents from the external sources. -->
      <processor name="AddAnonymousEmailUserIdentity" type="Coveo.CloudPlatformClient.Processors.GetSearchUserIdentities.AddAnonymousEmailUserIdentity, Coveo.CloudPlatformClient" />
   </getSearchUserIdentities>
</pipelines>

Filtering on External Collection Instead of Source

If you have multiple external sources in the same collection, you may want to filter them directly on the external collection instead. Filtering on the external collection shows all the documents in the sources contained in the collection.

Instead of specifying an external source name, you can choose to filter by collection in the Coveo Search component properties.

What’s Next?

Now that your content is searchable in your Sitecore instance, you may want to proceed to Using External Content in Sitecore Facets.

People also viewed