Adding and Managing Search Pages

The Search Pages page allows you as an administrator to manage and host feature-rich search pages in your Coveo Cloud organization. These search pages can then be made available to specific groups in your organization.

Hosted search pages rely on the JavaScript Search Framework and can be easily customized using the Interface Editor.

Access the “Search Pages” Page

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

  2. In the main menu on the left, under Search, select Search Pages.

Add a Search Page

  1. On the Search Pages page, click Add Page.

    If the Add Page button is grayed and unresponsive, you do not have all of the required privileges to perform this action.

  2. In the Add a Search Page panel:

    1. In the Page name box, enter a unique and preferably human-readable path name for your search page. The value you enter may contain up to 50 alphanumeric, underscore (_), and hyphen (-) characters.

      This value is used to generate the URL of your search page.

      If your organization ID is mycoveocloudorganizationg8tp8wu3 and you enter my-search-page as a page name, your search page URL will be:

      https://search.cloud.coveo.com/pages/mycoveocloudorganizationg8tp8wu3/my-search-page
      
    2. In the HTML title box, enter a human-readable title for your search page. The value you enter may contain up to 200 characters.

      As its name implies, the HTML title value populates the HTML <title> element of your search page.

    3. Click Add page.

  3. In the This search page is not configured yet panel, click Set Up a Search Page.

  4. In the Setup a Search Page panel, select the tabs you want to include in your search page. The suggested tabs are based on the content of your index.

    1. (Optional) Click More Tabs to view additional tab options for content types that are not yet available in your index.

    2. Click Create Page.

  5. (Optional) Click the Edit Search Page button.

    1. Use the Interface Editor to customize your search interface.

    2. Click Save to make your changes immediately effective.

  6. (Optional) Ensure that the desired groups are granted access to your search pages.

Filter Search Pages

On the Search Pages page, in the right section of the Action bar, enter keywords in the Filter box. You can filter search pages by name, date of last modification, or URL.

Customize the Interface of a Search Page

  1. On the Search Pages page, locate and click the search page whose interface you want to edit.
  2. In the Action bar, click Edit Interface.

OR

  1. Access the search page whose interface you want to edit.
  2. In the upper left corner, click the Edit Search Page (Edit Search Page Icon) icon.

You can then use the Interface Editor to customize its layout and functionalities as you see fit.

Grant Access to Search Pages

You can restrict access to search pages in your organization by granting the required privileges to certain groups only.

By default, members of the Users and Administrators built-in groups have access to all search pages in your organization.

  1. Create a new group (or edit a group) that should be granted access to all search pages in your organization.

    Create a Hosted Search Page Users group, and grant it only the minimum required privileges.

  2. Review the granted privileges for your group members to ensure that they minimally have the following privileges.

    Service Name Access level
    Organization Organization View
    Search Execute queries Allowed
    Search Search pages View
  3. Access the Members tab of your group and ensure that the group only contains end users who should have access to search pages in your organization.

  4. Validate that members of your group can access search pages in your organization, perform queries, and only see appropriate search results.

  5. Share the search page URL with its intended end users.

    • If you create multiple hosted search pages targeting different audiences (e.g., employees, customers, partners), make sure permissions are configured appropriately on your sources to prevent disclosing sensitive information (see Content Security). For instance, customers should probably not be allowed to see the content of an intranet source.

    • If an SSO is set up for your organization, remember to invite the intended end users of your search pages as users of this SSO so they can access your search pages.

Edit a Search Page

Once a search page has been created, you can edit its name, HTML title, and JS Search Framework version at any time.

  1. On the Search Pages page, locate and click the search page you want to edit.

  2. In the Action bar, click More, and then click Edit.

  3. In the Edit a Search Page:[Page Name] panel that appears:

    1. (Optional) In the Page name box, enter a new unique, and preferably human-readable path name for your search page. The value you enter may contain up to 50 alphanumeric, underscore (_), and hyphen (-) characters.

      Be aware that changing the page name of an existing search page will update its URL.

      Organization members attempting to access that search page through its previous URL will thus get a 404 response.

    2. (Optional) In the HTML title box, enter a human-readable title for your search page. The value you enter may contain up to 200 characters.

    3. (Optional) Click the Search UI version drop-down list menu, and then select the desired JS Search Framework release version for your search page.

      New search pages automatically use the latest available JS Search Framework release version.

      While you can upgrade search pages to more recent versions, you cannot downgrade back to previous versions thereafter.

    4. Click Save.

Delete a Search Page

You can delete an existing search page at any time.

  1. On the Search Pages page:

    1. Locate and click the search page you want to delete.

    2. In the Action bar, click More, and then Delete.

  2. In the Action bar, next to the Are you sure? prompt, click Delete.

    Be aware that the search page will cease being available immediately after you confirm its deletion.

    Organization members attempting to access that search page will thus get a 404 response.

Access a Search Page

To access a search page in your organization, you can directly navigate to its URL from your browser.

OR

  1. On the Search Pages page, in the list of search pages:

    In the URL column, click the URL link of the page that you want to access.

    OR

    Click the search page that you want to access, and then in the Action bar, click Open.

  2. When you are not already logged in to Coveo Cloud, in the Log in to Coveo Cloud panel, click the identity provider (such as Google, Salesforce, or Office 365) matching the account with which you are a member of group that has the privileges to access the search pages (see Logging in to a Hosted Search Page).

  3. When you are not already logged in with the identity provider, in the interface of the identity provider, provide your credentials of an account with which you are a member of Coveo Cloud organization group that has the privileges to access the search pages.

The search page opens in a new browser tab.

Log Out of a Search Page

While in a Coveo Cloud hosted search page, in the top-right corner of the page, click the logout icon (Icon-LogOut).

The Coveo Cloud login page appears.

Search Page Limitations

Search pages hosted in Coveo Cloud organizations have a few noteworthy limitations:

  • The URL of a hosted search page always has the following format:

    https://search.cloud.coveo.com/pages/coveodocumentationtest/{organizationId}/{pageName}

  • A hosted search page cannot be accessed anonymously; its end users must authenticate through the Coveo Cloud platform.

  • It is not possible to grant access to specific hosted search pages only. A given group can either be granted access to all or none of the hosted search pages in an organization.

  • Component options cannot be set in the init function call of a hosted search page; you must rather pass component options before the init call.

Required Privileges

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

Action Service - Privilege Required access level
View search pages

Organization - Organization

Search - Search pages

View
Edit search pages

Organization - Organization

View

Search - Search pages

Edit
Edit and test search pages

Organization - Organization

View

Search - Search pages

Edit
Search - Execute queries Allowed