Product DocsMenu

Coveo Platform 6.5 >
Administrator Help > Connectors > EPiServer CMS Connector > Configuring and Indexing the Source

Configuring and Indexing an EPiServer CMS Source

A source defines a set of configuration parameters for a specific EPiServer CMS server.

Note: In an environment with more than one EPiServer CMS servers, define one source for each EPiServer CMS server that you wish to index.

To configure and index an EPiServer CMS 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 wish to add the new source.


    2. Click Add to create a new collection (see Adding a Collection).

  4. In the Sources section, click Add.

  5. In the Add Source page:

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


      A descriptive name of your choice for the connector source.

      Example: EPiServer CMS

      Source Type

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


      The root address of the EPiServer CMS application in the http://[EPiServer-host]:[port]/ form.

      Example: http://MyEpiServerSite:17000/

      Configuration File

      The absolute path to the configuration file (see Creating and Using an EPiServer CMS Configuration File).

      Example: C:\CES6\Config\MyEPIServerCMSConfiguration.txt


      Select the EPiServer CMS user identity that you created previously for this source (see Configuring an EPiServer CMS User Identity).

    2. The following parameters generally do not need to be changed:

      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 a source replaces a legacy system, you may want to set this parameter to High, so that in the search interface, results from this source appear earlier in the list compared to those from legacy system 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.
      If you defined custom field sets, ensure to select the most appropriate for this source (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 every day at 12 AM.

      Note: Because live indexing is not currently available for the EPiServer CMS connector, ensure to select the Every day option, as this is the only mechanism that keeps the index content up-to-date.

      Click Add Parameter when you want to show advanced source parameters (see Modifying Hidden EPiServer CMS Source Parameters).
    3. 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 portal 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. This option is cleared by default.
      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.
    4. Click Save.

  6. In the navigation panel on the left, click General.

  7. In the General page:

    1. Modify the Title Selection Sequence so that the Use the filename option is the first option at the top of the list.

    2. Click Apply Changes.

  8. When the user accounts in your EPiServer CMS system do not match those in Windows Active Directory, you can manually specify the permissions that will be set on documents from this source:

    1. In the navigation panel on the left, click Permissions.
    2. In the Permissions page:

      1. Select the Specify the security permissions to index option.

        In the Allowed Users and Denied Users boxes, respectively enter the allowed and denied users and groups for the source.

      2. Click Apply Changes.

  9. When you are ready to start indexing the EPiServer CMS source, click Start.

  10. In the navigation panel on the left, click Status, and then validate that the indexing process runs without errors.

What's Next?

Review if optional tasks are applicable to your environment (see EPiServer CMS Connector Deployment Overview).