Sap Taxonomy Designer - dm10 - TD - en
Sap Taxonomy Designer - dm10 - TD - en
7 Understanding Properties. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 46
7.1 Extended Link Properties. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 46
7.2 Concept Properties. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 46
7.3 Tuples Properties. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 49
Taxonomy Designer offers two different modes of creating the XBRL files:
1. Entry-based: The taxonomist creates a taxonomy step by step, which gives comprehensive control over the
created XBRL taxonomy.
2. Wizard-based: The taxonomist uses a wizard to create a taxonomy. The wizard makes use of conventions and
prepared import files to generate extension taxonomy files that can be customized. The wizard supports
FASB/US GAAP and IFRS filers.
Taxonomy Designer includes a suite of robust creation, editing, mapping, validation, analysis, and reporting tools
for managing complex taxonomies, both with single and in-reference taxonomy usage patterns and validation
capabilities.
Taxonomy Designer provides the fundamental and comprehensive functionality required to create, exchange,
consume, and manage large numbers of XBRL instance documents and taxonomies. Core fundamental features
include:
● Complete support for XBRL 2.1, as well as for XBRL legacy versions (2.0, 2.0a, and 1.0).
● A fully-conforming XBRL processor, as defined by XBRL 2.1 specification, passing the 275 tests within XBRL
International Specification 2.1 conformance suite.
● Support for the Financial Reporting Taxonomies Architecture 1.0 best practices for building financial
reporting taxonomies or any taxonomy, which chooses to follow this architecture recommendation.
● The ability to create and edit sophisticated taxonomies, such as the International Financial Reporting
Standards (IFRS) and United States Financial Reporting (USFR) frameworks.
● Integrated instance document creation, taxonomy creation and extension, and validation environments
enabling the creation and management of robust extension taxonomies, leveraging the full power of the
extensibility aspect of XBRL.
● The ability to create, edit, and read XBRL instance documents and taxonomies.
● The ability to edit taxonomies and instance documents simultaneously.
● XML Schema 2.1, XBRL, and best practices validation to ensure the documents and data you are reading are
proper XBRL and follow the business rules of your organization or domain and best practices for working with
XBRL.
● Creation and execution of business rules (semantic validation) to ensure the data you are creating or
consuming are valid.
● Robust mapping, import, and export functionality to migrate your source data into XBRL, and then back into
your applications’ format.
● Productivity features and tools to help navigate through and effectively manage and edit large 4000+ element
taxonomies.
2.1 Workspace
● Menu bar
● Toolbars
● Content areas or panes
A taxonomy editing session can have a workspace layout organizing panes into groups. Panes can be resized or
floated to best suit the workspace you would like to create.
For example, you could have the Presentation view and the Dimension view in one tab group, the Calculation view
in a separate group, the Properties and DTS views in a tab group, and theConcept, Messages, and Find Results in
another tab group.
An instance document editing session can have a workspace layout that includes the Presentation view, the
Instance Grid, the DTS view , and the Concept details in a tab group with Messages and Find Results.
2.2 Menus
The menus in Taxonomy Designer contain both familiar and specialized commands. Some menus and commands
are available only in certain circumstances. Taxonomy Designer provides the following menus:
● File menu – Provides access to features related to files and discoverable taxonomy set (DTS) operations, see
File Menu [page 6]
● View menu – Provides access to the features related to various panes such as the linkbase information
windows or property windows, which can be opened in the workspace, see View Menu [page 7]
The File menu contains the following commands, used for manipulating files and the discoverable taxonomy set
(DTS):
The View menu is only active after you have created or opened a taxonomy or instance document. Once you have
created or loaded an XBRL document, depending on the properties of those files, more choices are available on
the View menu.
● Add Tree View (Presentation, Calculation, Dimensions, Tuples, DTS): Adds a tree-type view of the selected
type.
● Add Tree View (Other Relations): Opens a dialog box where you can choose the arcrole for the tree view
display.
● Add Grid View (Presentation, Calculation, Dimensions, Concepts, Instance, Instance Multi-Dimensional,
Formula Compiled, Formula Arcs Resources, Formula Aspects, Formula Editor): Adds a grid-type view of the
selected type.
● Add Grid View (Other Relations): Opens a dialog box where you can choose the arcrole for the grid view
display.
● XML: When a document is selected from the DTS View, View XML shows the XML for the entire document.
When a concept is selected, the View XML command will goes to the definition of that concept in the schema.
● Toggle View Sync: Selecting this option causes the application to keep views in sync, moving the selection to
the highlighted concept in other panes.
The Tools menu provides a selection of commands that can be run against documents and helps you configure
the application.
● SEC No Checks: Build the taxonomy without checking for compliance with the EDGAR Filing Manual.
● SEC EX-100 Checks: Build the taxonomy with automatic checking for reference to a US GAAP taxonomy and
compliance with the EX-100 EDGAR Filing Manual Chapter 5 rules (voluntary filers).
● SEC EX-101 Checks: Build the taxonomy with automatic checking for reference to a US GAAP taxonomy and
compliance with the EX-100 EDGAR Filing Manual Chapter 6 standards (mandatory filers).
● Validate XBRL: Checks that the XBRL document is XML and XBRL compliant.
● Validate Calculations: Executes XBRL Calculations on an XBRL instance document ensuring that the data
reported is consistent.
● Validate Formulas: Validates that the XBRL formulas are well formed and the associated XBRL is valid.
● Generate Sample Instance: Creates a sample instance document from the taxonomy that is currently open.
● Generate Linkbases XBRL-US, Generate Calculation Linkbase: Creates a calculation linkbase based upon the
XBRL presentation view.
● Generate Linkbases XBRL-US, Generate Dimension Linkbase: Creates a dimension linkbase based upon the
XBRL presentation view, inferring the necessary hypercubes, dimensions, and dimensional members.
● Wizards Edgar Extension Taxonomy: Opens the EDGAR Extension Taxonomy wizard to walk through the
workflow of creating a taxonomy extension, see Creating an Extension Taxonomy Using the Wizard [page
27].
● Web Cache Work Offline: The application does not attempt to refresh Web-linked files. If a file is available in
the Web cache it is used.
● Web Cache Explore: Opens the application's Web cache directory in a Windows Explorer window.
● Web Cache Clear: Deletes all files from the Web cache directory.
The Windows menu is an alternate way to select one of the windows that is open in the interface.
<WindowName - <prefix>>: The Windows menu lists each pane that is currently open in the interface.
The following standard Windows keyboard shortcuts are available in Taxonomy Designer.
Shortcut Command
CTRL + P Print (print dialog varies based on taxonomy or instance view that has the current
focus).
2.4 Icons
Icons show you the data type of taxonomy concepts in a graphical form. Some icons are context-specific and do
not always appear. The following table provides an overview of the icons used for Taxonomy Designer.
Prohibited The drag and drop operation that you are attempting is not per
mitted
Other Other
Shares Shares
View Icons These icons are used in tree and grid views to show the type of
link or file
External link Shows the root of the loaded taxonomy (with a targeted role, if
applicable)
URL URL
2.5 Views
The Discoverable Taxonomy Set (DTS) pane shows the relationships between elements in the taxonomy, or
taxonomies that make up the discoverable taxonomy set. The default relationship view shows presentation
relationships between elements in the loaded taxonomy using the standard labels for element names. You select
alternate views from the View menu:
The Discoverable Taxonomy Schema (DTS) view shows the relationships between the taxonomy schemas,
linkbases, and other related XBRL files loaded in Taxonomy Designer. Nodes in the tree can be expanded or
collapsed as needed.
You can use Taxonomy Designer to view the entire URI of any item listed in the DTS or to view the XML.
When you navigate through your taxonomy's elements, it is advantageous to have the information in one pane
reflect the selection in another pane. For instance, if you click on a concept in Presentation view, it is helpful if the
Concepts tab is updated to reflect your selection.
Taxonomy Designer synchronizes views by default, but you can turn view synchronization off. To toggle the view
synchronization, click View Toggle View Sync .
2.6 Properties
Every element in a taxonomy or instance document has properties associated with it. The Properties view shows
you the values for all assigned or required attributes for any selected element.
To open a context menu in Taxonomy Designer, right-click in a field or pane. The context menus differ depending
on the part of the interface you are currently using.
In the header for each pane, right-click to open the context menu. It offers the following functions:
Floating Makes the pane float and allows you to dragged outside the main application window.
Dockable Makes the pane dockable and allows you to drag it around the main application window
and then drop it to dock it within the program
Tabbed Makes the pane tabbed and allows you to stack a pane with others
Auto Hide Makes a floating pane hide if it is not in use; a small tab at the edge of the screen shows
the hidden pane and can be clicked to reopen the pane
Hide Hides the pane; a small tab at the edge of the screen shows the pane. Click it to open
the pane.
On any tab, right-click to open the context menu. It offers the following functions:
Close All But This Closes all panes except for the selected pane
Floating Makes the pane float; the pane can then be dragged outside the main application win
dow
Dockable Make this pane dockable; drag it around the main application window and then drop it
to dock it within the program.
When you work with Taxonomy Designer, the system displays status messages in the Console pane. These
messages can be viewed on screen, saved to a file, or copied to the clipboard. You can also clear the console.
○ If you select Save, the Save as a text file dialog box opens. Browse to the desired location, enter a name
for the messages text file, and choose Save.
○ If you select Copy, the messages are copied to your clipboard. You can paste them into any other
application.
The system displays error messages in the Messages pane. These messages can be viewed on screen, saved to a
file, or copied to the clipboard. You can also clear the messages.
Each message includes the date/time stamp (Recorded), the URI of the message which represents an error code
(Message URI), the type of error (Error Category), the Error type, and a message detailing the issue that caused
the message. If localized versions of the messages are available, the messages are displayed in the language
indicated by the application locale.
○ If you select Save, the Save as a text file dialog box opens. Browse to the desired location, enter a name
for the messages text file and choose Save.
○ If you select Copy, the messages are copied to your clipboard and you can paste them into any other
application.
To clear messages
You use the Search function to find a string within labels and names for all concept and relationship views or
within labels, names, or values in instance documents. Especially when the discoverable taxonomy set contains
many elements, this can be much faster than looking for a concept in a taxonomy view.
You can configure many aspects of the display fields and unit types used in Taxonomy Designer using the
Preferences dialog box, available on the Tools menu.
Item Value
Default language Language for the user interface -- this defaults to the language set in Windows; changing
it here does not change the operating system or other applications.
Locale Sets the language to use for XML resources (references, roles, labels, and footnotes).
XBRL URLs Menu Defines the Web menu for File Open Web shortcuts displayed after clicking the XBRL
button.
Tree Control Style Controls how trees are displayed (TreeView (the default) or TreeGrid).
Instance Control Style Controls how instances are displayed (FactsGrid (the default) or MultiDimensional Grid)
Enabled Currency Co Select global currency codes which are permissible in instance documents and units.
des
Enabled Language Co Sets the permitted languages to use for XML resources (references, roles, labels, and
des footnotes). The Locale setting determines the default.
Enabled Item Types Select data types which are permitted in the taxonomy as base types and types.
Enabled Concept Select the fields which are visible in concept definitions.
Fields
Enabled Fact Fields Select the fields which are permitted in fact definitions.
File Name Suffix Style Controls the suffixes that are added to taxonomy files (Classical, US GAAP, SEC, IFRS;
Classical is the default)
Name Auto Update Choose whether to auto-update the taxonomy display named with the label text loaded
From Label based on locale settings; default is True.
Name Use Camel Choose whether to use camel case ("MixedCaseWithoutSpaces") in label names; de
Case fault is True.
Name Capitalize First Choose whether to capitalize the first letter in label names; default is True.
Letter
To open a file from your computer or a mapped network drive, use the following procedures. To open a file
accessible on your network, use Windows Explorer to map a network drive to the server before using these
procedures.
● Taxonomy (*.xsd)
● Linkbase (*.xml)
● Instance (*.xml, *.xbrl)
● ZIP (*.zip) - ZIP file must contain one or more of the file types on this list
● Edgar XFDL (*.xfd, *.frm)
Note
If you have selected a file that Taxonomy Designer cannot open, Open is not available (gray).
5. Click Open.
To open a file from the Web or a WebDAV (Web-based Distributed Authoring and Versioning extensions to the
HTTP protocol) server, use the following procedures.
Note
Before loading a taxonomy from the Web or a WebDAV server, you might wish to first identify the taxonomy's
location on the Internet. If your network configuration requires it, you may need to configure a proxy server
before opening files. See Configuring a Proxy Server [page 23]. Finally, WebDAV servers with authentication
configured require entry of a username and password that you can obtain from your system administrator.
● Taxonomy (*.xsd)
● Linkbase (*.xml)
● Instance (*.xml, *.xbrl)
● ZIP (*.zip) - ZIP file must contain one or more of the file types on this list
● Edgar XFDL (*.xfd, *.frm)
○ To browse on a Web page to find the desired file, click in the URL field and enter the page's URL. Click Go
(the blue arrow) to open the Web page.
Note
You can use the drop-down arrow next to the URL field to select from a list of previously-accessed
URLs.
○ To open a Web-based file directly, click in the URL field, enter the file's complete URL, and the click Go
(the blue arrow).
○ To load standardized taxonomies available on the Internet, click XBRL and then navigate through the
menus to find the desired field.
Note
The list of standardized taxonomies available through the XBRL button can be customized. See User
Preferences [page 14].
○ If more than one XBRL document is available at the location you select, the Select XBRL document dialog
box appears. Expand nodes of the tree until you find the taxonomy or other XBRL document, and then
click Open.
If you would like to work with a file that you have used before in Taxonomy Designer, you can select it from a list of
recently-opened files.
1. Click File, click Recent Open, and then click a filename in the list.
2. If you selected a file retrieved from a WebDAV server, the WebDAV server may prompt you to enter your
credentials. Enter your username and password, and then click OK.
You can attach files such as linkbases to your taxonomy or instance document for use during a single Taxonomy
Designer session. No information is added to the taxonomy for attached documents, they are merely loaded into
the in-memory file set and displayed in Taxonomy Designer views for your use. If you wish to include references to
other files permanently, you should reference them instead or use the Save as command to save the attached files
as references.
When you use the Attach command, you can specify a folder, a single file, or a file on the Web or a WebDAV server.
○ Click XBRL to open a tree view of standard taxonomies that are available. Navigate through the tree until
you find the one you want, and then select it.
○ Enter a Web URL in the URL field to open a Web page for browsing. Navigate to the desired file, select it,
and then click Open.
○ Enter a WebDAV address in the URL field. The server may request your credentials before attaching the
file.
You can reference taxonomy schemas from your instance document or selected taxonomy, adding a reference
statement to the loaded taxonomy. When you open the instance document or taxonomy again, all referenced
schema files open, too.
1. Click File, click Reference, point to from taxonomy, and then point to File or Web.
2. If you chose File, the Select taxonomy or linkbase file to be referenced dialog box opens. Navigate to the
desired file and then click Open.
3. If you chose Web, the Enter URL to browse or open dialog box appears:
○ Click XBRL to open a tree view of standard taxonomies that are available. Navigate through the tree until
you find the one you want, and then select it.
○ Enter a Web URL in the URL field to open a Web page for browsing. Navigate to the desired file, select it,
and then click Open.
○ Enter a WebDAV address in the URL field. The server may request your credentials before attaching the
file.
4. Taxonomy Designer creates an import element in your taxonomy.
1. Click File, click Reference, point to from instance, and then point to File or Web.
2. If you chose File, the Select taxonomy or linkbase file to be referenced dialog box opens. Navigate to the
desired file and then click Open.
3. If you chose Web, the Enter URL to browse or open dialog box appears:
○ Click XBRL to open a tree view of standard taxonomies that are available. Navigate through the tree until
you find the one you want, and then select it.
If a file has been modified, you are prompted to save it if you attempt to exit Taxonomy Designer without saving
first. It is best practice to periodically save modified files. To save files, follow the procedures in the following
sections.
Files in the discoverable taxonomy set can be saved locally (on your computer or a mapped network drive), to a
ZIP file, or to a WebDAV server.
1. Click File, and then click Save. You are not prompted for a save location unless you have never saved the files
before.
2. If you have never saved the taxonomy before, the Save DTS Files dialog box opens. Select Save Options as
follows:
Note
The save options available on this list will vary depending on the files in your DTS or instance
document.
○ The individual files to include: select the files you want to save in the file list.
Note
If files in the file list were retrieved from the Internet, you can save them locally by editing the
information in the Name field. To save an Internet-based file in the local directory specified in the
location to save path, remove the URL, leaving just a filename in the Name field.
○ Attached files: saving attached files converts them to references in your schema.
○ System files
Files attached to your taxonomy are not part of the discoverable taxonomy set, but rather are loaded in
application memory for use during a single session. You can save them along with the DTS if you want to be able
to use them later.
Attaching files to the DTS does not make any changes to the XBRL taxonomy or XBRL linkbase files that make up
the DTS. If you want to permanently include linkbases or other taxonomies, create a reference to the files instead.
Note
If files in the file list were retrieved from the Internet, you can save them locally by editing the information in
the Name field. To save an Internet-based file in the local directory specified in the location to save path,
remove the URL, leaving just a filename in the Name field.
System files are XBRL.org standard schemas referenced in an XBRL document. These are standard schemas
which are available on the Internet.
An Edgar extension taxonomy DTS contains a taxonomy schema file and any generated linkbases. You can
choose to save just the changed files, all the files required for the extension taxonomy, or all writable files when
you save the extension taxonomy for the first time.
1. Click File, and then click Save. You are not prompted for a save location unless you have never saved the files
before.
2. If you have never saved the extension taxonomy before, the Save DTS Files dialog box opens. Select Save
Options as follows:
Note
If files in the file list were retrieved from the Internet, you can save them locally by editing the
information in the Name field. To save an Internet-based file in the local directory specified in the
location to save path, remove the URL, leaving just a filename in the Name field.
○ Which files to save: Changed files, Only extension DTS files, or All writable files.
Note
The save options available on this list vary depending on the files in your DTS.
○ The individual files to include: select the files you want to save in the file list.
○ Attached files
○ System files
○ Suffix style: Classical (abc-presentation), us-gaap (abc-pre-date), SEC (abc-date_pre), or IFRS
(pre_abc_date)
○ After selecting all desired Save options, click Save.
3. After selecting all desired Save options, click Save.
Taxonomy files that you have loaded from Web locations are assumed to be read-only by Taxonomy Designer. To
save these files, you must change the file save location to a local directory or a mapped network drive and then
remove the URL information in the Name field before clicking Save.
You can easily save all local and WebDAV-based files in the taxonomy by choosing All writable files in the Save DTS
Files dialog box. This selects all writable files in the files list.
Your network might require a proxy server to access the Internet. Taxonomy Designer uses proxy settings
configured in your Windows Internet settings or browser software. If you do not have your proxy configured in
Windows, you can configure a proxy server using the following procedure in Taxonomy Designer.
○ Address: The IP address of the proxy server (ask your network administrator)
○ Port: The port the proxy server monitors
○ User: Your network username
○ Password: Your network password
3. Click OK.
Taxonomy Designer provides a local Web cache for storing Web-based XBRL taxonomies. Caching support built
into Taxonomy Designer improves processing time by substantially reducing the number of files that need to be
accessed from the Internet when you open, import, or load a Web-based taxonomy.
Web caching creates a local repository of Web-based XBRL content as it is loaded. The Web cache mirrors the
hierarchical folder structure of Web content, including any dependent documents in XBRL taxonomies.
When you first load a web based taxonomy, the default cache location for Web-based taxonomies is created. The
typical local path is: C:\Users\<user>\AppData\Local\EDGAR Online\UBmatrix Taxonomy Designer\
cache
When a Web-based taxonomy is loaded or referenced, Taxonomy Designer attempts to load the taxonomy files
from the configured cache location first. The application handles web caching differently depending on the state
of the files in the default cache location.
Does not exist Downloads a new copy of the document to the default cache location.
Has a size of 0 (zero) byes in the Detects the zero-byte file in the default cache location, deletes it, and
default cache location downloads a new copy of the document to the default cache location.
Has a different date/time stamp Does nothing if the cached version is newer than the source file on the Web.
from the source file If the Web-based file is newer than the cached file, Taxonomy Designer de
letes the cached file and downloads a new copy of the document to the de
fault cache location.
Has an identical date/time stamp Does nothing. Taxonomy Designer does not check the contents of the files
but different content from the in the default cache location. Taxonomy Designer opens the file from the
source file default cache location.
If an XBRL taxonomy file is corrupted or unavailable (the file does not exist in the configured cache and Taxonomy
Designer cannot connect to the Internet), the software notifies you of the problem file in a taxonomy load
message in the Messages console.
Error: The application was unable to load the file with name
"http://fasb.org/us-types/2011-01-31." Ensure that the file exists in the
specified location and is a valid XBRL document. It is recommended to
verify
the product configuration and/or cache.
Taxonomy Designer uses a local Web caching system by default to reduce load times and to enable offline use of
Internet-based files. If your Web-based files change frequently, you might prefer to turn off the work offline
feature.
Caution
If you turn off Web caching by selecting Work Offline, Taxonomy Designer is not able to access files on the
Internet. If you attempt to load files not on your computer or a mapped network drive, Taxonomy Designer
reports errors in the Messages console.
1. Click Tools, highlight Web cache, and then click the checkmark next to Work offline.
If Taxonomy Designer is having trouble opening a taxonomy that you have used before, you might want to check
your Web cache. If you discover that you have unneeded files in your cache, or the file sizes are not what you
expect, you can clear your Web cache.
Note
You should also check to see that you have not selected Work Offline mode from the Tools Web Cache
command.
If the Internet connection is lost when downloading a taxonomy, the Web cache may have an incomplete definition
of the taxonomy or discoverable taxonomy set (DTS). You can clear the files from the cache and load the
taxonomy again to refresh file content.
In the context of SEC and IFRS filings, extension taxonomies have a specific role and must be built in a particular
way. An extension taxonomy references the base taxonomy and includes all base concepts, any new concepts
defined in the extension taxonomy, and all concept relationships and labels not explicitly overridden in the
extension.
The SEC and IFRS have rules about matching taxonomies with financial accounts that require extension
taxonomies for compliance. While US-GAAP is held to be a complete reporting taxonomy, the SEC requires
extension taxonomies to address financial accounts. An IFRS filing also requires extension taxonomies as IFRS is
not a complete reporting taxonomy.
Most of these rules are the same across industries and reporting structures, allowing much of the extension
taxonomy to be generated instead of being built manually. The Edgar Extension Taxonomy wizard can help you
generate an extension taxonomy for these filings.
These taxonomies use a layered architecture, including the base concepts, or core, and the modularity layer.
Base Concepts
Modularity Layer
The Edgar Extension Taxonomy wizard provides a streamlined, directed method of creating an extension
taxonomy from a selection of standard base taxonomies.
Before beginning to create your extension taxonomy, identify the base taxonomy for your schema.
1. Click File, click New, and then click Extension Taxonomy Wizard
- or -
Click Tools, click Wizards, and then click Edgar Extension Taxonomy.
2. In the Specify Edgar Extension Taxonomy wizard page, click Create new Edgar extension taxonomy, and then
enter details in the Create new options fields:
Note
The information you enter in these fields is used to create the schema or target namespace and the
XML prefix. These fields cannot begin with the characters "XML" and they cannot contain ampersands
(&), the greater than symbol (<), the less than symbol (>), single quotes ('), double quotes ("), spaces,
and certain accented letters.
3. Click Next, and then in the Save new extension taxonomy dialog box, browse to the folder where you want to
save the schema file, and then click Save.
4. In the Specify Base Taxonomies wizard page, specify the relevant GAAP and non-GAAP taxonomies that you
want to reference from your extension taxonomy, and then click Next.
Note
Depending on your choices in the GAAP Taxonomy list, the wizard may suggest taxonomies from the non-
GAAP taxonomy list that should also be referenced. If you are doing an SEC filing, refer to the SEC website
5. In the Specify Additional Referenced Taxonomies wizard page, review the discoverable taxonomy set (DTS)
that you have built so far and add references to any additional taxonomies by clicking on Add additional
referenced taxonomy from local file or from Web. After selecting the additional taxonomies, click Next.
- or -
If you do not have additional taxonomies to reference, click Next.
6. In the Import relationship groups wizard page, specify any relationship groups that relate to your company, or
import custom or prior filing taxonomy relationship groups. When you are finished specifying all relationship
groups, click Next.
Example Importing relationships groups rebuilds the relationships between concepts with the same names
in your extension taxonomy and your base taxonomy or instance document. Creating an
extension taxonomy imports the concepts but not the relationships.
If your base taxonomy has the concepts Intangible Assets, Client lists, and Other intangible
assets, your extension taxonomy also has these concept elements. Unless you import the
relationship groups from the base taxonomy, the extension taxonomy does not contain the
relationships between Intangible Assets and Client lists, Intangible Assets and Other intangible
assets, and Client lists and Other intangible assets.
Note
If you choose not to use the predefined standard relationships, you can use Taxonomy Designer to
build relationships after completing the wizard.
7. In the Import relationship groups to presentation (and label) linkbases dialog box, make your selections in the
Import Options, and then click Start.
This dialog box gives you further control over the relationships imported to the presentation and label
linkbases. In particular, you can specify the relationships to import for reuse and individual items can be
skipped if not needed.
○ Import type: Indicate the type of relationships that you want to import.
○ Taxonomy - Concepts
○ Linkbase - Labels
○ Linkbase - Presentation relations (the default)
○ Linkbase - Calculation relations
○ Linkbase - Definition relations
○ Linkbase - References
○ Linkbase - Formulas
○ Taxonomy - Tuples
○ Instance - Contexts
Tip
The Label field is not considered when importing relationship groups, so it can be edited if desired, but it is
not necessary to change the name, ID, or data types. The name and ID identify the concepts and the
concepts are linked into a tree. If these fields differ from the concepts in the extension taxonomy, the
relationship groups are not imported because the associated arcs and locators no longer connect concepts
or concepts and resources.
Note
A dimension linkbase infers dimensional relationships based on the Presentation view of your taxonomy. A
calculation linkbase infers information relationships between concepts with numeric and monetary data
types in the Presentation view of your taxonomy. Each of these linkbases can be viewed and edited in
Taxonomy Designer.
10. Using the Save DTS Files dialog box, save the newly-generated extension taxonomy files. The dialog box lists
the entire discoverable taxonomy set but in most cases, you only haveto save the files that you have created,
which can be identified by clicking All writable files.
Note
You can also review the path information in the Name field; local files have a filename, where referenced
files have web-based addresses. If in doubt, you can choose to save Only extension DTS files instead of
Changed files or All writable files.
Sometimes, you want to build an extension taxonomy from a schema file on your hard drive or on the Internet.
Instead of just referencing the base taxonomy when you create a new extension taxonomy, you might wish to
create and modify an extension taxonomy instead. This becomes your base taxonomy for the new extension
taxonomy.
1. Click File, click New, and then click Extension Taxonomy Wizard
- or -
Click Tools, click Wizards, and then click Edgar Extension Taxonomy.
2. In the Specify Edgar Extension Taxonomy wizard page, click Choose local file or Choose web file, and then
navigate to your base taxonomy.
3. After selecting the taxonomy, click Next.
4. From this step onwards, the steps for creating an extension taxonomy are identical to those referenced
earlier. Follow step 4 on page 32 and the remainder of that procedure.
An XBRL taxonomy is a collection of elements, linkbases, role definitions, reference part definitions, and data type
definitions. Linkbases contain extended links and depending on linkbase type, relationships, labels, formulas,
and/or references.
In many cases, a taxonomist follows this path when authoring a new taxonomy:
However, there are many ways to build taxonomies, based on personal preferences, business requirements, and
other concerns. Some of the steps shown in this chapter are not mandatory, and you might not even use
Presentation view to build your taxonomy. The material in this chapter is still useful to you even if you author your
taxonomy using a different technique.
There are several books and many excellent online references available for learning about XBRL, US and
international standard taxonomies, taxonomy-authoring best practices, and XBRL terminology. These references
cover a broader range of topics than this user guide and can help you expand your knowledge or plan your
taxonomy's design.
Use the File New Taxonomy command to begin creating a new taxonomy.
○ Namespace -- the globally unique identification for the taxonomy (your company's URL)
○ Prefix -- the abbreviation for the namespace which is used to name taxonomy concepts
The different views can help you organize reportable and non-reportable concepts. This helps you to make sure
that you are building a taxonomy that results in collecting the data that your reporting requires.
Note
It is possible to create your taxonomy in views other than Presentation, adding an extended link to group
together related concept definitions. That scenario is not addressed in this user guide.
1. Create a new taxonomy if you have not already done so. (See Understanding the Taxonomy Design Process
[page 31]).
An XBRL taxonomy is a collection of elements, linkbases, role definitions, reference part definitions, and data
type definitions. Linkbases contain extended links and depending on linkbase type, relationships, labels,
formulas, and/or references.
In many cases, a taxonomist will follow the path outlined in this chapter when authoring a new taxonomy:
However, there are many ways to build taxonomies, based on personal preferences, business requirements,
and other concerns. Some of the steps shown in this chapter are not mandatory, and you might not even use
Presentation view to build your taxonomy. The material in this chapter will still be useful to you even if you
author your taxonomy using a different technique.
There are several books and many excellent online references available for learning about XBRL, US and
international standard taxonomies, taxonomy-authoring best practices, and XBRL terminology. These
references cover a broader range of topics than this user guide and can help you expand your knowledge or
plan your taxonomy's design.
○ To use the standard extended link definition, click OK ( ). This extended link uses the role "link" as
defined by XBRL.org in the 2003 standards.
○ To create a custom extended link definition, click Add New Extended Link ( ). In the Definition field,
enter a description of the extended link role and then click OK.
Note
Extended links allow multiple concepts and other elements to be connected to your taxonomy. Detailed
information about extended link properties is available in Extended Link Properties [page 46].
Caution
You have to define at least one root concept under your extended link before saving the taxonomy.
Taxonomy Designer does not save an "empty" extended link.
After you have created an extended link, you create one or more root concepts. Root concepts are at the top level
of the taxonomy below the extended links. They are the root of the relationships between concepts below the
extended link.
1. In the Presentation view, create an extended link in your taxonomy (see Creating an Extended Link [page 32]).
2. Click the extended link, right-click to open the context menu, and then click Add Child.
3. In the Add Concept dialog box, enter the requested information. The items you see in this dialog box varies
based on the Enabled Concept Fields settings configured in Tools Preferences.
Note
Detailed information about concept properties is available in Concept Properties [page 46].
4. Click Add to add the concept to the taxonomy. It is displayed in the Presentation view.
Concepts are the fundamental element of a taxonomy. Concepts are the representation of things and abstract
groupings of things. They have attributes that describe the characteristics of the object being modeled.
To define a concept
1. In the Presentation view, click an extended link or parent concept, right-click to open the context menu, and
then click Add Child or Add Sibling.
2. In the Add Concept dialog box, enter the requested information. The items you see in this dialog box varies
based on the Enabled Concept Fields settings configured in Tools Preferences .
Note
Detailed information about concept properties is available inAbout Concept Fields [page 34].
The optional Add Attribute field allows you to directly enter XML attributes for the concept.
3. Click Add. The new concept is displayed in the Presentation view.
Note
If you have additional concepts to add as siblings to the one you just created, clear the Close after adding
checkbox.
Understanding the permitted concept fields can help you decide which ones to permit users to include in the
taxonomy. You do not have to use all of the possible concept fields.
Label The descriptive text associated with the concept. Labels provide human-readable infor
mation about the concept. If no label text is defined, the concept Name is used.
Prefix The defined short name for the associated taxonomy schema namespace.
Name The Name is used to uniquely identify the concept and contains a string without spaces
that is unique to this concept; it must begin with a letter and can include letters, num
bers, hyphens, underscores, colons, and full stops. It cannot begin with the string xml.
Reported facts are associated with the concept's Name.
numbers, hyphens, underscores, colons, and full stops. It cannot begin with the string
xml. Relationships are associated with the concept's ID.
BaseType Shows the atomic XML BaseType for the concept's XBRL data type. See Concept Prop
erties [page 46].
Type A type is used to specify the data type that will be used for the concept. An XBRL-pre
scribed list of types is available and custom types can be created.
Abstract When defining a concept, which is intended to group other concepts without itself being
reported, this field should be set to abstract (true).
SubstitutionGroup Substitution groups are used to indicate which XBRL element (item or tuple) you can
substitute for another concept. Items (xbrli:item) are reportable facts and tuples
(xbrli:tuple) are abstract groupings. Custom substitution groups are also permitted.
Balance Balance is used when the Type is set to MonetaryItemType; it allows for improved calcu
lation validation by restricting the sign of the value to represent a debit or credit.
Period If Period is instant, it indicates that the element, when used in an XBRL instance, must
always be associated with a context in which the period is instant (that is, at the indi
cated point of time); duration means that this period in instance documents must be ex
pressed either using a sequence of startDate and endDate elements or an element for
ever.
Nillable If Nillable is set to true, allows facts to contain no fact value without returning validation
errors.
Understanding the permitted fact fields can help you decide which ones to permit users to include in the
taxonomy. You do not have to use all of the possible fact fields.
IsNil True or false; if true, no fact value has been entered for this fact.
EffectiveValue The calculated value of the fact after taking into consideration the XBRL attributes.
TextValue The literal value of the fact before taking into consideration the XBRL attributes.
Concepts can be hidden from view or they can be deleted, depending on your needs. If you just want to hide some
concepts and their relationships in Presentation and Calculation views. If you want to permanently remove a
concept from your taxonomy and all views.
Deleting a Concept
Deleting a concept removes the element and its attribute from the taxonomy. You are not able to delete a concept
if other concepts are in relationships with it. You have to delete the relationships first. If you want to delete all
children of a parent concept, you can select the parent and use the Delete Subtree Concept and
relationships command to delete the relationships and concepts at the same time. If you also want to delete the
parent concept, you must delete the subtree concepts and relationships first, and then delete the concept.
To delete a concept
1. In any view, navigate to the concept you would like to delete. Click to select the concept.
2. Right-click and on the context menu, select Delete or Delete Concept.
Tip
To better understand how to delete concept s and relationships, it may help to think of it this way. If you
want to delete the relationship between a child and its parent, you select the child and use the Delete
Relationship command to delete the relationship up the tree. If you want to delete a relationship between a
parent concept and all of its children, you select the parent and use the Delete Subtree Concept and
relationships or Delete Subtree relationships commands to delete the relationships down the tree.
In the Presentation and Calculation tree views, concepts are presented in a hierarchical view that shows their
relationships to one another within an extended link. Concepts are above some and below others in the tree, and
they can be referred to as parents and children. These relationships cannot be broken except by deleting the child
concept.
If you wish to keep the concepts in the taxonomy but do not wish to show their relationships to one another in the
Presentation or Calculation tree views, you can prohibit the relationships. This does not actually delete the
concepts or the relationship. Instead, the application creates a new, higher-priority, "prohibit" relationship that
hides the related concepts.
Tip
To better understand how to prohibit relationships, it may help to think of it this way. When you want to hide a
relationship between a child and its parent, you should select the child and use the Prohibit Relationship
command to prohibit the relationship up the tree. When you want to hide a relationship between a parent
concept and all of its children, you should select the parent and use the Prohibit Subtree relationship command
to prohibit the relationships down the tree.
To prohibit a relationship
1. In any definition view, click to expand the tree to see the concept or concepts you would like to use.
2. Select a child concept.
3. Right-click to open the context menu, select Prohibit, and then click Relationship. The child is removed from
the current view as the relationship between it and its parent has been prohibited.
1. In any definition view, click to expand the tree to see the concept or concepts you would like to use.
2. Select a parent concept.
3. Right-click to open the context menu, select Prohibit, and then click Subtree Relationship. The children
concept(s) are removed from the current view as the relationship between those concepts and the parent
concept has been prohibited.
Tuples are a special type of concept identified in the taxonomy through the use of the substitution group
xbrli:tuple. Tuples consist of a parent (the tuple concept) which is an abstract grouping, and any number of
children, concepts which include information relating to the tuple.
In Presentation view, you can see all of the concepts, including tuples, in your taxonomy. If you want to work with
just the tuples, open the Tuple tree view.
To define a tuple
1. In the Presentation view, click a link or parent concept, right-click to open the context menu, and then click
Add Child or Add Sibling.
2. In the Add Concept dialog box, enter the requested information. Tuples do not require choices for all concept
property fields.
Note
Detailed information about concept properties is available in About Concept Fields [page 34].
Labels are used to identify concepts to taxonomy users. The standard label displayed in Taxonomy Designer is the
one you create when you create a new concept (see Defining Concepts [page 34]). Optionally, you can create
additional labels for various roles or languages. Label sets for particular roles or languages can be exported for
use in other applications. See Generating Linkbases [page 40].
Tip
Most complex taxonomies require labels for the standard label and documentation roles. Labels are also
commonly added for the short and verbose roles, if needed.
1. In the Presentation view, click to expand the tree to see the concept or concepts you would like to label.
2. Click the Properties tab. The standard (default) label is displayed in the Labels field.
3. To view all labels for this concept, click the magnifying glass next to the Labels field. In the Labels:
<prefix:conceptname> dialog box, you see a list of all labels that have been created for this concept so far. The
standard or default label is listed first with the role label.
4. Open the context menu and then click Add Label.
5. In the Add Labels to <prefix:conceptname> dialog box, enter the following information:
After you have created concepts associated with one or more extended links, you might find that you wish to do
some reorganization. You can use drag and drop to simplify this process. Elements can also be dragged and
dropped between views. Taxonomy Designer will not allow you to drag and drop elements that are incompatible;
for example, you cannot drag an abstract concept to the Calculation view.
To move a concept
1. In the Presentation view, click to expand the tree to see the concept or concepts you would like to move. At
the same time expand the tree where you would like to put the concept.
2. Using your mouse, select the concept you would like to move. While continuing to hold the left mouse button
down, move the highlighted concept to the desired destination.
3. As you move the concept over items in the tree, a darker line appears in the highlighted concept. This line
shows where in the tree the concept is placed when you release the mouse button. When the line is in the
place where you want the moved concept to go, release the mouse button.
○ If the darker line is on top, the moved concept becomes a sibling above the selected concept.
○ If the darker line is in the middle of the concept, the moved concept is placed under the selected concept
as a child concept.
○ If the darker line is on the bottom, the moved concept becomes a sibling below the selected concept.
To move a concept and any concepts under it using drag and drop, simply select the parent concept and move it
using this procedure. The concepts in its subtree moves with the parent concept.
Linkbases include information about the arcs (relationships) between concepts without including the concepts
(resources) themselves. You can generate linkbases as part of building a new taxonomy or as part of the import
process if you are building an extension taxonomy.
A label linkbase saves the concept label information and associated roles. By default, the standard label linkbase
contains all of the labels associated with the taxonomy, regardless of language or role.
The label linkbase is sometimes translated into other languages to facilitate using a single taxonomy in multiple
languages. To save a specialized label linkbase that contains labels in a single language or for a particular role, use
the export command. See Generating Linkbases [page 40].
When you save a label linkbase as part of the discoverable taxonomy set (DTS), Taxonomy Designer saves all of
the labels defined for the taxonomy's concepts, regardless of their language and role attributes. You might wish to
A calculation linkbase saves a representation of the arcs between monetary and numeric elements in your
taxonomy, simplifying the execution of numeric calculations. Taxonomy Designer can infer the relationships
between these elements based on the Presentation view of your taxonomy.
Note
If your taxonomy does not contain monetary or numeric concepts, you are not able to generate a calculation
linkbase.
XBRL instance documents are collections of fact values for concepts defined in XBRL taxonomies. There is a tight
relationship between taxonomies and instance documents, and the instance document functionality leverages the
robust taxonomy functionality of the application.
When creating instance documents, ensuring accuracy of the information expressed is also important. Taxonomy
Designer offers validation features to help ensure data accuracy including XML validation and XBRL validation of
calculation linkbases, formulas, and business rules.
Instance An XBRL instance document is a collection of facts defined by the referenced taxonomy
Documents organized by context and units.
Contexts Context contains information about the entity being described, the reporting period and the
reporting scenario. Collectively, these give the appropriate context for understanding the
reported facts.
Fact Values A fact value is an individual value for a concept defined in a taxonomy. For example if a
taxonomy defines a concept called “Name,” it may have a fact value of “Pat.”
Business Rules Business rules are Excel-like formulas, which can be used to build complex validation rules or
calculate ratios for business analysis.
Tuples A tuple is a structure of items in an instance document, defined in XBRL 2.1 as complex data
types (definition links in XBRL 2.0). For XBRL 2.1, a single XML schema element is saved in the
taxonomy .xsd file specifying the tuple structure. Tuples can contain items or other tuples,
and can be nested to any depth required.
To create a new instance document, you must open a taxonomy or other recognized document.
1. Click File, click New, highlight Instance of Taxonomy From, and then click File.
2. In the Windows Explorer dialog box, navigate to the desired instance taxonomy file (*.xsd), and then click
Open.
1. Click File, click New, highlight Instance of Taxonomy From, and then click File or Web.
2. In the New Instance dialog box, click XBRL, highlight Public Filings, Taxonomies, or UBmatrix, and then
navigate through the submenus to choose a taxonomy.
○ If you choose a webpage, the page opens. Browse through the site until you find the taxonomy. Click the
link for the taxonomy schema file (*.xsd) or other supported file type.
○ If you choose an entry that requires additional selections, the Select XBRL Document dialog box opens.
Navigate to the desired taxonomy schema file (*.xsd), and then click Open.
1. Click File, click New, highlight Instance of Taxonomy From, and then click Web.
2. In the New Instance dialog box, place your cursor in the Web address field and type the URL, and then click Go
(the blue arrow icon).
○ If you choose a webpage, the page opens. Browse through the site until you find the taxonomy. Click the
link for the taxonomy schema file (*.xsd) or other supported file type.
○ If you have entered the complete URL of a taxonomy schema file, it opens with no further action required.
Opening an instance document automatically opens all of its referenced files, including taxonomies and linkbases.
With the entire discoverable taxonomy set for an instance document open, you can work with the set of files in a
unified way.
Note
You can view the discoverable taxonomy set (DTS) by clicking the DTS - <name> tab.
Note
If you have closed the Properties pane, you can reopen it by using the View Properties command.
Properties for a selected extended link can be viewed by clicking an extended link and then clicking the Properties
tab.
Property Description
Role The role Unique Resource Identifier (URI) for this extended link, which uniquely identi
fies the extended link.
Taxonomy Names the taxonomy which contains the extended link role URI definition.
UsedOn Defines the linkbase type on which this extended link may be used. An extended link
role is automatically added. Additional UsedOn linkbase types can be added.
Add Used On Allows you to add additional linkbases where the extended link may be used.
Concepts can be added to a taxonomy in several different views. All of the properties for a selected concept can
be viewed by clicking a concept and then clicking the Properties tab.
The properties available when creating or editing a concept are controlled by your preferences settings. For more
information, see User Preferences [page 14].
Label Properties The label is the text that is displayed for the concept in the editor and the tree and grid views.
Permitted characters include letters, numbers, most punctuation, and diacritical marks.
Labels are usually created as part of the concept definition process and can be edited or
defined for additional roles in the concept's properties.
Prefix Properties The prefix is the short name for the taxonomy schema namespace that contains this concept.
Name Properties Unless changed in the user preferences (seeUser Preferences [page 14] ), the name is
automatically generated by Taxonomy Designer from the label text. The name is used to
ID Properties An ID is used to further identify an element or concept. It contains a string without spaces
that is unique to this concept; it must begin with a letter and can include letters, numbers,
hyphens, underscores, colons, and full stops. It cannot begin with the string xml.
Base Type The BaseType specifies the atomic, or standard, data type for this concept. The BaseType
Properties cannot be changed by a taxonomy user.
Possibilities include:
● anyURI
● base64Binary
● boolean
● byte
● date
● dateTime
● decimal
● double
● duration
● float
● fraction
● gDay
● gMonth
● gMonthDay
● gYear
● gYearMonth
● hexBinary
● int
● integer
● language
● long
● monetary
● Name
● NCName
● negativeInteger
● nonNegativeInteger
● nonPositiveInteger
● positiveInteger
● pure
● Qname
● Shares
● Short
● String
● Time
Tip
Abstract elements should be defined as strings.
Type Properties The type specifies the kind of information reported as the fact value for the concept. The
available types are the same as those for BaseType. The types available for use can be
configured; see User Preferences [page 14].
Substitution The substitution group property indicates how many valuesare included as part of this
Group Properties concept.
Abstract A concept that cannot contain any fact values is designated as an abstract element. Abstract
Properties elements are often used for header elements such as "Property, Plant, and Equipment
[abstract]". Concepts related to this one can be grouped under the abstract element, making
them easier to find in the taxonomy's Presentation view hierarchy. The abstract property is
Boolean (true/false).
Balance The balance property is used when the Type is set to MonetaryItemType. It can be either
Properties “blank”, “debit” or “credit”. The balance property is related to accounting concepts of debits
and credits, and allows for improved calculation validation by restricting the sign of the fact
value.
Period Each fact must be connected to a context. If the concept is defined with the Period instant,
Properties it indicates that the element, when used in an XBRL instance, must always be associated with
a context in which the period is instant (that is, at the point of time), duration means that
this period in instance documents must be expressed either using a sequence of startDate
and endDate elements or an element forever.
The options available for period type depend on the data type defined for the concept and
include forever, duration, instant, and period.
Tip
Abstract elements are set to period type duration.
Tip
Set <nillable> to true for best concept reusability.
Fixed Properties A value entered in the Fixed properties attribute is automatically assigned to the fact value for
this concept.
Note
A fixed value differs from a default value in that a fixed value is assigned to the attribute
and no other value can be specified, but a default value is assigned to the attribute if no
other value is specified.
AddAttribute The optional AddAttribute property allows you to specify XML attributes to be applied to this
Properties concept. Enter the attributes without XML brackets.
AddReference The optional AddReference property allows you to specify reference parts to be applied to
Properties this concept. Additional dialog boxes allow you to create new reference parts if needed.
The properties for a selected tuple concept can be viewed by clicking the tuple concept and then clicking the
Properties tab.
Tuples are a special type of concept identified in the taxonomy through the use of the substitution group
xbrli:tuple. Tuples are made up of a parent (the tuple concept) which is an abstract grouping, and any number
of children, concepts, which include information relating to the tuple. The tuple and the concepts it contains are
defined using the standard concept properties detailed inConcept Properties [page 46] .
8.1 Menus
The menus in Taxonomy Designer contain both familiar and specialized commands. Some menus and commands
are available only in certain circumstances. These are called out in the tables.
File Menu
The File menu provides access to features related to files and discoverable taxonomy set (DTS) operations.
Open ALT + F , O Open an XBRL document from the local computer or mapped net
● File ALT + F , O , F work drive.
● Web ALT + F , O , W Open an XBRL document file from the Internet or a WebDAV
server.
● Web ALT + F , T , W
Reference ALT + F , F From this taxonomy, reference a specified XBRL document (cre
● from Instance ALT + F , F , I ates a permanent reference in the schema).
○ File ALT + F , F , I , F Add the taxonomy schema references to the loaded DTS based
○ Web ALT + F , F , I , W upon the schemas referenced in the instance document on the lo
cal computer or the Web (Internet or WebDAV server).
● from Taxonomy ALT + F , F , T Reference a taxonomy on the local computer or the Web (Internet
○ File ALT + F , F , T , F or WebDAV server).
○ Web ALT + F , F , T , W
Import… ALT + F , I Import allows the import of taxonomy, instance, or linkbase ele
ments from various file types.
Export… ALT + F , E After you have created an XBRL document, the Export DTS dialog
box allows export of parts of the DTS components to various for
mats.
Close ALT + F , C Close all files associated with the selected taxonomy. If you have
more than one taxonomy open, you will need to close each one in
dividually using the Close command.
Save ALT + F , S Save all open files. If the files have not been saved before, a Save
Files dialog box will open.
Save As… ALT + F , A Opens the Save Files dialog box so you can save open files to an al
ternative location or with different options.
Recent Open ALT + F , R Reopen files that you have recently opened.
Recent Attach ALT + F , H Reattach files that you have recently attached.
The View menu provides access to the features related to various panes such as the linkbase information windows
or property windows which can be opened in the workspace.
Add Tree View ALT + V , R Adds a tree-type view of the selected type.
● Presentation ALT + V , R , P
Choosing Other Relations… opens a dialog box where you can
● Calculation ALT + V , R , C choose the arcrole for the tree view display.
● Dimensions ALT + V , R , D
● Other Relations… ALT + V , R , O
● Tuples ALT + V , R , U
● DTS ALT + V , R , S
Add Grid View ALT + V , G Adds a grid-type view of the selected type.
● Presentation ALT + V , G , P Choosing Other Relations… opens a dialog box where you can
● Calculation ALT + V , G , C choose the arcrole for the grid view display.
● Dimensions ALT + V , G , D
● Other Relations… ALT + V , G , O
● Concepts ALT + V , G , T
● Instance ALT + V , G , I
● Instance Multi-Dimensional ALT + V ,
G, M
● Formula Compiled ALT + V , G , U
● Formula Arcs Resources ALT + V , G , R
● Formula Aspects ALT + V , G , A
● Formula Editor ALT + V , G , F
XML ALT + V , X When a document is selected from the DTS View, View XML shows
the XML for the entire document.
Toggle View Sync ALT + V , T Selecting this option causes the application to keep views in sync,
moving the selection to the highlighted concept in other panes.
The Tools menu provides access to the features related to wizards, validation, server access, and preferences.
SEC No Checks ALT + T , S Build the taxonomy without checking for compliance with the
EDGAR Filing Manual.
SEC EX-100 Checks ALT + T , C Build the taxonomy with automatic checking for reference to a US
GAAP taxonomy and compliance with the EX-100 EDGAR Filing
Manual Chapter 5 rules (voluntary filers).
SEC EX-101 Checks ALT + T , E Build the taxonomy with automatic checking for reference to a US
GAAP taxonomy and compliance with the EX-100 EDGAR Filing
Manual Chapter 6 standards (mandatory filers).
Validate ALT + T , V Checks that the XBRL document is XML and XBRL compliant.
● XBRL ALT + T , V , X
Executes XBRL Calculations on an XBRL instance document ensur
● Calculations ALT + T , V , C ing that the data reported is consistent.
● Formulas ALT + T , V , F
Validates that the XBRL formulas are well formed and the XBRL is
valid.
Generate Sample Instance ALT + T , I Creates a sample instance document from the taxonomy that is
currently open.
Generate Linkbases ALT + T , L Creates a calculation linkbase based upon the XBRL presentation
● XBRL-US ALT + T , L , X view.
○ Generate Calculation Linkbase ALT Creates a dimension linkbase based upon the XBRL presentation
+ T, L, X, C view, inferring the necessary hypercubes, dimensions, and dimen
○ Generate Dimension Linkbase ALT sional members.
+ T, L, X, D
Wizards ALT + T , Z Opens the EDGAR Extension Taxonomy wizard to walk through the
● Edgar Extension Taxonomy ALT + T , workflow of creating a Taxonomy Extension.
Z, E
See Creating an Extension Taxonomy Using the Wizard [page 27].
Web Cache ALT + T , W The application will not attempt to refresh Web-linked files. If a file
● Work Offline ALT + T , W , O is available in the Web cache it will be used.
● Explore ALT + T , W , E Opens the application's Web cache directory in a Windows Explorer
● Clear ALT + T , W , L window.
Proxy Server ALT + T , Y Configure proxy server address, port, username, and password.
You can easily save all local and WebDAV-based files in the taxon
omy by choosing All writable files in the Save DTS Files dialog box.
This selects all writable files in the files list. See Configuring a Proxy
Server [page 23]
The Windows menu provides access to the windows currently open in your workspace.
<WindowName - <prefix>> ALT + W The Windows menu lists each pane that is currently open in the in
terface.
The following standard Windows keyboard shortcuts are available in Taxonomy Designer.
Shortcut Command
CTRL + P Print (print dialog varies based on taxonomy or instance view that has the current fo
cus).
8.3 Toolbars
Toolbars make many commands easier to access. When you first open Taxonomy Designer, the toolbar is very
simple, with only the File New , File Open Local , and File Open Web command icons
available. As you navigate through the application, the available buttons vary depending on where you are in the
application workspace and the actions that are permitted there.
Note
Throughout this user guide, tasks are presented using their menu- and context menu-based command names.
However, the toolbar buttons may be used instead as defined in this section.
After creating or loading a taxonomy, the presentation view toolbar will open.
After creating or loading an instance document, the instance grid toolbar will open.
Icon Command
After loading an instance document with multi-dimensional data, icons will be added to the toolbar.
Icon Command
Find options
After loading a taxonomy that contains formulas and opening any formula-related grid view, the formula toolbar
will open. These views include Formula Editor, Formula Resources, Formula Aspects, and Compiled Formula.
Icon Command
New formula
Execute formula
Find options
Taxonomy Designer has many context menus that are accessed by right-clicking in a field or pane. The primary
ones are covered in this section. Context menus will have different commands available depending on the part of
the interface you are currently using. This section documents the complete set of commands on each context
menu.
Keyboard shortcuts are available for the context-menu commands. To open the context-sensitive menus using
your keyboard, select an item and then press SHIFT + F10 . Keyboard shortcuts are listed next to command
names in this section.
In the Presentation and Calculation tree views, right-click or press SHIFT + F10 to open the context menu.
Show SHIFT + F10 , W Open another tree view or grid view pane. The most
● Add Another Relationships Pane SHIFT + F10 , W , common views are listed and others can be chosen.
A
Close a relationships pane.
○ Presentation tree SHIFT + F10 , W , A , P
Update other panes to reflect changes made in the Pre
○ Calculation tree SHIFT + F10 , W , A , C sentation view.
○ Dimensions tree SHIFT + F10 , W , A , D
Update the Presentation view to reflect changes made
○ Other tree SHIFT + F10 , W , A , O
in other panes.
○ Presentation grid SHIFT + F10 , W , A , R
○ Calculation grid SHIFT + F10 , W , A , A
○ Dimensions grid SHIFT + F10 , W , A , I
○ Other grid SHIFT + F10 , W , A , T
● Remove Relationships Pane SHIFT + F10 , W , R
● Sync to Other Panes SHIFT + F10 , W , N
● Sync from Other Panes SHIFT + F10 , W , Y
Filter SHIFT + F10 , F Clear the extended link filter. Filter by matching the first
● Clear SHIFT + F10 , F , C letter of the selected extended link.
● Matching SHIFT + F10 , F , M Filter by matching all extended links between selected
● Range SHIFT + F10 , F , R extended links by first letter.
● Set SHIFT + F10 , F , S
Filter the selected extended links.
Sort SHIFT + F10 , S Change the order in which items are displayed.
Remove Childless Node SHIFT + F10 , M Remove a concept that has no child concepts under it.
Cut SHIFT + F10 , U Removes elements from the view and places them on
● Concept SHIFT + F10 , U , C the Taxonomy Designer clipboard.
● Relationship SHIFT + F10 , U , R Remove concept from the view and place it on the clip
● Subtree SHIFT + F10 , U , S board. Remove relationship and place it on the clip
board.
○ Concept and Relationships SHIFT + F10 , U , S ,
C Remove an entire selected subtree (concepts and rela
○ Relationships Only SHIFT + F10 , U , S , R tionships) and place it on the clipboard.
Copy SHIFT + F10 , C Leaves elements in the view and also places them on
● Concept SHIFT + F10 , C , C the Taxonomy Designer clipboard.
● Relationship SHIFT + F10 , C , R Keep concept in the view and place a copy on the clip
● Subtree SHIFT + F10 , C , S board. Keep relationship in the view and place a copy on
the clipboard.
○ Concept and Relationships SHIFT + F10 , C , S ,
C Leave an entire selected subtree (concepts and rela
○ Relationships Only SHIFT + F10 , C , S , R tionships) and also place them on the clipboard.
Leave the selected subtree in the view and copy the re
lationships to the clipboard.
In the Console and Messages panes, right-click or press SHIFT + F10 to open the context menu.
In the Discoverable Taxonomy Set (DTS) tree view, right-click or press SHIFT + F10 to open the context menu.
View SHIFT + F10 , V See the Web address or other path information for the
selected item. Show XML formatting of selected item.
● Full URI Path SHIFT + F10 , V , U
● XML SHIFT + F10 , V , X
In the Dimensions tree view, right-click or press SHIFT + F10 to open the context menu.
Show SHIFT + F10 , W Open another tree view or grid view pane. The most
● Add Another Relationships Pane SHIFT + F10 , W , common views are listed and others can be chosen.
A
Close a relationships pane.
○ Presentation tree SHIFT + F10 , W , A , P
Update other panes to reflect changes made in the Pre
○ Calculation tree SHIFT + F10 , W , A , C sentation view.
○ Dimensions tree SHIFT + F10 , W , A , D
Update the Presentation view to reflect changes made
○ Other tree SHIFT + F10 , W , A , O
in other panes.
○ Presentation grid SHIFT + F10 , W , A , R
○ Calculation grid SHIFT + F10 , W , A , A
○ Dimensions grid SHIFT + F10 , W , A , I
○ Other grid SHIFT + F10 , W , A , T
● Remove Relationships Pane SHIFT + F10 , W , R
● Sync to Other Panes SHIFT + F10 , W , N
● Sync from Other Panes SHIFT + F10 , W , Y
Edit Label SHIFT + F10 , E Edit the label text for the selected concept.
Change SHIFT + F10 , N Edit the Arc role for the selected concept.
Sort SHIFT + F10 S Change the order in which items are displayed.
Remove Childless Node SHIFT + F10 M Remove a concept that has no child concepts under it.
○ Concept and Relationships SHIFT + F10 , D , S , Delete an entire selected subtree (concept and relation
C ships).
○ Relationships Only SHIFT + F10 , D , S , R
Delete a selected subtree's relationships (leave the con
cepts intact).
Cut SHIFT + F10 , U Removes elements from the view and places them on
● Concept SHIFT + F10 , U , C the Taxonomy Designer clipboard.
● Relationship SHIFT + F10 , U , R Remove concept from the view.
● Subtree SHIFT + F10 , U , S
Remove relationship and place it on the clipboard.
○ Concept and Relationships SHIFT + F10 , U , S ,
Remove an entire selected subtree (concepts and rela
C
tionships) and place it on the clipboard.
○ Relationships Only SHIFT + F10 , U , S , R
Remove the relationships between elements in a se
lected subtree and place them on the clipboard.
Copy SHIFT + F10 , C Leaves elements in the view and also places them on
● Concept SHIFT + F10 , C , C the Taxonomy Designer clipboard.
● Relationship SHIFT + F10 , C , R Keep concept in the view and place a copy on the clip
● Subtree SHIFT + F10 , C , S board.
○ Concept and Relationships SHIFT + F10 , C , S , Keep relationship in the view and place a copy on the
C clipboard.
○ Relationships Only SHIFT + F10 , C , S , R
Leave an entire selected subtree (concepts and rela
tionships) and also place them on the clipboard.
Leave the selected subtree in the view and copy the re
lationships to the clipboard.
In the Tuples tree view, right-click or press SHIFT + F10 to open the context menu.
Show SHIFT + F10 , W Open another tree view or grid view pane. The most
● Add Another Relationships Pane SHIFT + F10 , W , common views are listed and others can be chosen.
A
Close a relationships pane.
○ Presentation tree SHIFT + F10 , W , A , P
Update other panes to reflect changes made in the Tu
○ Calculation tree SHIFT + F10 , W , A , C ples view.
○ Dimensions tree SHIFT + F10 , W , A , D
Update the Tuples view to reflect changes made in
○ Other tree SHIFT + F10 , W , A , O
other panes.
○ Presentation grid SHIFT + F10 , W , A , R
○ Calculation grid SHIFT + F10 , W , A , A
○ Dimensions grid SHIFT + F10 , W , A , I
○ Other grid SHIFT + F10 , W , A , T
● Remove Relationships Pane SHIFT + F10 , W , R
● Sync to Other Panes SHIFT + F10 , W , N
● Sync from Other Panes SHIFT + F10 , W , Y
In the Presentation, Calculation, and Dimensions grid views, right-click or press SHIFT + F10 to open the context
menu.
Show SHIFT + F10 , W Open another tree view or grid view pane. The most
● Add Another Relationships Pane SHIFT + F10 , W , common views are listed and others can be chosen.
A
Close a relationships pane.
○ Presentation tree SHIFT + F10 , W , A , P
Update other panes to reflect changes made in the se
○ Calculation tree SHIFT + F10 , W , A , C lected view.
○ Dimensions tree SHIFT + F10 , W , A , D Update the selected view to reflect changes made in
○ Other tree SHIFT + F10 , W , A , O other panes.
○ Presentation grid SHIFT + F10 , W , A , R
○ Calculation grid SHIFT + F10 , W , A , A
○ Dimensions grid SHIFT + F10 , W , A , I
○ Other grid SHIFT + F10 , W , A , T
● Remove Relationships Pane SHIFT + F10 , W , R
● Sync to Other Panes SHIFT + F10 , W , N
● Sync from Other Panes SHIFT + F10 , W , Y
Sort SHIFT + F10 , S Change the order in which items are displayed.
Remove Childless Node SHIFT + F10 , M Remove a concept that has no child concepts under it.
Cut SHIFT + F10 , U Removes elements from the view and places them on
● Concept SHIFT + F10 , U , C the Taxonomy Designer clipboard.
● Relationship SHIFT + F10 , U , R Remove concept from the view and place it on the clip
● Subtree SHIFT + F10 , U , S board.
○ Concept and Relationships SHIFT + F10 , U , S , Remove relationship and place it on the clipboard.
C
Remove an entire selected subtree (concepts and rela
○ Relationships Only SHIFT + F10 , U , S , R
tionships) and place it on the clipboard.
Copy SHIFT + F10 , C Leaves elements in the view and also places them on
● Concept SHIFT + F10 , C , C the Taxonomy Designer clipboard.
● Relationship SHIFT + F10 , C , R Keep concept in the view and place a copy on the clip
● Subtree SHIFT + F10 , C , S board.
○ Concept and Relationships SHIFT + F10 , C , S , Keep relationship in the view and place a copy on the
C clipboard.
○ Relationships Only SHIFT + F10 , C , S , R
Leave an entire selected subtree (concepts and rela
tionships) and also place them on the clipboard.
Leave the selected subtree in the view and copy the re
lationships to the clipboard.
In the Concepts grid view, right-click or press SHIFT + F10 to open the context menu.
Show SHIFT + F10 , W Open another tree view or grid view pane.
● Add Another Relationships Pane SHIFT + F10 , W , The most common views are listed and others can be
A chosen.
○ Presentation tree SHIFT + F10 , W , A , P Close a relationships pane.
○ Calculation tree SHIFT + F10 , W , A , C
Update other panes to reflect changes made in the
○ Dimensions tree SHIFT + F10 , W , A , D
Concepts grid view.
○ Other tree SHIFT + F10 , W , A , O
Update the Concepts grid view to reflect changes made
○ Presentation grid SHIFT + F10 , W , A , R
in other panes.
○ Calculation grid SHIFT + F10 , W , A , A
○ Dimensions grid SHIFT + F10 , W , A , I
○ Other grid SHIFT + F10 , W , A , T
● Remove Relationships Pane SHIFT + F10 , W , R
● Sync to Other Panes SHIFT + F10 , W , N
● Sync from Other Panes SHIFT + F10 , W , Y
Sort SHIFT + F10 , S Change the order in which items are displayed.
Add Concept SHIFT + F10 , D Add a new concept below the selected item.
In the Instance grid view, right-click or press SHIFT + F10 to open the context menu.
Text Edit SHIFT + F10 , E Use the standard text edit commands to edit concepts
or their elements.
● Cut CTRL + X
● Copy CTRL + C
● Paste CTRL + V
Fill SHIFT + F10 , F Auto-fill cells above the selection using the selected
● Up SHIFT + F10 , F , U value.
● Down SHIFT + F10 , F , D Auto-fill cells below the selection using the selected
value.
In the View XML pane, right-click or press SHIFT + F10 to open the context menu.
Cut CTRL + X Cut the selected XML and put it on the clipboard.
Copy CTRL + C Copy the selected XML and put it on the clipboard.
Select All SHIFT + F10 , A Select all XML in the View XML pane.
Outlining SHIFT + F10 , O Use the View XML outlining feature to expand or col
● Expand All SHIFT + F10 , O , E lapse the XML code.
● Collapse All SHIFT + F10 , O , C Expand all XML items in the file to view attributes.
Increase Indent SHIFT + F10 , I Increase indent for the selected item (moves it to the
right).
Decrease Indent SHIFT + F10 , D Decrease indent for the selected item (moves it to the
left).
Comment Lines SHIFT + F10 , C Add the XML comment tags to this line so it will not be
used.
Uncomment Lines SHIFT + F10 , U Remove XML comment tags from this line so that it will
be used when the XML is processed.
In the header for each pane, right-click to open the context menu.
Floating Make this pane float; the pane can be dragged outside
the main application window.
Dockable Make this pane dockable; drag it around the main appli
cation window and then drop it to dock it within the pro
gram.
Tabbed Make this pane tabbed; allows you to stack a pane with
others.
Auto Hide Make a floating pane hide if it is not in use; a small tab at
the edge of the screen shows the hidden pane and can
be clicked to reopen the pane.
Hide Hide the pane; a small tab at the edge of the screen
shows the pane. Click it to open the pane.
Close All But This Close all panes except for the selected pane.
Floating Make this pane float; the pane can then be dragged out
side the main application window.
Dockable Make this pane dockable; drag it around the main appli
cation window and then drop it to dock it within the pro
gram.
Coding Samples
Any software coding and/or code lines / strings ("Code") included in this documentation are only examples and
are not intended to be used in a productive system environment. The Code is only intended to better explain and
visualize the syntax and phrasing rules of certain coding. SAP does not warrant the correctness and completeness
of the Code given herein, and SAP shall not be liable for errors or damages caused by the usage of the Code,
unless damages were caused by SAP intentionally or by SAP's gross negligence.
Accessibility
The information contained in the SAP documentation represents SAP's current view of accessibility criteria as of
the date of publication; it is in no way intended to be a binding guideline on how to ensure accessibility of software
products. SAP specifically disclaims any liability with respect to this document and no contractual obligations or
commitments are formed either directly or indirectly by this document.
Gender-Neutral Language
As far as possible, SAP documentation is gender neutral. Depending on the context, the reader is addressed
directly with "you", or a gender-neutral noun (such as "sales person" or "working days") is used. If when referring
to members of both sexes, however, the third-person singular cannot be avoided or a gender-neutral noun does
not exist, SAP reserves the right to use the masculine form of the noun and pronoun. This is to ensure that the
documentation remains comprehensible.
Internet Hyperlinks
The SAP documentation may contain hyperlinks to the Internet. These hyperlinks are intended to serve as a hint
about where to find related information. SAP does not warrant the availability and correctness of this related
information or the ability of this information to serve a particular purpose. SAP shall not be liable for any damages
caused by the use of related information unless damages have been caused by SAP's gross negligence or willful
misconduct. Regarding link classification, see: http://help.sap.com/disclaimer