Coveo for Sitecore: Index Error Troubleshooting and Resolution

I installed Coveo 5.0.1039.1 on the Sitecore 10.1 instance locally.

After Coveo activation, the indexes weren’t loading and threw an error.

The logs showed ‘The parameter ‘p_ApiKey’ must not be an empty string’ error.

Exception: System.ArgumentException Message: Precondition failed: The parameter 'p_ApiKey' must not be an empty string Parameter name: p_ApiKey Source: Coveo.Framework at Coveo.Framework.CNL.Precondition.RaiseArgumentException(String p_Message, String p_ParameterName) at Coveo.Framework.CNL.Precondition.NotEmpty(String p_Parameter, String p_ParameterName) at Coveo.CloudPlatformClientBase.Communication.CloudPlatformHttpClientFactory.CreateAuthorizedJsonHttpClient(String p_ApiKey) at Coveo.CloudPlatformClientBase.CloudPlatformClient..ctor(CloudPlatformConfiguration p_Configuration, ICloudPlatformHttpClientFactory p_CloudPlatformHttpClientFactory, IPipelineRunnerHandler p_PipelineRunnerHandler, ISerializer p_Serializer, ICoveoSettings p_CoveoSettings, IStaticTTLCacheFactory`2 p_StaticTTLCacheFactory, ICriticalExceptionHandler p_CriticalExceptionHandler) at Coveo.CloudPlatformClientBase.CloudPlatformClient..ctor(CloudPlatformConfiguration p_Configuration) at Coveo.CloudPlatformClientBase.Communication.CloudPlatformClientFactory.GetCloudPlatformClient(CloudPlatformConfiguration p_Configuration) at Coveo.SearchProvider.Licensing.CloudLicenseRetriever.GetCloudLicense() at Coveo.SearchProvider.Licensing.CloudLicenseRetriever.GetLicense(Boolean p_ForceRetrieve) at Coveo.SearchProvider.Licensing.Cloud.LicenseRetriever.GetLicense(Boolean p_ForceRetrieve) at Coveo.SearchProvider.Licensing.LicenseManager.RetrieveLicense(Boolean p_ForceUpdate) at Coveo.SearchProvider.Licensing.LicenseManager.EnsureValidLicense() at Coveo.SearchProvider.Licensing.LicenseManager.GetLicenseInformation() at Coveo.SearchProvider.Rest.SitecoreRestHttpHandler.InitializeLicenseSettings() at Coveo.SearchProvider.Rest.SitecoreRestHttpHandler.OnInitializeSettings() at Coveo.Search.Api.Proxy.ProxyHttpHandler.OnInitialize() at Coveo.Search.Api.Proxy.ProxyHttpHandler.EnsureInitialized() at Coveo.Search.Api.Proxy.ProxyHttpHandler.ProcessRequest(IHttpContext p_Context) at Coveo.SearchProvider.Rest.SitecoreRestHttpHandlerDispatcher.ProcessRequest(HttpContext p_Context) at System.Web.HttpApplication.CallHandlerExecutionStep.System.Web.HttpApplication.IExecutionStep.Execute() at System.Web.HttpApplication.ExecuteStepImpl(IExecutionStep step) at System.Web.HttpApplication.ExecuteStep(IExecutionStep step, Boolean& completedSynchronously)

After researching, came to know there are two API Keys in Coveo.CloudPlatformClient.Custom.config needs to match with Coveo Platform.

1. apiKey
2. searchApiKey

When I logged into the platform, the keys were not visible since it was secure (not sure where I saved it!), decided to create new keys.

1. SearchApiKey

To create the Search API Key, we must ensure the correct permissions are in place.

Ensure that Impersonate -> Allowed is selected to limit the scope of the API Key, which can be selected from the drop-down list.

2. ApiKey

To create the ApiKey, we need to set multiple privileges.

Content Tab:

1. Fields -> Edit
2. Security Identities -> Edit
3. Security Identity Providers -> Edit
4. Sources -> Edit all

Organization Tab:

1. Organization -> Edit

Search Tab:

1. Search Page -> View all

When the keys are created, make sure to save them in a secure place!

It is time to update the new config keys.

Modify the apiKey and secureApiKey values in Coveo.CloudPlatformClient.Custom.config under AppConfig/Include/Coveo folder

Let’s reload Coveo Index Manager and no more errors.

Indexes are loaded and rebuilt successfully. Yay!

Hope this helps.

Happy Sitecoring!

References:
https://docs.coveo.com/en/2484/coveo-for-sitecore-v5/activate-silently#creating-the-api-keys

April 24, 2024

2

Sitecore

My 2023 Reflections

2023 has been a great year – I went to India in the Summer and Minneapolis in the Fall to attend three events – MVP Summit, Sitecore DX, and SUGCON- NA (had a lot of learning in organizing!).

Presentations

Blog Posts

Certifications

Jan 2023 – Sitecore Content Hub Admin Certification
Mar 2023 – Sitecore Content Hub Developer Certification
Sep 2023 – Sitecore XM Cloud Certification

Contributions

SUGCON- NA Organizer
XM Cloud Beta Training and Feedback
XM Cloud Alpha Review Exam
User Testing Feedback with Sitecore Search

Co-organized SUG-Pittsburgh Meetups

Dec 08, 2022 – Moving to Headless without losing your head | CDP – A comparative study
Jan 25, 2023 – Sitecore Headless Project Experiences with Next.js
Feb 08, 2023 – The Road to Composable: Migrating your XP solutions to Headless
Mar 08, 2023 – Role of CX in Composable DXP world
Apr 05, 2023 – Introduction of Javascript SDK for Sitecore Discover
May 31, 2023 – Sitecore Search 101
Jun 22, 2023 – When AI met Sitecore CDP
Jul 10, 2023 – The capabilities of Sitecore’s DXP products against Adobe, Acquia and Optimizely
Aug 9, 2023 – Getting Started With Sitecore Experience Edge
Sep 21, 2023 – One click Sitecore deployment to Kubernetes
Oct 25, 2023 – Sitecore XM Cloud – Experiences and Learnings
Nov 09, 2023 – Building an Intelligent Chat Experience by Real-time Content with OpenAI

Co-organized SUG-QueenCity Meetups

March 22, 2023 – March 2023 Virtual Meetup of the Queen City Sitecore User Group
June 28, 2023 – June 2023 meetup of the Queen City Sitecore User Group

YouTube videos published for SUG – Pittsburgh

CDP Comparative Study

Moving to Headless without losing your head

Sitecore Headless project experiences with NextJS

The Road to Composable Migrating your XP solutions to Headless.

Role of CX in Composable DXP world

Introduction of JavaScript SDK for Sitecore Discover

Sitecore Search 101

When AI met CDP

How do the capabilities of Sitecore’s DXP products stack up against Adobe, Acquia, and Optimizely?

Getting Started With Sitecore Experience Edge

One click Sitecore deployment to Kubernetes

Sitecore XM Cloud Experiences and Learnings

Building an Intelligent Chat Experience by Real-time Content with OpenAI

Conferences I attended

MVP Summit
Sitecore DX
SUGCON-NA
MVP Sitecore Lunches and Webinars
All SUG Pittsburgh and Queen City meetups
Many SUG Boston/ Columbus/ Atlantic meetups

Plans for 2024 :

Learn and contribute:

XM Cloud Plus
Sitecore CDP and Personalize

Co-organize :

Monthly SUG-Pittsburgh meetup
Monthly SUG-QueenCity meetup

Present:

SUGCON EU/Symposium
SUG Meetups

Happy Sitecoring!

January 2, 2024

0

Coveo / Sitecore

Integrating Sitecore website with Coveo rapidly

In the previous blogs, we saw how to install and configure Coveo, troubleshoot, and diagnostics.

https://madhuanbalagan.com/install-and-configure-coveo-for-sitecore

https://madhuanbalagan.com/coveo-for-sitecore-troubleshooting-and-diagnostics

Now that Coveo is installed and ready to use, Let us add a Sitecore website to our instance of Coveo.

In the Coveo Admin Console, we can see that there is already a Coveo Master, and Web indexes are added by using the Sitecore Package Installation.

In this blog, I am showing an approach without any installation or configuration on the Sitecore Instance. This approach can be used with any non-Sitecore websites as well.

Let’s add the Sitecore website as a web source of content.

We have lots of options to choose from let us focus on web for now.

Here I’m adding my blog as a Source for our demo.

As soon as adding website name, it recognizes and shows the Sitemap URL and recommends adding it for better performance.

After adding the Sitemap URL, Coveo has a few configurations like Authentication and Content security.

Since the blog is public-facing no security configuration would be needed.

Now add and build the source to populate the index. It might take time depending on the number of pages on the site.

When it’s completed it will turn green and show the number of items in the index and the size.

Now that the Index is built, let’s navigate to Content Browser to see if our pages show up.

Navigate to the content browser and search for a term.

Voila! It works! Now you could integrate Coveo search on your site with a preferred approach.

Hope this helps.

Happy Sitecoring!

December 14, 2023

0

Coveo / Sitecore

Coveo for Sitecore: Troubleshooting and Diagnostics

Coveo’s Diagnostics page is super helpful when troubleshooting any Coveo issues. It is listed in the Coveo Search menu in the Sitecore control panel or can be reached directly with the following url –

https://[CMS Site]/sitecore modules/web/coveo/admin/coveodiagnosticpage.aspx

Coveo for Sitecore components state

This section shows the status of all services related to Coveo. Here is the healthy state, but when it errors it shows the detailed error message

Healthy Component State

Errors in Component State

Coveo for Sitecore version information

It comes in handy for checking Coveo and Sitecore versions and their compatibility.

Current Coveo for Sitecore version: 5.0.1153.1

Current Sitecore version: 10.2.0.6766

Compatibility status: these versions are compatible

Coveo for Sitecore organization information

This section is about the Organization and it is usage details.

Coveo for Sitecore configuration files

Basically shows all Coveo-related config files that are currently loaded in the system.

Coveo for Sitecore published items

It shows if the Coveo-related Sitecore items are published or not, it’s time to publish them 🙂

Coveo for Sitecore Indexing test

This section comes into handy when indexing an item or a path, really helpful when an Item has been published but it’s not available in the Coveo index.

Coveo for Sitecore log viewer

This section is my favorite – I typically use it on Production environments to view the logs when we don’t have access to the server or without logging into the Production servers. We can quickly view the log and troubleshoot the issues.