THIS IS ARCHIVED DOCUMENTATION

Overriding the Search Friendly Error Message

This is for:

Developer System Administrator

If a critical error occurs when rendering the search page, the Coveo Search component is set to render an error such as this one, instead of raising an ASP.NET error:

If Coveo Cloud happens to be down while visiting your search page, the Coveo Search component is set to render an error such as this one, instead of raising an ASP.NET error:

These captions are based on Sitecore dictionaries. Therefore, it’s easy for you to modify them.

Step 1: Create a Dictionary for Your Custom Labels

  1. Open Sitecore Content Editor.

  2. Navigate to /sitecore/system/Dictionary.

  3. Select the Dictionary item, then right-click it and select Insert > Dictionary folder.

  4. Name your dictionary. For this example, you can name it Custom.

Step 2: Create the Custom Title Caption

Create the custom title caption.

  1. Select the Custom item, right-click it and select Insert > Dictionary entry.

  2. Enter a name such as CustomSearchUnavailableErrorTitle.

  3. Fill the Key field with the text below.

    The text must be exactly as shown below. Make sure there are no leading or trailing whitespaces.

    Search is currently unavailable

  4. Fill the Phrase field with the text you want.

Step 3: Create the Custom Label for the Detail Message

  1. Create a new Dictionary entry as in Step 2.

  2. Fill the Key field with the text below.

    The text must be exactly as shown below. Make sure there are no leading or trailing whitespaces.

    If the problem persists contact the administrator.

  3. Fill the Phrase field with the text you want.

  4. Publish the Custom dictionary and its subitems. The friendly error messages are now overridden.