Manage an Organization
- Review Organization Information
- Use the Administration Console
- Apply Critical Updates
- Manage Groups
- Manage Temporary Access
- Manage API Keys
- Review Organization Activity
- Manage Indexes
- Configure Notifications
- Use the Platform API
- Use the Authorization Server API
- Non-Production Organization Reference
- Organization Backup Reference
Use the Administration Console
The Coveo Administration Console is a web application allowing its users to manage their Coveo organization.
To access the Administration Console, one must be granted the privilege to see one of its pages, at least. Then, after logging in, they can review certain data or perform certain tasks, depending on the set of privileges they have been granted. For example, they could be allowed to manage the content of your organization or review usage analytics data.
Not all Coveo Cloud users in your company or organization need to access the Coveo Administration Console. Most Coveo Cloud users in your ecosystem only interact with the Coveo Cloud search interfaces you implemented in your intranet, customer support application, customer portal, etc. These end users are only seeking relevant content and don’t need to understand or manage the mechanics providing them their content.
Therefore, you should only grant the privilege to access the Coveo Administration Console to coworkers who actually need to review or edit your Coveo organization data and configuration.
The Administration Console is divided into four main sections:
The Coveo Administration Console is only available in English.
The Administration Console navigation menu is organized into five sections, which group related pages. The following table briefly describes the content of each section.
|3||Available section page|
|Content||Allows you to manage sources, fields, and indexing pipeline extensions to optimize content retrieval and searchability.|
|Search||Allows you to optimize search results relevance and search experience in general, and manage hosted search pages.|
|Machine Learning||Allows you to manage Coveo Machine Learning models and evaluate their effectiveness and learning process.|
|Analytics||Allows you to monitor and measure the usage of your Coveo search solution.|
|Organization||Allows you to manage how groups, members, and API keys access the organization and to review the organization activity.|
The Administration Console header appears at the top of all Administration Console pages. It includes two important features of Coveo Cloud: the organization picker and the organization settings button.
|1||Hide/show navigation menu|
|2||Coveo logo with a link to coveo.com|
|3||Coveo Cloud organization picker|
|5||Member identification and member menu|
The organization picker indicates which organization you’re managing with the Administration Console, as well as its deployment region. When you have access to more than one organization, you can switch between organizations through the Organization drop-down menu.
There are four types of organization, and three of them are non-production organizations.
A production organization powers your Coveo-powered search page and/or components. Therefore, any change made in this organization affects the content your end users find in their search results, often in real time.
A sandbox organization is a test organization. It allows you to test changes without affecting your end users. Then, when you’re satisfied with the results, you can apply your changes to your production organization.
A test organization is a disposable test organization that you can create from the organization picker to make quick tests or explore Coveo Cloud features. A test organization quickly becomes inactive when no query is performed.
A trial organization is a temporary organization created to allow you to test Coveo before committing to a full license. A trial organization quickly becomes inactive when no query is performed.
The member identification drop-down menu, i.e., where your service provider, name, and email address appear, allows you to access your User Notifications panel and to log out of the Administration Console.
In the upper-right corner, click to access your organization Settings panel. The panel displays information on your organization such as the types of sources you can create, the license expiration date, and the license limits.
See Review Organization Settings and Limits for more details.
The Status section appears at the bottom of the navigation panel and provides information about the state of your organization and the whole Coveo Platform.
The Coveo team is automatically notified when your organization or components of the Coveo Platform enter a warning (yellow) or error (red) state and will act to fix the issue as quickly as possible. You can’t do anything to fix the issues apart from contacting Coveo Support when an issue persists.
To increase resiliency, consider a multi-region deployment. If your organization is deployed across many regions, and the service is affected in a satellite region, the search requests fall back to your primary region.
Review the Status of Your Organization and the Coveo Platform
The Status icon turns yellow or red whenever the Organization and/or Systems state indicator does, allowing you to easily identify that an issue occurs.
In the lower-left corner of Administration Console, bring the pointer above the Status section to expand it.
Access the status.cloud.coveo.com Site
The status.cloud.coveo.com site provides complete search and indexing cloud service availability information.
In the lower-left corner of Administration Console, bring the pointer above the Status section to expand it.
The following elements are available on the page:
Status icon color:
Summarizes the Organization and Systems states by taking the color of the worst state (red when any is red [error], yellow when any is yellow [warning], green when both are green [healthy]).
Indicates the state of the currently selected organization.
Indicator color Organization state Description Green
Your organization is fully functional. Yellow
Your trial organization was inactive and is now going back to an active state. Organization schedules are being reactivated, meaning that items and security identities will be indexed and updated again.
Maintenance operations (such as a restore following an issue) are ongoing on one or more components associated with your organization that's in read-only mode, meaning that you can't add, remove, and change anything from the Administration Console. Usually, your content is still searchable and indexing activities take place.
Source issues won't appear here, but rather on the Sources page.
While the cloud infrastructure for the organization is being provisioned. Yellow
Your trial organization is considered inactive since no query has been made over the past 48 hours. Organization schedules are disabled, meaning that items and security identities are no longer included nor updated.
To reactivate your organization, click Click to reactivate in the Status widget or access the Content Browser. Alternatively, if any organization user makes a query, the organization will be reactivated.
If you're satisfied with Coveo Cloud, consider contacting Coveo Sales to upgrade your trial to a standard license. Coveo organizations with a standard license don't become inactive due to idleness.In the Platform API and in some exception/error messages, an inactive organization may also be referred to as a paused organization.
Inactive organizations are in a read-only state. This implies that in an inactive organization, you can't create, edit, or delete resources (sources, fields, query pipelines, etc.).
Search is unavailable
Your organization search service is unavailable. The Coveo team has been notified and is working to resolve the issue. Contact the Coveo Support team for more information.
Failed to go inactive
Failed to resume
No response from the server
The Coveo Cloud server failed to return the expected information. The Coveo team has been notified and is working to resolve the issue. Contact the Coveo Support team for more information.
Summarizes the state of the Coveo Platform services and APIs and provides a link to status.cloud.coveo.com.
Indicator color Coveo Cloud state Services and APIs details Green
All systems operational
All components operational Yellow
Partially degraded service
Any component degraded performance Yellow
All components degraded performance Yellow
Minor service outage
Any component partial outage Red
Partial system outage
Any or all components partial outage Red
Major system outage
All components major outage
When Coveo Platform updates affecting all organizations are planned, the scheduled maintenance line appears to indicate when the next maintenance will take place relative to now.
Scheduled maintenance in 15 hours
Scheduled maintenance in 12 days
You can click Systems to access the status.cloud.coveo.com site and look for the update notification that will include a link to the release notes announcing the changes for the update.
Monitor the Coveo Platform Availability
The Coveo™ Platform status page provides availability information such as current status, incident notes (if any) for the past 14 days, uptime history and downtime information for all indexing, search, and usage analytics of the Coveo Platform services (see Coveo Cloud Status Page - status.cloud.coveo.com).
The status page is available for reference at any time. You can subscribe to the page to get email, SMS, webhook, RSS event notifications. In the Administration Console, you can also access this page by hovering over the Status section (bottom left corner) and clicking the Systems box on the Status menu that slides up.
The status page presents the following availability information:
Current general systems status
Current specific status of each cloud service such as the Search, the Platform, the Indexing Pipeline, the Analytics…
Status of individual services can be:
It’s possible that the service is affected only in a satellite region. In such cases, the traffic falls back to the primary region (see Multi-Region Deployments). The error messages provide more details.
Search Response Time for the Day, Week, and Month
Past Incidents such as issues and scheduled maintenance
The page only presents incidents that affect all clients.
For example, when a cloud service suffers a generalized performance degradation, a notice is posted on the page. However, when the indexing process doesn’t work for one client in particular, the incident doesn’t appear.
The Administration Console is accessible with the supported browsers listed in the following table.
|Google Chrome||Latest stable|
|Mozilla Firefox||Latest stable|
|Apple Safari||Latest stable (on OS X, but not on Windows)
|Microsoft Edge||Latest stable|