How-to: Build a taxonomy using a template

Owned by Braden MacDonald
Last updated: Sept 27, 2024 by Sarina Canelake
4 min read

This has been migrated to https://docs.openedx.org/en/latest/educators/how-tos/content-tagging-how-tos/build_taxonomy_using_template.html - this wiki page is now locked.

 

Please backlink this article into the Redwood Release Notes (under Taxonomy Import & Updates) when put into RST on the docs site

Building a taxonomy using a template

Tags that can be applied to content are organized into hierarchical taxonomies. Currently, the only way to create or modify a taxonomy is by uploading a CSV or JSON file.

The simplest type of taxonomy is a flat taxonomy that doesn’t have any hierarchy - see “How-to: Create a flat taxonomy by uploading a CSV” for a simpler procedure to create such a flat taxonomy. For the purposes of this guide, we’ll assume you want to create a taxonomy of cities, like this:

  • United States

    • California

      • Los Angeles

    • New York

      • New York City

  • Mexico

    • Mexico City

 

  1. First, review your proposed taxonomy. Note that each tag must have a unique name (across all levels of the hierarchy). So, for example, we could not have “New York” as both a second-level (state) tag and third-level (city) tag - we have to rename one of them (e.g. “New York City” in this case)

  2. Navigate to Studio Home > Taxonomies. You should see Download Template in the top right. Click on that button, then select “CSV template”.

  3. A file will download automatically. Open it using any spreadsheet application (Excel, Numbers, Google Sheets, etc.).

  4. It should look like this:

     

  5. Select and delete all of the entries except the first row, which contains the headings.

Create the first tag

  1. Now, you can start to enter the tags that make up the taxonomy. The order doesn’t really matter, except that any tags which come “below” another tag should also be below/after it in the spreadsheet. For our example taxonomy, we shouldn’t put “California” before “United States”, because the “California” tag is below (is a child of) the “United States” tag.

    Each row in the spreadsheet corresponds to one tag. To create the “United States” tag from our example, we’ll put “1” for the ID and “United States” for the value:

    For a tag like “United States” which is a “root” tag in the taxonomy, we leave “parent_id” empty. We can also leave “comments” empty.

    Choosing an ID: The “id” column is required, but its exact value is not particularly important at this stage. The main requirement is that each row (each tag) has a unique ID. (Though remember that the “values” of each row also must be unique.) For learning purposes, feel free to use numbers like 1, 2, 3, 4 as the IDs. You could also just make the “id” the same as the “value” (i.e. put “United States” as both the ID and the value), or make up a short ID like “USA”. To understand more, and learn how IDs play an important role when updating the taxonomy, please read https://openedx.atlassian.net/wiki/spaces/OEPM/pages/4198891806 .

Creating “child” tags

  1. Now, to add the “California” tag, we put it in the next row. Let’s give it the ID “2” and put the value as “California”. Now, because we want this tag to be a “child” of the “United States” tag in our taxonomy, we also need to set the parent_id field. In this case the parent is “United States”, which we gave the ID 1, so we’d put 1 as the parent_id, like this:

     

  2. Likewise, to create “Los Angeles” as a child tag of “California”, we need to give it an ID (say, 3), and set its parent ID to the ID we gave to “California” (in this case, 2).

    So far, this would result in the following taxonomy:

    • United States

      • California

        • Los Angeles

  3. Now, continue to add the rest of the tags. You can put notes in the “comments” column if you want; that column and any other columns besides “id”, “value”, and “parent_id” are ignored by the system during import.


     

  4. Save the spreadsheet using the default format (e.g. .xlsx), in case you want to edit it later.

  5. Export the spreadsheet to a CSV file.

    1. In Excel, use File > Save As…, and set the “File format” to “CSV UTF-8 (comma-delimited) (.csv)” (preferred) or “Comma Separated Values (.csv)” then enter a filename and save it.

    2. In Google Sheets, use File > Download > Comma Separated Values (.csv).

    3. In Numbers, use File > Export To > CSV… and use the default options.

  6. Import your taxonomy following the How-to: Import and export a taxonomy guide.