Gretyl's Portal

Heretto Help

Show Page Sections

Taxonomy Metadata

Taxonomy is a system of classification. You can use taxonomy metadata to assign specific values to specific categories. Taxonomy metadata enables content authors to filter and sort for categories of content. Administrators create the categories and values for taxonomy metadata. Users can assign these values to content in the Resource Drawer. At Heretto, we use taxonomy metadata for an Audience category.

To use a taxonomy category as metadata, you associate an existing taxonomy with a metadata category.

Figure 1. Taxonomy Metadata Configuration.

This example from the Metadata interface shows metadata items associated with taxonomies (values fields).

Taxonomy metadata configuration

You can apply configured taxonomy metadata to all file types in the Content Library.

Enabling metadata as a search facet lets users filter items marked with taxonomy metadata in the Content Library.

Figure 2. Filtering Content with Taxonomy Metadata.

You filter items marked with taxonomy metadata by using the Filters pane.

Filtering with taxonomy metadata

Keep the following guidelines in mind when composing taxonomy metadata:

  • You can use the Bulk Change option to apply metadata to multiple files and their dependencies in the Content Library.
  • Apply any new metadata to the existing content in the Content Library, as necessary.
  • Ensure that authors use taxonomy metadata to mark content by enforcing one of the following strategies:
    At Creation
    Every time an Author creates a new topic or map, they assign metadata in the Create new window. Authors may sometimes go back and add additional metadata if they need to apply or modify a term.
    At Approval
    Editors or Managers assign metadata to an entire map and all its dependencies when approving it, using the Bulk Change option.
    At Creation and Approval
    Every time an Author creates a new topic or map, they assign metadata in the Create new window. Editors or Managers review and modify metadata when approving it.
  • Taxonomy metadata ensures that all metadata items used in your organization align with a predetermined classification structure, which is your taxonomy of terms.

Create a Taxonomy

Users assigned the Administrator role in Heretto CCMS can create a taxonomy and populate it with terms.

  1. In the Main Menu in the top-left corner, click Taxonomy.
  2. Click New Taxonomy.
  3. Enter a label for the taxonomy.

    The Label field is the name of the taxonomy and is not visible to users outside of this interface. The Name field is used by the CCMS as a unique identifier and is populated automatically. At this point, you can still modify the value in the Name field. Once you save, you can still modify the label but not the name.

  4. Click Save to create the new taxonomy.
  5. Click the taxonomy to add taxonomy terms.
  6. Click the existing term Unnamed 1 and, in the Label field, give it a meaningful name.

    Once configured, the name you give a taxonomy term in the Label field is visible to other users. The Name field is not editable for existing taxonomy terms.

  7. Click Save.
  8. Right-click the renamed term and do any of the following:
    • To create a new, top-level term, select Create Term Below.

    • To create a child term under the existing term, select Create Narrower Term.

  9. Give the new term a meaningful name. Click Save.
  10. Keep adding new terms as needed.
  11. Once you are satisfied, click Save all changes.

You added a taxonomy in the CCMS and populated it with terms. It is not visible anywhere outside of the Taxonomy interface. You are ready to enable the taxonomy as metadata.

Figure 3. A Category taxonomy with terms in the Taxonomy interface
A Category taxonomy with terms in the Taxonomy interface

Create a Metadata Category for Taxonomy Metadata.

Create a Metadata Category for Taxonomy Metadata

Users assigned the Administrator role in Heretto CCMS can configure taxonomy terms as metadata by associating taxonomy terms with a metadata category. As a result, you will be able to assign that metadata to files and and use it to search for files in the CCMS.

You must first have taxonomy configured. See Create a Taxonomy.

  1. In the Main Menu in the top-left corner, click Metadata.
  2. In the Category Name field, enter a name for the metadata category.

    If you have a number of metadata categories already present, scroll down to see the Category Name field.

    The metadata category is a grouping for your taxonomies and metadata. You can add one or more taxonomies and metadata within a metadata category. The way you set up your metadata categories in the Metadata interface is also how other users see it in the CCMS.

    adding metadata category
  3. Click Add Category.

    A metadata category section is added.

    new metadata category section
  4. Complete the following fields:
    1. In the Label field, enter a label.

      The value you add in the Label field is visible in the Content Library. The Name field is used as a unique identifier by the CCMS and is populated automatically. At this point, you can still modify the name. Once you save, you can still modify the label but not the name.

    2. In the Type drop-down menu, select Taxonomy.
    3. In the Values field, select a taxonomy structure.

      These are the taxonomy terms you want to associate with your metadata category.

  5. Optional: To enable users to select multiple values, check Allow Multiple Selection.
  6. To use the metadata for search filtering in the Content Library, check Search facet.
  7. To enable the metadata so you can use it for search filtering and add it to files, check Enabled.
  8. To prevent this metadata from being added to selected content types, in the Exclude from Content Type field, choose those content types.
  9. Click Add Field, then Save Changes.

Your metadata category should look like this. Note the empty third row (expected).

Figure 4. A metadata category with taxonomy values enabled
A metadata category with taxonomy values enabled

Your metadata is now available in the Content Library in the Search tab and Resource Drawer. You can now apply metadata to files individually or in bulk operations.

Assign Taxonomy Metadata to Files

Assign Taxonomy Metadata to Files

You can add metadata to files individually in the Resource Drawer or to a group of files in a bulk operation. Users assigned the Administrator, Editor/Manager, and Author roles in Heretto CCMS can add metadata to files in the CCMS. Any user can use metadata to browse through files in the CCMS.

You must create taxonomy metadata first. For more information, see Create a Taxonomy.

Note:

Ensure metadata values exist and that Search facet and Enabled are selected for the metadata. Individual metadata categories may be excluded from selected content types through metadata configuration. Ensure that the value you want to set is included for the intended content type. You can configure your metadata in the Metadata interface of the Dashboard.

Add metadata to files individually

  1. In the Content Library, click a file.
  2. In the right pane, scroll down and select the metadata tag from the available options.
    applying exemplary metadata
  3. Close the Resource Drawer to save the changes.
    closing the Resource Drawer
  4. Repeat these steps for any other file you want to add metadata to.

Add metadata to files in a bulk operation

  1. In the Content Library, select the files, folders, or maps you want to modify.

    To select a range of files and folders, select the first file or folder, press and hold Shift, and select the last file or folder in the range.

  2. Right-click the selection and select Bulk Change > Metadata.
  3. If you don't want to include the dependencies of a given map, like its child topics and submaps, clear the Include dependencies check box.
    Important:

    The Include dependencies option only includes the direct dependencies of the map. It does not include binary files (non-text files like images) present in the map.

  4. If you don't want to change the resource-only files in a map, clear the Include resource-only files check box.
    Tip:

    For example, the resource-only files are your warehouse topics that have the @processing-role="resource-only" attribute assigned to their <topicref> elements. They are appended in a map but are not included in the output.

  5. If you want to include all map dependencies, including its indirect dependencies and binary files (non-text files like images), select the Include all dependencies check box.
  6. Select the check box next to the metadata category you want to modify.
  7. In the Action drop-down menu, select one of the following options:
    OptionDescription
    Add to existingMetadata tags are added to the selected files.

    Existing metadata values remain applied.

    Clear fieldAll metadata tags in the selected files are cleared.
    Replace all withAll metadata tags in the selected files are cleared and replaced with the new tags.
    Find and remove theseSpecified metadata tags are removed from the selected files.
  8. In the Metadata drop-down menu, select the metadata to apply the selected action to.
  9. Click Save.

Your files now have metadata assigned to them. You can view the metadata for a file by clicking the file and scrolling down in the Overview tab of the Resource Drawer. From there, you can also expand the API Info view and click REST URL to view all metadata for a file.

Delete a Taxonomy

Administrators can delete taxonomy structures that you no longer need.

  1. In the Main Menu in the top-left corner, click Taxonomy.
  2. Click the X button beside the taxonomy you want to delete.
  3. Click Delete.
    Warning:

    If a deleted taxonomy is linked to taxonomy metadata, metadata values applied to your files will be lost. Values applied in taxonomy-driven attributes are preserved.

Delete a Metadata Category

You must be an Administrator to access the Administration interface in the Dashboard

  1. In the Main Menu in the top-left corner, click Metadata.
  2. Click Delete next to the metadata category you no longer need to open the Delete category window.
  3. Click DELETE and the window closes.
  4. Click Save Changes to apply the deletions of the category.
    Warning:

    Once metadata category is deleted, metadata values applied to your files are lost. Therefore, you can consider disabling given metadata instead by unchecking the Enabled check box and saving changes.