Managing Taxonomy Data managing-taxonomy-data

Learn how to manage taxonomy data for using tags with your AEM with Edge Delivery Services sites.

Introduction introduction

Tagging is an important feature that helps you organize and manage your pages. The Tagging Console in AEM allows you to create a rich taxonomy of tags to organize your pages.

These tags are useful not only for you and your authors in organizing your content, but can also be for your readers as well. Tags and their taxonomy can be used in components on the page to help your readers navigate your content.

The Universal Editor works only with the IDs of your tags. By creating a taxonomy page for your content, you expose the descriptions of these tags in all languages to the Universal Editor so it can use that information when rendering content.

Creating a Taxonomy Page creating

A taxonomy is created like any other page in AEM.

The taxonomy page is created. In the Success dialog, you can tap or click Done dialog to dismiss the message or Open to edit the page in the Page Editor.

Take note of the resulting page name of the taxonomy page for use in the following steps.

Editing a Taxonomy Page editing

You start editing a taxonomy page like any other page in AEM.

The page displayed in the Page Editor is read-only because the content of the taxonomy is generated automatically from the selected tag(s) and namespace(s). They act as a kind of filter for automatically generating the content of the taxonomy. Therefore there is no reason to directly edit the page in the editor.

AEM automatically updates the content of the taxonomy page when you update the underlying tag(s) and namespace(s). However you must republish the taxonomy after any change to make those changes available to your users.

Update paths.json for Taxonomy Publication paths-json

Like when managing and publishing tabular data for your Edge Delivery Services site, you need to update your paths.json file of your project to allow publication of your taxonomy data.

This process only needs to be done once per taxonomy page. Once done, you can publish your taxonomy.

Publishing a Taxonomy publishing

A taxonomy is not available to the Universal Editor or your users until it is published.

Taxonomy pages are published like any other page by using the Quick Publish or Manage Publication icons in the toolbar.

You must republish your taxonomy page every time you:

If you create a new taxonomy page you must first add a mapping to it to the paths.json file in your project.

Accessing Taxonomy Information accessing

Once your taxonomy is published, its information can be leveraged by the Universal Editor and made visible to your users.

You can access the taxonomy as JSON data at the following address.

https://<branch>--<repository>--<owner>.hlx.page/<taxonomy-json-name>.json

Use the <taxonomy-json-name> that you defined when mapping your taxonomy to the paths.json file in your project. The taxonomy data is returned as JSON data like in the following example.

{
  "total": 3,
  "offset": 0,
  "limit": 3,
  "data": [
    {
      "tag": "default:",
      "title": "Standard Tags"
    },
    {
      "tag": "do-not-translate",
      "title": "Do Not Translate"
    },
    {
      "tag": "translate",
      "title": "Translate"
    }
  ],
  ":type": "sheet"
}

This JSON data will automatically update as you update the taxonomy and republish it. Your app can programmatically access this information for your users.

If you maintain tags in multiple languages, you can access those languages by passing in the ISO2 language code as the value of a sheet= parameter.