Go to production
Go to production
When pushing your changes to production, you must migrate your entire organization, including your Coveo settings.
This article provides leading practices to migrate your development environment to a production environment, which is the last step of the Coveo for Salesforce integration.
Migration checklist
You must follow these guidelines when migrating your Coveo for Salesforce development environment to production:
-
Ensure that you install the same version (see Identify your Coveo for Salesforce version).
NoteIf your versions differ, upgrade Coveo for Salesforce.
-
Ensure that your selected users can access your Coveo components (see Grant users access to your Coveo Lightning components or Grant users access to your Coveo Classic components).
-
Ensure that you created a dedicated Salesforce crawling user.
-
Ensure that your change sets are working (see Change Sets Best Practices).
-
Ensure that your sandbox and production Salesforce organizations are respectively linked to your sandbox and production Coveo organizations (see Link to an existing organization).
-
Ensure to transfer your Coveo content, specifically:
-
Your query pipelines (see Manage query pipelines)
-
Your pipeline extensions (see Add an indexing pipeline extension)
-
Your custom components (see Add JavaScript to the Coveo for Salesforce Lightning components with custom code)
-
Your security identities (see Manage security identities)
TipYou can use the resource snapshot feature to transfer your content.
-
-
Ensure that your Experience Cloud site configuration is the same as in your sandbox (see Deploy Experience Builder Sites).
Additional v5 migration guidelines
If you’re using Coveo for Salesforce v5.2 or a later release, make sure to follow these additional guidelines to migrate your development environment to production. For context as to why these additional steps are necessary, see Upgrade from v4 to v5.
-
Using the data export tree, enter the following command to export your records:
sf data export tree --query "SELECT Id, Name, CoveoV2__PageContent1__c, CoveoV2__PageContent2__c, CoveoV2__PageContent3__c, CoveoV2__PageContent4__c, CoveoV2__PageContent5__c, CoveoV2__PageContent6__c, CoveoV2__PageContent7__c, CoveoV2__PageContent8__c FROM CoveoV2__PageContent__c" --target-org <MY-SANDBOX-ORG>
Where:
<MY-SANDBOX-ORG>
is the alias of your source sandbox organization. -
Enter the following command to deploy your records:
sf data import tree --files CoveoV2__PageContent__c.json --target-org <MY-PRODUCTION-ORG>
Where:
<MY-PRODUCTION-ORG>
is the alias of your target production organization.TipUsing this command to deploy your records will prevent you from having to access the Interface Editor to edit the HMTL markup for the result templates of each search interface that you implemented.
ImportantThis task will create another
PageContent
record. It won’t overwrite an existing entry. Therefore, be careful if you’re only trying to apply new changes to an existing page. You may need to manually delete the existing record.To delete an existing entry
-
In the Developer Console, enter the following command to query the records:
SELECT Id, Name FROM CoveoV2__PageContent__c
-
Delete the older entry.
NoteNot deleting an older entry won’t prevent your component from loading. However, when loading a Coveo page and querying for the HTML content, the first record with the matching name will be chosen and returned.
-