Skip to main content

Relationship Groups for Extension Taxonomies

A relationship group is a set of relationships between XBRL concepts. A relationship group is defined as a role in the XBRL Specification. You can use the CDM Extension Taxonomy Editor to create and edit relationship groups for an extension taxonomy.

You can use relationship groups, also known as roles, to configure element properties and validate your taxonomy.

Create a Relationship Group

  1. Open the extension taxonomy you want to work with.
  2. In theRelationship Groups tab, click the Add Relationship Group icon Add Relationship Group Icon in the icon panel. A blank row is added.
  3. In the blank row, enter the description of the relationship group in the Description column, and press Enter. The relationship group URI is added to the Preview column.
  4. If you want a different relationship group type, change the value in the Type column.
  5. To display the relationship group in the Primary Items and Dimensions panes, select the checkbox in the Display column.

The relationship group is created and automatically checked out, as indicated by a lock icon beside it in the Relationship Groups tab and in the Primary Items and Dimensions panes. You are the only user that is allowed to modify the relationship group until you check it back in when you save the taxonomy.

Create a Relationship Group and Bind It to a Cell in an Excel Object

You can use the CDM Extension Taxonomy Editor to create a relationship group for a taxonomy, and bind it to a cell in an Excel object.

  1. Open the report you want to work with.
  2. Open the extension taxonomy.
  3. In the Relationship Groups tab, click the Add Relationship Group icon Add Relationship Group Icon. A blank row is added.
  4. In the blank row, enter the description of the relationship group in the Description column, and press Enter. The relationship group URI is added to the Preview column, and the value in the Type column is set to Statement.
  5. Open and check out the Excel object you want to work with.
  6. Select the cell in the Excel object that you want to bind this relationship group to, and select Bind To Cell. The Description and Preview columns update to reflect the text from the Excel cell.
  7. If you want a different relationship group type, change the value in the Type column.
  8. To display the relationship group in the Primary Items and Dimensions panes, select the checkbox in the Display column.

Check Out a Relationship Group

You can check out a relationship group to control and modify a taxonomy in a multiuser environment.

A Check out icon Checkout icon indicates that the relationship group is checked out by you. A Locked icon Locked Icon indicates that the relationship group is locked by another user.

With an extension taxonomy open, you can check out a relationship group using any of the following methods:

  • In the Relationship Group tab, right-click a relationship group and click Check out.
  • In the Relationship Group tab, select a relationship group and click the Check out icon Check Out Icon in the icon panel.
  • In the Primary Items pane, right-click a relationship group and click Check out.
  • In the Dimensions pane, right-click a dimension and click Check out.

Delete a Relationship Group

If you no longer need a relationship group, you can delete it.

Deleting a relationship group removes that relationship group from the CDM Extension Taxonomy Editor.

Important: If you delete a relationship group, you cannot undo your action. Proceed with caution.

To delete a relationship group:

  1. Open the extension taxonomy you want to work with.
  2. In the Relationship Groups tab, highlight the row or press CTRL/SHIFT to select multiple rows.
  3. Click the Check out icon Check Out Icon to check out the selected relationship groups.
  4. Press Delete or click the Delete Relationship Group icon Delete Relationship Group Icon. A prompt is displayed to confirm the deletion.
  5. Click No to cancel the deletion or click Yes and the rows are deleted and the table refreshes to reflect the change.

Was this article helpful?

We're sorry to hear that.