Basic Resource Snapshot Workflow

This article describes the process of creating a resource snapshot in an organization to apply it to another organization.

The process takes place in two phases, each phase corresponding to one of the two organizations you’re working with. The origin organization is the organization from which you create and export the snapshot, while the destination organization is the one in which your snapshot will be imported and applied. Typically, the origin organization is a non-production organization, and the destination organization is a production organization. However, you could also decide to apply a snapshot in the same organization it was created, for instance to revert to a backup snapshot.

Depending on who has access to each of these organizations, multiple individuals may be involved in the snapshot application process. Typically, very few people are allowed to make changes to a production organization, so you might need to ask your Coveo administrator to apply a snapshot if you can’t do it yourself.

Origin Organization

  1. You make changes to your resources and test whether these changes have any unwanted impact.

  2. On the Resource Snapshots page, you create a snapshot and select the resources you changed.

  3. You send your snapshot to the destination organization.

Destination Organization

  1. On the Resource Snapshots page, you run a synchronization operation to have Coveo associate the resources in the snapshot with the resources in the destination organization. You can then review and confirm these associations to ensure the snapshot applies smoothly.

  2. You review the resources to add, update, and delete in the destination organization.

  3. You apply the snapshot to the organization.

See Apply a Snapshot to an Organization.

You made some changes to the code of your indexing pipeline extensions and tested them in your sandbox organization. Since you are satisfied with these changes, you now want to apply them to your production organization. You therefore create a resource snapshot that includes the extensions that you modified, and then send it to your production organization.

You contact the production organization administrator and ask them to review and apply the snapshot. Once they do, your changes apply to the production organization, i.e., your extension configuration changes are copied to the extensions in this organization.

What’s Next?

The Snapshot Structure article details the JSON structure of a resource snapshot.

Recommended Articles