Expand my Community achievements bar.

Adobe EDS - Does helix-query.yaml in project repository still works?

Avatar

Level 2

Adobe EDS - Does helix-query.yaml in project repository still works?

Hello!

 

My project has been created using Aem Boilerplate XWalk

If I understood correctly. If 'helix-query.yaml' is present on repository then no spreadsheet sitemap configuration would be necessary on AEM.

 

The following helix-query.yaml was wrote:

 

version: 1

indices:
  portuguese: &default
    include: /home
    target: /query-index.json
    properties:
      title:
        selectFirst: head > meta[property="og:title"]
        value: attribute(el, "content")
      lastModified:
        select: none
        value: parseTimestamp(headers["last-modified"], "ddd, DD MMM YYYY hh:mm:ss GMT")
      robots:
        select: head > meta[name="robots"]
        value: attribute(el, "content")
      validation:
        select: none
        value: true

 

When debugging locally with 'aem up --print-index', it seems to be working.

 

info: Index information for /home
info: Index: portuguese
info:          title: "Home"
info:   lastModified: ""
info:         robots: ""
info:     validation: true

 

But there is no change when accessing "https://{branch}-{repo}-{organization}.aem.page/sitemap.xml" or "https://{branch}-{repo}-{organization}.aem.page/query-index.json".

"https://{branch}-{repo}-{organization}.aem.page/helix-query.yaml" returns 404.

 

Maybe I didn't understand the concept correctly, should I just use AEM Admin API?

 

Thank you for your patience,

Gabriel

 

Topics

Topics help categorize Community content and increase your ability to discover relevant content.

3 Replies

Avatar

Employee Advisor

Hello @gabrielfgmzk ,

 

Have you published a page since you setup the sitemap?

Avatar

Level 5

Hi @gabrielfgmzk ,

 

helix-query.yaml does not work in EDS anymore.
It is only used by the local development simulator (aem up) to help you test indexing.
The real EDS runtime does not load or publish this file, so:

  • /helix-query.yaml returns 404
  • /query-index.json does not update
  • /sitemap.xml does not change

In EDS, indexing must be configured through:

AEM Admin UI > Search & Indexing

or

AEM Admin API (the recommended approach)

These replace the old helix-query.yaml behavior.

So yes - you still need Admin indexing configuration even if your local aem up --print-index looks correct.

 

Thanks

Avatar

Employee

Hello @gabrielfgmzk 

Have you fully migrated this site to Helix 5 config service?

  • If you’re still on the old Helix 4 setup, then helix-query.yaml in your repo does still work and is the right place to define indices. If query-index.json isn’t showing up, we should look at branch, paths.json / mappings, and whether the relevant pages are actually published.

  • If you’re on Helix 5, then the source of truth is the config service.
    In that case you should move your index/sitemap config into the site config and then remove the old Helix 4 config files (including helix-query.yaml, helix-sitemap.yaml, config.xlsx, headers.xlsx, fstab.yaml, etc.) per the below "Remove unused configuration files" guidance :

https://www.aem.live/docs/config-service-setup#remove-unused-configuration-files


Keeping them around could lead to the unexpected rollback behavior you saw.