Review Organization Settings and Limits

The Coveo Administration Console Settings (platform-eu | platform-au) panel shows information regarding your Coveo license and organization. Some details are only available for review while others can be edited by organization members who have the required privileges.

  1. In the Settings (platform-eu | platform-au) panel, select the desired tab to access the corresponding information and settings. Your options are:

  2. On the left side of the panel, select a subtab to access the corresponding settings.

“License” Tab

Limits

On the Settings page, under License > Limits (platform-eu | platform-au) , you can review your current use of certain features.

Consumption Dashboard

On the Settings page, under License > Consumption (platform-eu platform-au), you can monitor how the selected organization is using search resources on a monthly basis. See Monitor Search Consumption for details on this dashboard.

License Details

On the Settings page, under License > Details (platform-eu | platform-au) , you can review your Coveo organization license information.

To upgrade your license or subscribe to another Coveo product, contact your Coveo representative.

Allowed Sources

On the Settings page, under License > Sources (platform-eu platform-au), you can review the sources that your license allows you to create.

If a source you need isn’t available, contact your Coveo representative to upgrade your license.

For details on Coveo’s source offering, see the Connector Directory.

“Analytics” Tab

Internal Event Filters

On the Settings page, under Analytics > Internal Events (platform-eu | platform-au) , you can provide Coveo with your NAT or public IP addresses. Events associated with these addresses are then flagged as internal, i.e., triggered by your personnel.

Enter a public IPv4 or IPv6 address or a range of addresses in the Classless Inter-Domain Routing (CIDR) notation, and then click Save.

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

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.

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 aren’t modified. Only subsequent events are flagged as internal.

  • The following IP ranges are reserved for private internets and therefore cannot be flagged for internal events:

    • 10.0.0.0 – 10.255.255.255
    • 172.16.0.0 – 172.31.255.255
    • 192.168.0.0 – 192.168.255.255

Strict Validation (Dimension Value Filters)

On the Settings page, under Analytics > Strict Validation (platform-eu | platform-au) , you can validate analytics data using out-of-the-box rules.

Validation rules filter out suspect dimension values to prevent malicious users from sending probing data to the Usage Analytics service. Suspect values can also be due to an invalid implementation or penetration/load tests. Either way, rejected values are excluded from reports, exports, and the Visit Browser.

Validation rules target the following dimension values:

  • 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 Expand to expand a rule and reveal invalid values in your analytics data. 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).

    Invalid values logged during the current day aren’t listed.

  2. When there are such invalid values, we recommend that you enable the strict validation by checking the Apply box. Once you do it, validation rules reject any new event that doesn’t meet the defined criteria, and invalidated values are no longer shown when you expand rule rows.

“Organization” Tab

Organization Details

On the Settings page, under Organization > Details (platform-eu | platform-au) , you can review information and inputs relative to your organization:

  • The Organization name is the name that’s displayed in Coveo to identify your organization. For example, it appears in the organization menu at the top of the Coveo Administration Console.

  • The Organization ID (organizationId in the code) is the original organization name with all spaces and special characters removed, all uppercase characters converted to lowercase, and a series of random characters appended. For example, if your organization name is Company - Search, your organization ID is companysearch83n293c8.

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

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

  • 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 your Coveo representative such as a notification when the organization license is about to expire.

  • The Allow access to Coveo Professional Services checkbox indicates whether you authorize the Coveo Professional Services personnel to access and modify your organization on your behalf.

  • The Allow Coveo ML to execute performance tests on your models checkbox indicates whether you authorize the Coveo Machine Learning team to perform tests with your machine learning models.

  • The Delete Organization button, which you can use to delete your organization permanently when you no longer need it. For instance, you could decide to delete an organization created for testing purposes once the test is done.

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

Single Sign-On

If you want to configure a Security Assertion Markup Language (SAML) single sign-on (SSO) for your Coveo organization, you must first configure your identity provider.

Then, enter the data you obtained during this first step on the Settings page, under Organization > Single Sign-On (platform-eu | platform-au) . This allows Coveo to work together with your desired identity provider. See Coveo SAML SSO for further details on the SSO configuration process.

Required Privileges

The following table indicates the privileges required to view or edit elements of the Settings (platform-eu | platform-au) panel. See Manage Privileges and Privilege Reference for details.

Tab Action Service - Domain Required access level
License View limits and details Organization - Organization View
View the consumption dashboard

Organization - Organization

Search - Search usage metrics

View
Change entitlement metrics in the consumption dashboard

Organization - Organization

Search - Search usage metrics

Edit
Analytics Edit settings Analytics - Administrate Allowed
Organization - Organization View
Organization View organization details Organization - Organization View
Edit organization details Organization - Organization Edit
View SSO configuration

Organization - Organization

Organization - Single sign-on identity provider

View
Edit SSO configuration Organization - Organization View
Organization - Single sign-on identity provider Edit
What's next for me?