Upgrading from v3 to v4

This is for:

Developer System Administrator

Coveo for Salesforce 4.0 (April 2020)

As of the release of Coveo for Salesforce v4, some changes are introduced into the Coveo for Salesforce AppExchange package.

This FAQ article aims at answering the most frequently asked questions and concerns about the upgrade of Coveo for Salesforce v3 to v4.

What are the breaking changes associated with Coveo for Salesforce package v4?

Four Lightning components are removed from the Coveo for Salesforce AppExchange package to remain in compliance with Salesforce Lightning Locker Service. These components only affect Salesforce Community implementations.

Why is Coveo rolling out these breaking changes?

Salesforce no longer allows non-Lightning-Locker compliant components to be part of an AppExchange package, these components were released before Lightning Locker Service was introduced and are therefore non-compliant.

Which components will be removed from the Coveo for Salesforce package in v4?

Which components are available to replace the components that are being removed?

Who is affected by this major release?

Any Coveo for Salesforce customer who currently uses one of the following components in their Experience Cloud site will be affected when upgrading to Coveo for Salesforce v4 and above.

I am using package v3, but am not planning on upgrading right away, can I still migrate to the new components?

Yes, the new components are available since February 2019 maintenance release (v3.25). You can migrate to them at any time.

What will happen if I upgrade to package v4 and still use the old components?

The old components will break and you will have to migrate to the replacement components.

Can I roll back to v3 once they upgrade to v4?

It’s very difficult to roll back a package once it’s installed. We strongly recommend that you read the documentation, verify if the changes will affect your implementation and plan accordingly before upgrading your package.

What if I don’t want to upgrade to v4?

You may continue to use v3. Coveo will continue to support v3 for 3 years, except for the 4 components being removed in v4, which will continue to be supported to the best of our ability for 6 months. Depending on the situation, we may decide that the best course of action to continue support is to upgrade to v4.

See Product lifecycle for more information.

How can I check if I’m using deleted components?

You can perform a search on your code to find the names of the old components:

  • CoveoV2:Search

  • CoveoV2:Searchbox

  • CoveoV2:CaseCreation

  • CoveoV2:Base

Is there documentation that I can use to help me migrate to the replacement components?

Yes, use this documentation.