Manage an Organization
- Review Organization Information
- Use the Administration Console
- Review Organization and Platform Status
- Manage Groups
- Manage Temporary Access
- Manage API Keys
- Review Organization Activity
- Configure Notifications
- Manage Resource Snapshots
- Apply Critical Updates
- Use the Platform API
- Use the Authorization Server API
- Non-Production Organization Reference
- Organization Backup Reference
Non-Production Organization Reference
A production Coveo organization powers your Coveo search page and/or components. Changes made in this organization affect the content your end users find in their search results, often in real time.
On the other hand, non-production organizations allow you to explore new features and test your configuration changes or development work without impacting your production organization. However, although non-production organizations are hosted in the same Coveo environment as production organizations, they have limitations and different licenses.
It’s strongly advised against going live with a non-production organization due to its limitations.
Definitions and Use Cases
A trial organization lets you experiment with Coveo for 30 days before committing to a full license. It provides a dashboard to guide you through the essential features you should test during your trial.
It allows its creator to make quick, small-scale tests or to explore features in their own environment, without disrupting the work of other Administration Console users. For example, one could create a test organization to try a feature as they follow a Coveo training. When the creator is done with their test, they can either delete the test organization or keep it for future use.
However, test organizations offer limited performances and can’t be upgraded to another tier of organization (e.g., sandbox organization). You should consider creating a trial organization if you expect to need a license upgrade to conduct your tests properly.
A test organization quickly becomes inactive when it does not receive any queries. It is automatically deleted 3 months after its creation.
A sandbox organization is a permanent test organization that comes with your production organization. It allows you to test configuration changes and critical updates before introducing them into your production organization. Typically, Coveo customers have one or two sandboxes shared by all Coveo Administration Console users.
Minimized operational risk
By conducting your tests in a non-production organization, you limit the disruptions to your production organization and ensure to maintain a stable live environment.
Developers can work around the constraints of a production organization. When they implement changes within the sandbox organization, they don’t have to worry about causing downtimes in production.
Coveo makes critical updates available to organizations weeks or months prior to their official activation date, allowing you to explore and test these updates in advance at your convenience.
All Non-Production Organizations
To conduct your tests, you should have your non-production organization index sandbox instances containing demo or test data. This practice prevents an unnecessary load on your production servers and unauthorized access to your production data by developers or Coveo Administration Console users.
Sandbox-Specific Leading Practices
Your sandbox organization should contain the same resources as your production organization, such as fields, indexing pipeline extensions, and query pipelines. This ensures that your sandbox organization is similar to your production organization and therefore makes your tests more realistic.
The only difference between the two organization types is the external systems that they target. For example, both your sandbox and production organizations may have a Salesforce source. The source in your sandbox organization indexes the content of your Salesforce sandbox instance, while the source in your production organization indexes the content of your Salesforce production instance.
Establish a development strategy involving at least one sandbox.
When you have one sandbox organization, your development strategy could be the following:
- Develop features and resource configurations in the sandbox organization.
- Test your changes.
- Schedule a release date.
- Migrate the changes to the production organization.
When you have two sandbox organizations, you can use one as a development environment and the other as a QA/user acceptance testing (UAT) environment. Your configurations and code should deploy successively in these two non-production organization before being implemented in your production organization.
Use the sandbox organization to restrict the number of users that can access your production organization. For example, only the team in charge of production deployment could be allowed to make changes to your production environment, while your developers could have read-only access to this organization. They would therefore be able to perform development tasks and test their changes in your sandbox organization, but not to release their work in production.
Coveo always prioritizes customer production organizations. Therefore, non-production organizations are allocated less resources and run on an infrastructure that isn’t as powerful as that of a production organization. As a result, if your non-production organization index contains a similar number of items as your production organization, you should expect slightly longer indexing and query response times. For the same reasons, non-production organizations are not well suited for performance and load testing, and do not support multi-region deployments or data residency outside the US.
Moreover, non-production and production organizations aren’t covered by the same service-level agreements (SLAs). Should an incident occur, the Coveo Cloud team always prioritizes production organizations during incidents to comply with its SLAs. Also due to the discrepancies between SLAs, performance tests can only be conducted in production organizations under specific circumstances.
Because of the performance and SLA limitations, Coveo strongly advises against going live with a non-production organization, even in projects outside your main use case. Use your production organization for any project going live to benefit from the best possible service from Coveo.
The following table highlights license differences between production and non-production organizations.
|Minimum number of indexes1||2||1||1||1|
|Maximum number of sources||25||25||5||25|
|License duration||N/A||N/A||3 months||30 days|
1: The number of indexes for each organization is optimized for performance and redundancy.
2: Alert escalation for incidents are delayed.
3: Full index backups are kept for 60 days while regular index backup are kept for 30 days. See About Coveo Organization Backups for details.
4: You can review the product type in your organization license information.