Managing Coveo Cloud Organization Settings and Limits

The administration console organization Settings panel shows information regarding your current Coveo Cloud organization (see Switch Organization). Some are only available for review while other can be edited by organization members who have the required privileges.

Accessing and Navigating the “Settings” Panel

  1. If not already done, log in to the Coveo Cloud platform as a member of a group with the required privileges to manage settings in the target Coveo Cloud organization.

  2. In the administration console upper-right corner, click the Settings icon (Icon-AC8_Settings).

  3. In the Settings panel, click the desired tab to access the corresponding settings. Your options are:
  4. On the left-hand side of the panel, click the desired sub tab to access the corresponding settings. Your options vary depending on the selected tab.

Content Tab

Content Limits Sub Tab

On the Content tab, in the Limits sub tab, you can review the content licensing limits set in the selected organization license (see Coveo Cloud Organization Limits - Content Limits). You can also review your usage of certain features.

Sources Sub Tab

On the Content tab, in the Sources sub tab, you can review the connectors allowed by your organization license (see Available Coveo Cloud V2 Connectors).

When a connector you need is not available, contact Coveo Sales to upgrade your license.

Search Tab

Search Limits Sub Tab

On the Search tab, in the Limits sub tab, you can review the query per second and query pipeline limits set in the selected organization license (see Coveo Cloud Organization Limits - Search Limits).

Search Consumption Dashboard Sub Tab

On the Search tab, in the Consumption Dashboard sub tab, you can monitor how the selected organization is using search resources on a monthly basis (see Using the Search Consumption Dashboard).

Analytics Tab

Analytics Limits Sub Tab

On the Analytics tab, in the Limits sub tab, you can review the usage analytics licensing limits set in the selected organization license (see About Usage Analytics Limits and Coveo Cloud Organization Limits - Usage Analytics Limits).

Filter Out Internal Events From Usage Analytics Reports

On the Analytics tab, in the Internal Events sub tab, you can provide Coveo with your internal IP addresses. Events associated with these addresses are then flagged as internal, i.e., triggered by your personnel.

  1. In the Address input, enter a public IPv4 or IPv6 address or a range of addresses in the Classless Inter-Domain Routing (CIDR) notation (see CIDR notation), and then click Add IP.

    The range of public IP addresses for your enterprise is from 24.19.1.0 to 24.19.1.255. In the Address input, you enter:

    24.19.1.0/24

  2. Repeat to enter other IP addresses or ranges.

  3. Click Save.

    If you do not click Save before clicking another main menu item or another organization settings tab, all your modifications will be lost.

Once you saved your internal addresses, you can create and apply a named filter on the Is Internal dimension (Is Internal Is not true) to remove your internal events from usage analytics reports (see Is Internal, Create Named Filters, and Add Named Filters to Reports).

You can also create and apply the following named filter to only report on external events: Is Internal Is false.

Events that were logged before you defined the IP addresses are not modified. Only subsequent events are flagged as internal.

Filter Out Suspect Dimension Values

On the Analytics tab, in the Strict Validation sub tab, you can validate analytics data using out-of-the-box rules.

Validation rules prevent malicious users from sending probing data to the Usage Analytics service by filtering out suspect dimension values. Suspect values can also be due to an invalid implementation or penetration/load tests.

Validation rules target the following dimension values (see Usage Analytics Dimensions):

  • Origin Level 1
  • Origin Level 2
  • Language
  • User ID
  • User Name
  • Visitor ID
  • Query Pipeline
  • Event Cause
  • Source Name
  • System URI Hash
  • Event Type
  • Event Value

To validate analytics data

  1. Click each rule to expand its row and reveal invalid values in your analytics data.

    Invalid values logged during the current day are not listed.

    If invalid values have been logged in the last 30 days, a table shows these Filtered values and the number of times they were logged (Number of Hits).

  2. When there are such invalid values, it is recommended to enable the strict validation by clicking Apply.

    Validation rules reject events that do not meet the defined criteria.

    Only values logged after the validation is enabled are filtered out. Rejected values are excluded from reports, exports, and the Visit Browser (see Reviewing User Visits With the Visit Browser).

    • Invalid values are visible when expanding rule rows until the last invalid logged value is 31 days old.

    • Once the validation is applied, invalidated values are no longer shown when expanding rule rows.

Organization Tab

Organization Limits Sub Tab

On the Organization tab, in the Limits sub tab, you can review the organization licensing limits set for the selected organization (see Coveo Cloud Organization Limits - Organization Limits). You can also review your usage of certain features.

Review Organization Information Such As the Organization ID

  1. On the Organization tab, in the menu on the left-side, click the Information sub tab.

  2. In the Information sub tab, review the information relative to your organization:

    • The Organization name is the name that is displayed in Coveo to identify your organization. For instance, the name of your organization appears in the organization menu at the top of the Coveo Cloud administration console (see Switch Organizations). You can edit this name, and then click outside the box or press Enter to save. The change is effective immediately.

    • The Organization ID (organizationId in the code) is the original Organization name with all spaces and special characters removed and all uppercase characters converted to lowercase.

      When your original organization name is Company - Search, the organizationId is: companysearch.

      An administrator or a developer may need to know the organizationId value when configuring or customizing a component interacting with your Coveo Cloud organization, such as a search interface. However, you cannot edit the organization ID.

    • The Organization creation date is the date on which the organization was created. Knowing the creation date is useful to learn whether features that were released on specific dates are available in your organization.

    The Coveo Machine Learning Dynamic Navigation Experience (DNE) feature is only available for organizations created on May 21, 2019 or later.

    • The Contact email is the email address of the organization contact person. By default, the contact is the member who created the organization. They receive important emails from Coveo Support such as a notification when the organization license is about to expire. You can change the organization contact’s email address, clicking outside the box or pressing Enter to save. The change is effective immediately.

Enable Coveo Professional Services to Support Your Organization

  1. On the Organization tab, in the menu on the left-side, click the Information sub tab.

  2. In the Information sub tab, select the Allow access to Coveo Professional Services check box to enable Coveo Professional Services support. When you select or deselect it, the change is effective immediately.

Delete Your Organization

  1. On the Organization tab, in the menu on the left-side, click the Information sub tab.

  2. In the Information sub tab, under Organization deletion, click the Delete Organization button to delete your organization permanently when you no longer need it.

  3. In the Are you sure? confirmation prompt, click Delete Organization to confirm your choice.

    Deleting an organization permanently deletes all sources (and their content), query pipelines, and usage analytics data, among other things.

    You originally created your organization for testing purposes, and since the test is now finished, you decide to delete the organization.

License Sub Tab

On the Organization tab, in the License sub tab, you can review your Coveo organization license information. This information cannot be edited. Contact Coveo Sales to upgrade your license or subscribe to another Coveo product.

  • The License type is the type of Coveo license you have.
  • The Account ID, Account name, and Department identify you as a Coveo customer.
  • The License expiration date is the date before which your license must be renewed if you want to keep using your organization.

    Coveo Support will notify the contact person, the owner, and the administrators of the organization by sending emails 10 days, 5 days, and 1 day prior to the license expiration date. Those email notifications specify the Organization name and Organization ID, and includes a Renew license button. Organizations are deleted 7 days after the expiration date of their license. However, all organizations are backed up, meaning that the Coveo Support team could recreate the same organization with the same configuration, even for a trial organization (see About Coveo Cloud V2 Organization Backups).

  • The Product name, Product type, Product edition, Index backup type, and Index type indicate to which Coveo product you subscribed, and, if applicable, the product edition and index type (see About Non-Production Coveo Cloud Organizations).

Single Sign-On Sub Tab

If you want to configure a Security Assertion Markup Language (SAML) single sign-on feature for your Coveo Cloud organization, on the Organization tab, in the Single Sign-On sub tab, you can configure Coveo Cloud so that it works together with your desired identity provider (see Coveo Cloud V2 SAML SSO and Configuring Coveo Cloud V2 SAML SSO).

You must first configure your identity provider to obtain the data to enter under Single Sign-On (see Coveo Cloud V2 SAML SSO and Configuring Coveo Cloud V2 SAML SSO).

Required Privileges

The following table indicates the privileges required to view or edit elements of the Settings panel and associated panels (see Privilege Management and Privilege Reference).

Action Service - Privilege Required access level
View settings Organization - Organization View
Edit settings Organization - Organization Edit