Coveo Search

Every Coveo search page is a custom search experience and therefore requires development. 

Collect the following information to standardize the request intake process:

• What is this request for?
  • Create a new standalone search page 
  • Integrate into an existing search page(s)
    • If adding to existing search pages, then which one(s)?
• Which content should be indexed?
  • If for an AVEVA site section:
    • Which pages or site sections?
  • If for a third party platform:
    •  Is there an existing sitemap.xml that can be referenced by Coveo? 
    • Is there a connector that can be used by Coveo?
    • Should all pages or only certain pages be indexed?
    • What text should be used for the Label in the search results?
• Are new facets needed, or will content be integrated into an existing facet? If adding to existing facets, then which one(s)?
• Should search results display as a list or as cards? (It can be cards only if it is a standalone search and each result has an image that can be displayed)

Search Results Generated from AEM Page Properties

Follow these guidelines to ensure front-end consistency in the search results. These results are generated from AEM content fields in Page Properties.

Global Search, Products, Perspectives, Press Releases, Events

• Every search result should have a Page Label (Page Label field in Basic tab) (page labels still to be applied in international sites)
  • Audit each facet under Content Type to ensure that all items in that content type have a page label that matches the facet name
  • Audit each facet under Page Type to ensure that all items in that page type have a page label that matches the facet name
• Every search result should display the following:
  • Content Type: Card Title and Card Description
  • Page Type: Page Title and Description
• The following search results should have a “Start Date” and a “Year” (derived from Start Date)
  (remove Start Date if applied to pages outside of these types)
  • Event (rule may change with AVEVA Salesforce implementation)
  • Press Release
  • Blog Post (Year tag still be applied)
  • Webinar (rule may change with AVEVA Salesforce implementation)

Products Only

• Every product should have a "by [Vendor]" label (Partner Name field in Card Properties tab)
  • AVEVA products: It should be “AVEVA Group plc” – not “AVEVA”
• If product has a former name, then letter casing and wording should be as follows:
  • Formerly Known As [Former Product Name]

Mark as "Index" or "No Index" and "Hide from Coveo"

• "Index" vs "No Index" for external search
  • Global Search = No Index
  • Products = No Index
  • Perspectives Index
  • Historical Presentations - No Index
  • Press Releases = Index
  • Events = Index
• "Hide from Coveo" for internal search
  • Global Search = Hide from Coveo
  • Products = Hide from Coveo
  • Perspectives = Hide from Coveo
  • Historical Presentations = Hide from Coveo
  • Press Releases = Hide from Coveo
  • Events = Hide from Coveo

Testing Coveo

Coveo Backend

• Confirm that Coveo does not have an errors and is running according to schedule
• Verify time of last re-index
• Rebuild the index for the AVEVA Prod production source, if there were code changes or major content changes

Coveo Frontend

Perform the following validations on English and international sites

• Verify metadata using debug tool
  • Look for - @source: "AVEVA Prod"
• Inspect > Network > Headers tab for v2 file
  • Request URL: https://platform.cloud.coveo.com/rest/search/v2?organizationId=osisoftprodqov7t0yy
  • Authentication: Should match correct environment's Search API Key
• Inspect > Network > Payload tab for v2 file
  • organization ID: 
  • searchHub: AvevaAllContent - Prod

AEM Frontend

• Verify interface per guidelines above on the Coveo search pages