Taxonomy Plugin Configuration

Installation

You can add the Taxonomy plugin to your project using the Essentials setup application.

Prerequisites

Steps

  1. In Essentials, add the Taxonomy feature to your project.
    Essentials Taxonomy feature page with Install feature button
  2. Rebuild and restart your project.

Configuration

  1. In Essentials, go to Installed features.
  2. Locate Taxonomy and select the Configure button.
    Taxonomy feature card with Configure button in Essentials
  3. To create a new taxonomy, enter a name and select the locales to include.
    Taxonomy creation form with name field and locale checkboxes
  4. Select the Create new taxonomy button.

After creating the taxonomy, the configuration tool displays the option to add the taxonomy to your document types. Proceed with this step only if you are using version 15.2.

If you are using version 15.3 or newer, skip this step and use the Document Type Editor to add a taxonomy field as described in the next section.

Add Taxonomy to Document Type (Taxonomy Field Type)

Info: The taxonomy field type is available in brXM 15.3.0 and later.

For version 15.3 or newer, use the CMS to add a taxonomy field to your document type.

  1. Log in to the CMS as an administrator.
  2. Open the Content application and select Document types from the dropdown in the top left.
    Content app dropdown showing Document types option
  3. Navigate to the document type where you want to add a taxonomy field and open it in the editor.
  4. Under Primitive Field, select Taxonomy to add a taxonomy field.
    Primitive Field menu with Taxonomy option selected in editor
  5. In the taxonomy field's properties, set the taxonomy.name property to the URL name of your taxonomy.
    Document editor showing taxonomy field properties and taxonomy.name value
  6. Click Done, then select Type actions and choose Commit.

Add Taxonomy to Document Type (Legacy Taxonomy Mixin)

In version 15.2 or earlier, use the legacy mixin-based taxonomy field. This approach remains supported for backward compatibility.

Continue in the Essentials Taxonomy configuration tool:

  1. Select the document types where you want to add taxonomy, and choose the taxonomy to use.
    Taxonomy configuration screen with taxonomy selection for document types
  2. Click the Add taxonomy to documents button.
  3. Use the BeanWriter tool to regenerate the content beans for the document types you updated.

Manage Taxonomy

You can manage taxonomies in the Content application under the Taxonomies section.

Taxonomies editor showing exampletaxonomy category tree in Bloomreach XM

When editing documents that use a taxonomy, select categories using the taxonomy picker dialog.

Taxonomy picker dialog with category tree and selected terms

Info: To access taxonomy data from the delivery tier, see Taxonomy Plugin Delivery Tier Configuration.

Share Feedback
Page: /build/plugins/taxonomy/configuration
Section: Build
Category *