Product DocsMenu

Copying a Search Interface Configuration to Another Coveo Server

You can use the Deployment page of the Interface Editor to transfer search interface configurations between Coveo instances, that is from one Coveo Master server to another.

Note: The Interface Editor configuration is stored on the Master server and is automatically applied to all Front-End servers and deployed to all Mirror servers within a Coveo instance. You therefore do not need to use the Deployment page within a Coveo instance.

The Deployment page allows you to export the configuration by downloading an XML configuration file for the current search interface. You must then transfer the file manually to the Master server of another Coveo instance. In this other Coveo instance, you again use the Deployment page to import the configuration by uploading the XML configuration file.

Example: This procedure is useful to easily replicate a search interface configuration between the Coveo instances of your development, quality assurance, and production environments.

Tip: You can also use the Deployment page to create backup files for the configuration of each of your search interfaces (see Backing up the Configuration of a Search Interface).

The XML configuration file contains the values for all the parameters that you can change from the Interface Editor. This means that all Interface Editor parameters are overwritten when you upload the file. When other CES configuration parameters such as those set in the Administration Tool are different in both Coveo instances, you may need to adjust some parameters in the target instance after the upload.

Example: You copy a search interface configuration from the Coveo instance in your quality assurance environment to that of your production environment, but the collection names are not the same in both environments. After uploading the XML configuration file in the production environment, you must set the scope to include the collection from this environment.

To copy a search interface configuration to another Coveo Master server

  1. On the source Coveo Master server, access the Interface Editor (see Opening the Interface Editor).

  2. Click the Search Interfaces tab.

  3. In the Current Interface drop-down list, select the search interface for which you want to export the configuration file.

  4. On the menu, select Advanced.

  5. In the navigation panel on the left, select Deployment.

  6. Under Deploy this interface to another Coveo Enterprise Search server:

    1. Under Download the search interface xml, click Download.

      CES creates and initiates the download of an XML file containing the configuration for the current search interface.

    2. Save the downloaded file to a location of your choice on this server.

  7. Manually copy the downloaded file from this server to the other Coveo Master server to which you wish to transfer the configuration.

  8. On the target Coveo Master server, access the Interface Editor (see Opening the Interface Editor).

  9. Click the Search Interfaces tab, and then in the Current Interface drop-down list, select the search interface for which you want to import the configuration file.

  10. On the menu, select Advanced, and then in the navigation panel on the left, select Deployment.

  11. Under Deploy this interface to another Coveo Enterprise Server:

    1. Optionally, under Download the search interface xml, click Download to create and save a backup file.

      Note: It is recommended to create and save a backup file for the current configuration so that you can easily roll back to the current state when the import of another configuration does not give expected results.

    2. Under Upload the search interface xml, click Browse, and then select the XML file that you copied from the source Coveo Master server.

    3. Click Upload to import the search interface configuration.

  12. Open the search interface from the target Coveo Master server to validate that the configuration import gives expected results. Use the Interface Editor when you need to make adjustments.