Assigning a Farm Name to Coveo for Sitecore Resources
When rebuilding your Sitecore indexes, Coveo for Sitecore creates or updates a set of resources such as sources and security identities in Coveo. These resources are named after a combination of your Sitecore index, host, and instance names.
You have a Sitecore instance named
SitecoreInstance running on host
WKS-000236. When you build the master index for the first time, Coveo for Sitecore creates a source named
Coveo_master_index - WKS-000236-SitecoreInstance in the Coveo index.
The combination of these resources across your Sitecore environment is called a Farm.
Typically, you may want to assign a name for your Farm to unify all Coveo resources under a single label. It’s also a mandatory step when scaling your Coveo for Sitecore environment (see Prepare the Sitecore Content Manager for a Scaled Environment).
For July 2016 and later releases (4.0.290+), follow these steps:
- In the Sitecore Control Panel, under Coveo Search, select Configuration.
- Under Farm Name, click on Configure.
- In Farm Name, enter your desired Farm Name, such as
- Click Next. A window will appear to confirm that your farm name has been set.
- Rebuild your search indexes (see Coveo for Sitecore Indexing Guide).
For releases prior to the July 2016 release (4.0.222 and older), follow these steps:
- Open your
defaultIndexConfiguration, add a node called
Set the name of your farm name in plain text in the node.
<defaultIndexConfiguration> ... <farmName>Production Farm Name</farmName> </defaultIndexConfiguration>
Save and close the file. Your farm name is now set.
farmNameelement is case-sensitive. Ensure that the value you enter exactly matches the casing of the corresponding source in the Coveo Platform.
- Rebuild Your Search Indexes.