Changing the Name of Sources Created in the Coveo Index

The first time you rebuild your indexes in Sitecore, Coveo for Sitecore creates a source corresponding to each index in the Coveo Cloud Platform. These sources are named after a combination of your Sitecore index name and the Farm name value you specified in the activation step (e.g., Coveo_master_index - ProductionFarm and Coveo_web_index - ProductionFarm). If you have not specified a Farm name value, the Sitecore host and instance name are used instead.

Typically, you may want to change the names of your sources to make them shorter and easier to remember whenever you need them to manually perform a query.

Instead of setting individual source names, you can set a name for the entire farm (see Assigning a Farm Name to Coveo for Sitecore Resources).

Changing the Source Name

The current procedure shows you how to modify the name of the source corresponding to the Sitecore master index.

  1. Open the Coveo.SearchProvider.Custom.config file using a text editor.
  2. Create the element for the master index configuration. It should look like this:

    <configuration xmlns:patch="http://www.sitecore.net/xmlconfig/">
      <sitecore>
        <contentSearch>
          <configuration>
            <indexes>
              <index id="Coveo_master_index">
              </index>
            </indexes>
          </configuration>
        </contentSearch>
      </sitecore>
    </configuration>
    
  3. In the index node, add an element named sourceName that encloses the desired source name in Coveo. For example, you could name your source Test. Your index configuration should now look like this:

    <configuration xmlns:patch="http://www.sitecore.net/xmlconfig/">
      <sitecore>
        <contentSearch>
          <configuration>
            <indexes>
              <index id="Coveo_master_index">
                <sourceName>Test</sourceName>
              </index>
            </indexes>
          </configuration>
        </contentSearch>
      </sitecore>
    </configuration>
    

    The sourceName element is case-sensitive. Make sure that the value you enter exactly matches the casing of the corresponding source in the Coveo Platform. Typically, a source name should look like this: Coveo_web_index - WKS-000236-Sitecore72u2.

  4. Save the file and re-index your items (see Coveo for Sitecore Indexing Guide).

  5. You can validate that the new source has been created in the Coveo Cloud Administration Console:

The first re-indexing may take longer, as a new source needs to be created. The old sources aren’t deleted.

Recommended Articles