Accessing the Health Check Page

Free edition only

Coveo for Salesforce 3 (May 2018)

The Health Check page allows administrators to quickly visualize what are your services status, and their explanation, in your Salesforce Organization and your Coveo for Salesforce integration. Entering a search token automatically runs some tests to know more about the services status in your search page.

  1. If not already done, log in to Salesforce using an administrator account.
  2. Ensure your Salesforce Organization is linked to a Coveo Cloud Organization (see Configuring the Coveo for Salesforce Application).
  3. In Setup, next to your Coveo package, click Configure to access the Coveo for Salesforce Configuration page (Platform Tools > Apps > Installed packages).
  4. Ensure you have a search interface in your organization (see Inserting Coveo Components in Salesforce).
  5. Access your search interface, and open your browser console in the Network tab.
    1. Perform a search on your page, which you would expect would return your desired results.
    2. You should see two XHR requests to platform.cloud.coveo.com, usually named v2/. Select the last one.
    3. In the Headers section of the request, scroll to the Request Headers section.
    4. Under Authorization, you should see an authorization token that looks like this: Bearer ey....

      Copy the full token, which starts with ey.

  6. In Setup, access the Coveo for Salesforce Configuration page again (Platform Tools > Apps > Installed packages).

  7. Under Related Actions, select Health Check.
    1. Under Search Token Details, in the Search Token box, paste the full authorization token.
    2. Click the Run Health Check button.

Your Health Check page should look like this:

Interpreting the results

The dots help you to quickly visualize your service status with three different colors, explained in the following table, and are followed by a service status explanation.

Red dot Your tests failed. When your tests fail, you can click the solution link offered in the Help column.

Yellow dot

Your service test failed because your prerequisite test failed (red dot).
Green dot Your tests have been successfully processed without any problems.