Skip to main content

The Manage Taxonomy Templates Window

In the Manage Taxonomy Templates window in the CDM Extension Taxonomy Editor, you can view and modify taxonomy templates.

To open the Manage Taxonomy Templates window:

  1. Click the Home tab, then in the Navigation Pane, click Manage Taxonomies.
  2. In the Manage Taxonomies window, click Templates.

A taxonomy template contains the following information:

  • Schemas that are imported as direct (is required for taxonomy generation) and supplemental (is used as a reference, is non-discoverable, and is not used for taxonomy generation).
  • Linkbases that are referenced as direct or as supplemental.
  • New relationship groups to build by default.

The Taxonomy Templates section contains a list of all taxonomy templates, each with the following information:

  • Name
    A unique name that is given to the taxonomy template.
  • Description
    A description of the taxonomy template.
  • Family
    The family to which the taxonomy template belongs.
  • Version
    The version of the taxonomy template.

Note: These fields are editable.

The Template Data section displays information that is contained in a taxonomy template. Select a taxonomy template in the Taxonomy Templates section to display information on the following tabs:

  • The Schema Imports tab displays imported links for a taxonomy template that is selected in the Taxonomy Templates section. It lists schemas that are used to decide what information is defined in a taxonomy and reference linkbases. This tab has the following sections:
    • Direct
      Lists schema URIs that are required for taxonomy generation.
    • Supplemental
      Lists schema URIs that are referenced as additional information that you can use. This information is not discoverable and cannot be used for taxonomy generation.

    These sections have the following columns:

    • Schema URI
      The URI location for a schema that is included in taxonomy template that is selected in the Taxonomy Templates section.
    • Namespace
      The namespace of the file as defined in the schema that is displayed in the Schema URI column. This field is read-only.
    • Period
      The period of the file as defined in the schema that is displayed in the Schema URI column. This field is read-only.
    • Prefix
      The prefix of the file as defined in the schema that is displayed in the Schema URI column. This field is read-only.

    To add a schema, enter a valid URI in the Schema URI field, select whether the schema is direct or supplemental, and click Add. The schema is added to the Schema Imports tab.

    To move a schema from the Direct section to the Supplemental section or from the Supplemental section to the Direct section, select a schema and click Up or Down to move it to the other section.

  • The Referenced Linkbases tab displays a list of linkbases for a base taxonomy that is referenced by a taxonomy template selection. You can modify the linkbases as needed, as either direct or supplemental. The linkbases can be modified as the user needs, as a direct or supplemental.
  • The Default Relationship Groups tab displays a list of the default relationships groups that are created upon taxonomy generation using the taxonomy template that is selected in the Taxonomy Templates section. You can change the information that is displayed for any existing relationship group information by clicking in a cell of any row and editing the information. You can also add a default relationship group by populating an empty row with information and clicking OK.
  • In the Relationship Group Formatting tab, you can use the following fields to perform various tasks for the relationship groups included in the taxonomy template that is selected in the Taxonomy Templates section:
    • Include Type
      Select this checkbox to include or exclude Type as a value in the Description Format String field.
    • Include Sequence
      Select this checkbox to include or exclude Sequence as a value in the Description Format String field. Including a sequence value allows for easier navigation in a generated instance document.
    • Number of Sequence Digits
      Use this list to select the number of digits that represent the sequence in the Description Format String field.
    • Description Format String
      Displays the structure of the Relationship Group description that is being used for the extension.
    • Output Preview
      When you click Preview, this field displays a preview of the Relationship Group Description based on your selections.
    • Preview
      Displays a preview of the Relationship Group Description in the Output Preview field, based on your selections for the Description Format String field.
    • Restore
      Used to reset the Description Format String field to its original values.

Was this article helpful?

We're sorry to hear that.