Skip to main content

Tuple Tags

A tuple is an XML structure that is used to group concepts in an XBRL taxonomy that must be understood together. When a taxonomy that contains tuples is used with your project, you can use CDM XBRL to link information in your Excel or Word object to tuples in your taxonomy.

For example, a tuple called Director might contain simple elements called firstname and lastname. If the name information appears in a report object in CDM XBRL, you can link the information in the report object to the tuple elements by creating tuple tags.

You can use CDM XBRL to add and delete tuple tags in Excel objects, Word objects, and footnotes. You can also hide tuples so that they do not appear in the list of tuples in your Tuple Explorer.

Add a Tuple from the Taxonomy

If a particular tuple exists in your taxonomy, but you cannot see it in the user interface in CDM XBRL. It might be hidden. You can use CDM XBRL to add it to the user interface.

To add a tuple from the taxonomy:

  1. Open the project that you want to work with.
  2. In the Data Tools area on the ribbon, click Tuple Explorer.
  3. Above the Tag Inspector tab, click Tuple Explorer.
  4. In the Tuple Explorer, click Instance Document to expand the hierarchy and to see the tuples in your project.
  5. If you cannot see the tuple that you need, click the Instance Document node, click Add, and then click the tuple that you want to add.
  6. Depending on your taxonomy, you might be able to add additional instances of a tuple. For example, if you have a Director tuple, and there are three directors in your company, you might be able to add two additional instances of the Director tuple. To create an additional instance of a tuple, right-click the Instance Document node and select the tuple that you want to add; to add an additional instance of a nested tuple, right-click the parent tuple. If your taxonomy allows additional instances of the child tuple, the Add icon is available. Click Add and then select the child tuple that you want to add.

Add a Tuple Tag to an Excel/Word Object

You can use CDM XBRL to add a tag to a tuple in your taxonomy. The source of the data can be an Excel object or a Word object.

Before you can work with tuples in CDM XBRL, at least one XBRL project must be created for your report. A project consists of a report and a taxonomy, and the taxonomy associated with your project must contain tuples.

To add a tuple tag to an Excel or Word object:

  1. Open the project that you want to work with.
  2. In the Data Tools area on the ribbon, click Tuple Explorer.
  3. Above the Tag Inspector tab, click Tuple Explorer.
  4. In the Tuple Explorer, expand the hierarchy of Instance Document so that you can see the tuple groupings in your project. Continue to expand the hierarchy to see individual tuples and their associated elements. Depending on the structure of your taxonomy, some of your groupings might contain nested groupings, as indicated by the plus sign icon beside the name of the grouping. Continue to expand the hierarchy for these groupings to see nested tuples.

    Tip: If you can't find the tuple that you need, it might have been hidden. You can add a tuple from the taxonomy so that it is visible in the Tuple Explorer again.

  5. Open and check out the Excel or Word object that contains the data that you want to link to a tuple.
  6. In the report object, highlight the data that you want to associate with a tuple element. Make sure that the type of data that you select in the Excel or Word object matches the type of data associated with the tuple element that you plan to select. For example, if the tuple element type is monetary, you must select monetary data in the Excel or Word object.
  7. In the Tuple Explorer, select the element of the tuple that will be the target for the tag.

    Tip: To ensure that you select the correct tuple, hover your cursor over the name of the tuple. You can see the element ID, its type, and other helpful information.

  8. To create the tuple tag, complete the following steps:
    1. Click Tag.
    2. Complete the fields in the Tuple Tag wizard. Select a transformation set, if necessary. For example, if you are tagging a monetary value, you might want to scale your value to millions.
    3. The Preview area contains a view of the data as it will appear. If necessary, make changes in the Data area.
    4. Click Finish. In the Tuple Explorer, the tag is visible in the selected element.
  9. In the Tag Inspector tab, beside Show all tags in the following location, select Project, Data Area, Data Area Selection, Report Object, or Report Object Selection. You can see details of your new tag in the location that you selected.
  10. Click the report object, click the Report Object tab in the Report Object Tools area on the ribbon, then click Save in the tab to save your changes.
  11. Check in the report object.

Hide a Tuple

If you do not plan to use a particular tuple, you can use CDM XBRL to hide it. The tuple will still exist in your taxonomy, but it will no longer be visible in the user interface, and will therefore not appear in the output instance document.

To hide a tuple:

  1. Open the project that you want to work with.
  2. In the Data Tools area on the ribbon, click Tuple Explorer.
  3. Above the Tag Inspector tab, click Tuple Explorer.
  4. In the Tuple Explorer, click Instance Document to expand the hierarchy and to see the tuples in your project.
  5. Right-click the tuple that you want to hide. You cannot hide a tuple that has a tag attached to it.

    Tip: To ensure that you select the correct tuple, hover your cursor over the name of the tuple. You can see the element ID, its type, and other helpful information

  6. Click Delete.

    Important: A confirmation window does not appear when you click Delete. The tuple disappears from the user interface but it still exists in your taxonomy. If you did not mean to hide the tuple, click Add and select it from the list to make it visible again.

Add a Footnote to a Tuple Tag

Your Excel and Word objects might contain data or text that you want to use as a footnote to a tuple tag. You can use CDM XBRL to create a new footnote for a tuple tag, or to add an existing footnote to multiple tuple tags.

Before you can work with tuples in CDM XBRL, at least one XBRL project must be created for your report. A project consists of a report and a taxonomy, and the taxonomy associated with your project must contain tuples.

To add a footnote to a tuple tag:

  1. Open the project that you want to work with.
  2. In the Data Tools area on the ribbon, click Tuple Explorer.
  3. Above the Tag Inspector tab, click Tuple Explorer.
  4. In the Tuple Explorer, click Instance Document to expand the hierarchy and see the tuples that are available in your project.
  5. Find an existing tuple tag that you want to add a footnote to.
  6. To create a new footnote for a tuple element, complete the following steps:
    1. Open and check out the Excel or Word object that contains the source content for the new footnote.
    2. In the Excel or Word object, highlight the data that you want to use for the footnote. In an Excel object, you must select only one cell.
    3. In the Tuple Explorer, click the element that contains the tuple tag that you want to add the footnote to. You can use Search to find the appropriate location.
    4. Click the Home tab and then click Add Footnote > From Current Object Selection. A number appears in the tuple element, indicating the new footnote. You can see the content of the new footnote in the Tag Inspector tab.
  7. To reuse a footnote from another location, complete the following steps:
    1. In the Tuple Explorer, click the element that contains the tuple tag that you want to add the footnote to. You can use Search to find the appropriate location.
    2. Click the Home tab and then click Add Footnote > From Existing.
    3. In the list that appears, select the footnote content that you want to reuse. A number appears in the tuple element, indicating the new footnote. You can see the content of the new footnote in the Tag Inspector tab.
  8. Click the report object, click the Report Object tab in the Report Object Tools area on the ribbon, then click Save in the tab to save your changes.
  9. Check in the report object.

Delete a Footnote from a Tuple

If you no longer need a footnote that is attached to a tuple, you can use CDM XBRL to delete it.

Important: If you delete a footnote from a tuple, you cannot undo your action. Proceed with caution.

To delete a footnote from a tuple:

  1. Open the project that you want to work with.
  2. In the Data Tools area on the ribbon, click Tuple Explorer.
  3. Above the Tag Inspector tab, click Tuple Explorer.
  4. In the Tuple Explorer, click Instance Document to expand the hierarchy and see the tuples that are available in your project.
  5. Find the tuple tag that contains the footnote that you want to delete.
  6. Click Delete Footnote and then complete one of these actions:
    • To remove the footnote and all links with any facts, in the Tuple Explorer or anywhere else, select one or more footnotes in the Footnotes tab and select Delete the selected footnote and all links.
    • To remove any links that the footnotes have with any facts in the current view, select one or more footnotes in the Footnotes tab and select Unlink the selected footnote from the current view. If there are no other links, the footnotes are also removed.
    • To remove the links between the selected footnotes and any facts within the selection, select one or more footnotes in the Footnotes tab. Then, select Unlink the selected footnote from the selected items. If, after this operation, there are any footnotes that are no longer linked to any facts in the Tuple Explorer or anywhere else, the footnotes are also removed.

Delete a Tuple Tag

If you no longer need a tuple tag, you can use CDM XBRL to delete it.

Important: If you delete a tuple tag, you cannot undo your action. Proceed with caution.

To delete a tuple tag:

  1. Open the project that you want to work with.
  2. In the Data Tools area on the ribbon, click Tuple Explorer.
  3. Above the Tag Inspector tab, click Tuple Explorer.
  4. In the Tuple Explorer, expand the hierarchy of Instance Document so that you can see the tuple groupings in your project. Continue to expand the hierarchy until you can see the tuple element that contains the tag that you want to delete.
  5. Open and check out the Excel or Word object that contains the source data for the tag that you want to delete.
  6. In the Tuple Explorer, right-click the tuple tag that you want to delete.

    Tip: To ensure that you select the tag for the correct tuple, hover your cursor over the name of the tuple. You can see the element ID, its type, and other helpful information.

  7. Click Delete. Alternatively, find the tuple tag in the Tag Inspector tab and then click Delete.
  8. In the confirmation window that opens, click Yes to delete the item.
  9. If the report object associated with the tag is not checked out, a confirmation window opens. Click Yes to check out any associated report objects, allow the system to update them, and check them back in.

The tuple that you selected is added to the end of the list of tuples in the Tuple Explorer.

Was this article helpful?

We're sorry to hear that.