Transcript
SAP Disclosure Management Document Version: 10.0 SP08 - 2014-03-13
SAP Taxonomy Designer
Table of Contents 1
What is the Taxonomy Designer?. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4
1.1
Taxonomy Designer Features. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4
2
Using the Taxonomy Designer Interface . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5
2.1
Workspace. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5
2.2
Menus. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5 2.2.1
File Menu. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6
2.2.2
View Menu. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7
2.2.3
Tools Menu. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7
2.2.4
Windows Menu. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 8
2.3
Keyboard Shortcuts. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 8
2.4
Icons. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 8
2.5
Views. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 10 2.5.1
DTS View. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 11
2.5.2
View Synchronization. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 11
2.6
Properties. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 11
2.7
Context Menus. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 11
2.8
Viewing Console Messages. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 12
2.9
Viewing Messages. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 13
2.10
Using Search. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 14
2.11
User Preferences. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 14
3
Working with Files in Taxonomy Designer. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 16
3.1
Opening Files on Your Computer. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 16
3.2
Opening Files from the Web or a WebDAV Server. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 17
3.3
Reopening Recently-Opened Files. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 18
3.4
Attaching Files. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 18
3.5
Referencing Files. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 19
3.6
Saving Modified Files. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 20
3.7
Configuring a Proxy Server. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 23
3.8
About the Web Cache. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 23
4
Creating Extension Taxonomies. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 26
4.1
Understanding Extension Taxonomies. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .26
4.2
Creating an Extension Taxonomy Using the Wizard. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .27
5
Authoring a Taxonomy. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .31
5.1
Understanding the Taxonomy Design Process. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 31
5.2
Creating a New Taxonomy. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 31
5.3
Creating an Extended Link. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 32
2
© 2014 SAP AG or an SAP affiliate company. All rights reserved.
SAP Taxonomy Designer Table of Contents
5.4
Creating a Root Concept. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 33
5.5
Defining Concepts. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 34
5.6
About Concept Fields. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .34
5.7
About Fact Fields. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .35
5.8
Hiding or Deleting Concepts. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 36
5.9
Defining Tuples. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 37
5.10
Creating Labels. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 38
5.11
Using Drag and Drop. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 39
5.12
Generating Linkbases. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 40
6
Creating Instance Documents. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 43
6.1
Understanding Instance Documents. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 43
6.2
Creating a New Instance Document. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .43
6.3
Opening an Instance Document. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 44
7
Understanding Properties. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 46
7.1
Extended Link Properties. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 46
7.2
Concept Properties. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 46
7.3
Tuples Properties. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 49
8
Command Reference. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .50
8.1
Menus. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 50
8.2
Standard Windows Keyboard Shortcuts Available in Taxonomy Designer. . . . . . . . . . . . . . . . . . . . . . . 54
8.3
Toolbars. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 54
8.4
Context Menus. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 57
9
Important Disclaimers on Legal Aspects. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 70
SAP Taxonomy Designer Table of Contents
© 2014 SAP AG or an SAP affiliate company. All rights reserved.
3
1
What is the Taxonomy Designer?
Taxonomy Designer supports the task of creating and editing XBRL taxonomies and instance documents. Taxonomy Designer supports the taxonomist or XBRL taxonomy author by providing extensive features to create and extend taxonomies. Instance documents can also be created to test taxonomies. 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.
1.1
Taxonomy Designer Features
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.
4
© 2014 SAP AG or an SAP affiliate company. All rights reserved.
SAP Taxonomy Designer What is the Taxonomy Designer?
2
Using the Taxonomy Designer Interface
The Taxonomy Designer application is a Microsoft Windows-based tool for creating XBRL taxonomies and related files. Taxonomists can use its graphical user interface to create and manipulate XBRL taxonomies and instance documents.
2.1
Workspace
The Taxonomy Designer workspace is divided into three main areas: ●
Menu bar
●
Toolbars
●
Content areas or panes
Panes can be rearranged by the user to suit their preferences.
Sample Taxonomy Editing Session Workspace 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.
Sample Instance Document Editing Session Workspace 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]
SAP Taxonomy Designer Using the Taxonomy Designer Interface
© 2014 SAP AG or an SAP affiliate company. All rights reserved.
5
●
Tools menu – Provides access to the features related to wizards, validation, server access, and preferences, see Tools Menu [page 7]
●
Windows menu – Provides access to the windows currently open in your workspace, see Windows Menu [page 8]
●
Help menu – Provides information about the software
2.2.1
File Menu
The File menu contains the following commands, used for manipulating files and the discoverable taxonomy set (DTS): ●
New Taxonomy: Create a new XBRL taxonomy.
●
New Instance of Taxonomy from File: Create a new XBRL instance document referencing a local file system taxonomy.
●
New Instance of Taxonomy from Web: Create a new instance document referencing a remote taxonomy (using the Web or a WebDAV server).
●
New Edgar Extension Taxonomy: Create a new EDGAR extension taxonomy using the Extension Taxonomy Wizard.
●
Open File: Open an XBRL document from the local computer or mapped network drive.
●
Open Web: Open an XBRL document file from the Internet or a WebDAV server.
●
Attach File: Attach an XBRL document such as a label or formula linkbase to the loaded taxonomy temporarily for use during this session from a local file.
●
Attach Folder: Attach an XBRL document to the loaded taxonomy temporarily for use during this session from a network folder
●
Attach Web: Attach an XBRL document to the loaded taxonomy temporarily for use during this session from the Web (Internet or WebDAV server).
●
Reference from Instance (File or Web): From this taxonomy, reference a specified XBRL document (creates a permanent reference in the schema). Add the taxonomy schema references to the loaded DTS based upon the schemas referenced in the instance document on the local computer or the Web (Internet or WebDAV server).
●
Reference from Taxonomy (File or Web): From this taxonomy, reference a specified XBRL document (creates a permanent reference in the schema) on the Web (Internet or WebDAV server).
●
Import: Import allows the import of taxonomy, instance, or linkbase elements from various file types. You must open an XBRL document before importing another file.
●
Export: After you have created an XBRL document, the Export DTS dialog box allows export of parts of the DTS components to various formats.
●
Close: Close all files associated with the selected taxonomy. If you have more than one taxonomy open, you have to close each one individually using the Close command.
●
Save: Write all open files to disk. If the files have not been saved before, a Save Files dialog box opens.
●
Save As: Opens the Save Files dialog box so you can save open files to an alternative location or with different options.
●
Recent Open: Provides a list of files you have recently opened for quicker selection.
●
Recent Attach: Provides a list of files you have recently attached for quicker selection.
●
Exit: Close Taxonomy Designer.
6
© 2014 SAP AG or an SAP affiliate company. All rights reserved.
SAP Taxonomy Designer Using the Taxonomy Designer Interface
2.2.2
View Menu
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.
2.2.3
Tools Menu
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.
SAP Taxonomy Designer Using the Taxonomy Designer Interface
© 2014 SAP AG or an SAP affiliate company. All rights reserved.
7
●
Proxy Server: Configure proxy server address, port, username, and password, see Configuring a Proxy Server [page 23]. 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. See Configuring a Proxy Server [page 23].
●
Preferences: Configure user preferences and available elements in taxonomies and instance documents. See User Preferences [page 14].
2.2.4
Windows Menu
The Windows menu is an alternate way to select one of the windows that is open in the interface.
>: The Windows menu lists each pane that is currently open in the interface.
2.3
Keyboard Shortcuts
The following standard Windows keyboard shortcuts are available in Taxonomy Designer. Shortcut
Command
CTRL + N
Create a new taxonomy.
CTRL + O
Open a file from the local file system.
ALT + SHIFT + O
Open a file from the Web or a WebDAV server.
CTRL + F
Find text within the current pane.
CTRL + P
Print (print dialog varies based on taxonomy or instance view that has the current focus).
CTRL + W
Close a file.
CTRL + S
Save a file.
ALT + F4
Exit application.
F1
Open online Help.
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.
8
© 2014 SAP AG or an SAP affiliate company. All rights reserved.
SAP Taxonomy Designer Using the Taxonomy Designer Interface
Icon
Label
Commands
Functionality Application icons appear in windows and dialog boxes
Close
Closes the window or dialog box
Delete
Deletes the selected item(s); used to delete Extended Roles
Ellipsis
Opens a secondary dialog box for further selections
Go
In the Web dialog box, executes the selected command or acts on selections
New
Creates a new XBRL document
Open a file or folder
Opens a Windows Explorer window
Open WebDAV server in Opens the WebDAV server interface terface Plus
Adds the selected item
Prohibited
The drag and drop operation that you are attempting is not per mitted
Scroll tabs
Use to navigate through screens
Taxonomy validation
Execute the taxonomy validation command
Preferences
Opens user's application preferences
Validate
Execute the validation command, which executes XML, and XBRL validation.
Concept Type
See Concept Properties [page 46] Abstract
A grouping of non-reportable, intangible concepts
Dimension
A dimension-based concept
Hypercube
A hypercube-based concept
Tuple
A tuple-based concept
Concept Data Type
See Concept Properties [page 46] Base 64
A base 64-based concept
Boolean
Concept fact value must be true or false (Boolean)
Byte
A single byte-based concept
SAP Taxonomy Designer Using the Taxonomy Designer Interface
© 2014 SAP AG or an SAP affiliate company. All rights reserved.
9
Icon
Label
Functionality
Date and date/time
A date or date/time-based concept
Decimal
A decimal-based concept
Fraction
A fraction-based concept
Hexadecimal
A hexadecimal-based concept
Integer
An integer-based concept
Monetary
A monetary-based concept
Other
Other
Pure
A pure concept
Qname
A qname (qualified XML)-based concept; qnames are used to include concept names as fact values
Shares
Shares
String
A string-based concept (text)
Time
A time-based concept
Token
A token-based concept
View Icons
2.5
These icons are used in tree and grid views to show the type of link or file Domain
A member, acting as a default member, or domain member (used only in dimension view)
External link
Shows the root of the loaded taxonomy (with a targeted role, if applicable)
Linkbase
A linkbase (in DTS view only)
URL
URL
XSD
A schema XSD (in DTS view only)
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:
10
© 2014 SAP AG or an SAP affiliate company. All rights reserved.
SAP Taxonomy Designer Using the Taxonomy Designer Interface
●
Tree view Tree (hierarchical) views include Presentation, Calculation, Dimension, Tuples, and Other Relations as defined by arcroles (role or name of an arc to express a relationship between two concepts or a concept and a resource). These views can be expanded or collapsed to show varying levels of detail.
●
Grid views Grid (table-based) views include Presentation, Calculation, Dimensions, Other Relations (as defined by arcroles), Concepts, Instance, Instance Multidimensional, Formula Compiled, Formula Arcs Resources, Formula Aspects, and Formula Editor. Grid views show more information about selected files and elements in a concise format.
2.5.1
DTS View
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.
2.5.2
View Synchronization
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
2.6
View
Toggle View Sync .
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.
2.7
Context Menus
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.
SAP Taxonomy Designer Using the Taxonomy Designer Interface
© 2014 SAP AG or an SAP affiliate company. All rights reserved.
11
Pane Header Context Menu In the header for each pane, right-click to open the context menu. It offers the following functions: Menu item
Description
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.
Tab Context Menu On any tab, right-click to open the context menu. It offers the following functions: Menu item
Description
Close
Closes the pane
Close All But This
Closes all panes except for the selected pane
Close All
Closes all panes
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.
Document
Shows the current document
2.8
Viewing Console Messages
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.
To copy messages to the clipboard or save messages to a file 1.
12
Go to the Console tab.
© 2014 SAP AG or an SAP affiliate company. All rights reserved.
SAP Taxonomy Designer Using the Taxonomy Designer Interface
2.
Open the context menu in the Console pane and select Copy or Save. ○
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.
To clear messages from the console 1.
Go to the Console tab.
2.
Open the context menu in the Console pane and select Clear from the context menu.
2.9
Viewing Messages
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.
To copy error messages to the clipboard or save error messages to a file 1.
Go to the Messages tab.
2.
Open the context menu in the Messages pane and select Copy or Save from the context menu. ○
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 1.
Go to the Messages tab.
2.
Open the context menu in the Messages pane and select Clear from the context menu.
SAP Taxonomy Designer Using the Taxonomy Designer Interface
© 2014 SAP AG or an SAP affiliate company. All rights reserved.
13
2.10 Using Search 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.
To search for a string 1.
Enter a string in the Search field (Find within labels or values).
2.
Choose Find Options and select options as follows: ○
Which elements to search: in Labels, in Names, in Values (instance documents only)
○
Where to look: at start, anywhere
○
What to display: show matches
3.
Click Next search result (the small blue arrow to the right of the Search field).
4.
Use the Find Results pane to scroll through the listing of search results. Click Next search result again to advance to the next search result, or click Previous result (the small blue arrow to the left of the Search field) to step through the search results in reverse order.
To repeat an earlier search 1.
Click Find Options and select options as follows: ○
Which elements to search: in Labels, in Names, in Values (instance documents only)
○
Where to look: at start, anywhere
○
What to display: show history
2.
Click the Search field (Find within labels or values) and select a search term from the drop-down list of previous searches.
3.
Click Next search result (the small blue arrow to the right of the Search field).
2.11
User Preferences
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).
14
© 2014 SAP AG or an SAP affiliate company. All rights reserved.
SAP Taxonomy Designer Using the Taxonomy Designer Interface
Item
Value
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 des
Select global currency codes which are permissible in instance documents and units.
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 Fields
Select the fields which are visible in concept definitions.
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 From Label
Choose whether to auto-update the taxonomy display named with the label text loaded based on locale settings; default is True.
Name Use Camel Case
Choose whether to use camel case ("MixedCaseWithoutSpaces") in label names; de fault is True.
Name Capitalize First Letter
Choose whether to capitalize the first letter in label names; default is True.
SAP Taxonomy Designer Using the Taxonomy Designer Interface
© 2014 SAP AG or an SAP affiliate company. All rights reserved.
15
3
Working with Files in Taxonomy Designer
Taxonomy Designer has many capabilities. Opening and closing files is central to all of them. You can access files on your local computer, mapped network drives, the Internet, or on a WebDAV server for which you have credentials. Taxonomy Designer caches files that you access from the Internet for quicker retrieval in the future.
3.1
Opening Files on Your Computer
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. The following types of files can be opened in Taxonomy Designer: ●
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 open an XBRL document from a local directory 1.
Click File, click Open, and then click File.
2.
In the Select XBRL document to load dialog box, use the file type drop-down to select the type of file you wish to open. The default is Taxonomy (*.xsd).
3.
Navigate to the desired file, and then click Open.
To open a ZIP file containing an XBRL document from a local directory 1.
Click File, click Open, and then click File.
2.
In the Select XBRL document to load dialog box, use the file type drop-down to select the ZIP (*.zip) file type.
3.
Navigate to the desired ZIP file, and then click Open.
4.
In the Select XBRL document dialog box, expand the nodes on the tree and select a ZIP archive to open.
Note If you have selected a file that Taxonomy Designer cannot open, Open is not available (gray). 5.
16
Click Open.
© 2014 SAP AG or an SAP affiliate company. All rights reserved.
SAP Taxonomy Designer Working with Files in Taxonomy Designer
3.2
Opening Files from the Web or a WebDAV Server
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. The following types of files can be opened in Taxonomy Designer: ●
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 open an XBRL document from the Web 1.
Click File, click Open, and then click Web.
2.
In the Enter URL to browse or open dialog box, you have several choices: ○
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.
SAP Taxonomy Designer Working with Files in Taxonomy Designer
© 2014 SAP AG or an SAP affiliate company. All rights reserved.
17
To open an XBRL document from a WebDAV server 1.
Click File, click Open, and then click Web.
2.
In the Enter URL to browse or open dialog box, enter the WebDAV address, and then click Go (the blue arrow). You can enter a URL for an entire directory or for an individual file.
3.
The WebDAV server may prompt you to enter your credentials. Enter your username and password, and then click OK.
4.
If you entered an address for a directory, the browse window contains the directory structure in a Windows Explorer-type interface. Click the file you want to use.
3.3
Reopening Recently-Opened Files
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.
To open a recently-opened file 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.
3.4
Attaching Files
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.
To attach a file or folder 1.
Click File, click Attach, and then point to File or Folder.
2.
In the Select XBRL taxonomy or linkbase to attach dialog box, browse to the desired file or folder, select it, and then click Open.
18
© 2014 SAP AG or an SAP affiliate company. All rights reserved.
SAP Taxonomy Designer Working with Files in Taxonomy Designer
To attach a file from the Web or a WebDAV server 1.
Click File, click Attach, and then point to Web.
2.
In the Enter URL to browse or open dialog box, you have several choices: ○
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.
3.5
Referencing Files
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.
To add a reference to a taxonomy 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:
4.
○
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.
Taxonomy Designer creates an import element in your taxonomy.
To add references to an instance document 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.
SAP Taxonomy Designer Working with Files in Taxonomy Designer
© 2014 SAP AG or an SAP affiliate company. All rights reserved.
19
4.
○
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.
Taxonomy Designer creates an import statement in the loaded taxonomy.
3.6
Saving Modified Files
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.
Saving All Files 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.
To save all files 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: ○
Location to save: Local directory, ZIP file, or WebDAV directory
○
Location to save path
○
Which files to save: Changed files, Only extension DTS files, or All writable files
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.
20
○
Attached files: saving attached files converts them to references in your schema.
○
System files
© 2014 SAP AG or an SAP affiliate company. All rights reserved.
SAP Taxonomy Designer Working with Files in Taxonomy Designer
○ 3.
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.
Saving All Attached 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.
To save all attached files 1.
Click File, and then click Save as.
2.
In the Save DTS files dialog box, select the files you want to save, indicate where to save them (a local directory path), and then select (a) Attached files. Click Save.
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.
Saving System Files System files are XBRL.org standard schemas referenced in an XBRL document. These are standard schemas which are available on the Internet.
To save system files 1.
Click File, and then click Save as.
2.
In the Save DTS files dialog box, select the files you want to save, indicate where to save them (a local directory path), and then select (s) System files.
3.
In the files list, change the URLs of the system files you want to save to local paths. Click Save.
SAP Taxonomy Designer Working with Files in Taxonomy Designer
© 2014 SAP AG or an SAP affiliate company. All rights reserved.
21
Saving Extension Files 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.
To save extension taxonomy files 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: ○
Location to save: Local directory, ZIP file, or WebDAV directory
○
Location to save path
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.
3.
○
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.
After selecting all desired Save options, click Save.
Saving Read-only and Writable Files 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.
22
© 2014 SAP AG or an SAP affiliate company. All rights reserved.
SAP Taxonomy Designer Working with Files in Taxonomy Designer
3.7
Configuring a Proxy Server
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.
To configure a proxy server 1.
Click Tools, and then click Proxy server.
2.
Enter the requested information:
3.
○
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
Click OK.
3.8
About the Web Cache
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\\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. If the file…
Then Taxonomy Designer…
Does not exist
Downloads a new copy of the document to the default cache location.
Has a size of 0 (zero) byes in the default cache location
Detects the zero-byte file in the default cache location, deletes it, and downloads a new copy of the document to the default cache location.
Has a different date/time stamp from the source file
Does nothing if the cached version is newer than the source file on the Web. 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.
SAP Taxonomy Designer Working with Files in Taxonomy Designer
© 2014 SAP AG or an SAP affiliate company. All rights reserved.
23
If the file…
Then Taxonomy Designer…
Has an identical date/time stamp but different content from the source file
Does nothing. Taxonomy Designer does not check the contents of the files in the default cache location. Taxonomy Designer opens the file from the 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.
Configuring the Web 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.
To turn off Web caching 1.
Click Tools, highlight Web cache, and then click the checkmark next to Work offline.
Exploring the Web Cache 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.
24
© 2014 SAP AG or an SAP affiliate company. All rights reserved.
SAP Taxonomy Designer Working with Files in Taxonomy Designer
To explore the Web cache 1.
Click Tools, highlight Web cache, and then click Explore.
2.
Use Windows Explorer to review the files in your Web cache.
Clearing the Web Cache 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.
To clear the Web cache 1.
Save and close any open XBRL documents.
2.
Click Tools, click Web Cache, and then click Clear.
SAP Taxonomy Designer Working with Files in Taxonomy Designer
© 2014 SAP AG or an SAP affiliate company. All rights reserved.
25
4
Creating Extension Taxonomies
An extension taxonomy is an entry point (schema) that uses another taxonomy as the starting point (base taxonomy). Extension taxonomies are used to create a set of XBRL files specific to a company, industry, or other business purpose. Extension taxonomies may extend or restrict the usage of the base taxonomy or taxonomies.
4.1
Understanding Extension Taxonomies
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.
Using Extension Taxonomies When Filing with the SEC or IFRS 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 These core concepts include: ●
Elements used for reporting
●
Associated dimensions and hypercubes
●
All of the required relationship arcs and other associations
Modularity Layer The modularity layer includes: ●
Linkbase files for labels and references
●
Specialized taxonomies
26
© 2014 SAP AG or an SAP affiliate company. All rights reserved.
SAP Taxonomy Designer Creating Extension Taxonomies
●
○
SEC: US-GAAP extension taxonomies by industry
○
IFRS: Full and SME (small and medium enterprise) taxonomies
Template presentation and calculation linkbases organized around financial statements and disclosures
4.2
Creating an Extension Taxonomy Using the Wizard
The Edgar Extension Taxonomy wizard provides a streamlined, directed method of creating an extension taxonomy from a selection of standard base taxonomies.
Creating a New Extension Taxonomy Using the Wizard Before beginning to create your extension taxonomy, identify the base taxonomy for your schema.
To create a new extension taxonomy using the Edgar Extension Taxonomy wizard 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: ○
Company web name: your company URL
○
Taxonomy date: the date to apply to this extension taxonomy
○
Prefix or ticker symbol: your company's stock-exchange ticker symbol or a short prefix
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 nonGAAP taxonomy list that should also be referenced. If you are doing an SEC filing, refer to the SEC website
SAP Taxonomy Designer Creating Extension Taxonomies
© 2014 SAP AG or an SAP affiliate company. All rights reserved.
27
or your EDGAR filing manual to determine which combinations are valid and applicable to your filing situation. 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. You can choose to import relationships from three different sources: ○
Import from the base taxonomy.
○
Import custom relationship groups from an XBRL taxonomy or instance document on your computer, the Web, a WebDAV server, or a Microsoft Excel workbook.
○
Import custom relationship groups from a prior filing from and XBRL taxonomy or instance document on your computer, the Web, a WebDAV server, or a Microsoft Excel workbook.
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. ○
28
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
© 2014 SAP AG or an SAP affiliate company. All rights reserved.
SAP Taxonomy Designer Creating Extension Taxonomies
○ 8.
○
Instance - Units
○
Instance - Facts
Import labels of relationship concepts: select the items that you wish to import.
In the Edit relationship groups wizard page, edit the relationships that you just imported. When you are finished, click Next. - or If there are additional relationship groups you wish to import, click Back and follow the steps in step 7 again.
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. 9.
Generate dimension and calculation linkbases by clicking Finish.
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.
Creating an Extension Taxonomy based on another Extension Taxonomy Using the Wizard 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.
SAP Taxonomy Designer Creating Extension Taxonomies
© 2014 SAP AG or an SAP affiliate company. All rights reserved.
29
To create an extension taxonomy from a taxonomy on your computer or the Internet using the Edgar Extension Taxonomy wizard 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.
30
© 2014 SAP AG or an SAP affiliate company. All rights reserved.
SAP Taxonomy Designer Creating Extension Taxonomies
5
Authoring a Taxonomy
XBRL Taxonomies are the dictionaries which the XBRL language uses. These are the categorization schemes which define the specific tags for individual items of data (such as "net profit"). Authoring in Taxonomy Designer allows you to build a schema that covers your specific business reporting needs.
5.1
Understanding the Taxonomy Design Process
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: ●
Create a new taxonomy.
●
Create an extended link.
●
Define one or more root concepts.
●
Define all other concepts, contexts, and labels.
●
Generate linkbases for presentation, labels, calculations and other views.
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.
5.2
Creating a New Taxonomy
Use the File New Taxonomy command to begin creating a new taxonomy.
To create a new taxonomy 1.
Click File, click New, and then click Taxonomy.
2.
In the New Taxonomy dialog box, enter the required information: ○
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
SAP Taxonomy Designer Authoring a Taxonomy
© 2014 SAP AG or an SAP affiliate company. All rights reserved.
31
○
File name -- the name for the taxonomy's schema file
○
Suffix style -- the naming convention to be used for the linkbase files that may be generated for the taxonomy. There are four suffix-style options: Classical, us-gaap, SEC, and IFRS.
5.3
Creating an Extended Link
The Presentation view provides a way to see that all of the desired line items for a report are included. For a financial report, this would typically be a hierarchy where the line items are in the same order as in a financial statement. 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. The process consists of: ●
Adding an extended link under which to group related concepts,
●
Defining one or more root concept(s), and
●
Creating the child elements.
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.
To add an extended link 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: ○
Create a new taxonomy.
○
Create an extended link.
○
Define one or more root concepts.
○
Define all other concepts, contexts, and labels.
○
Generate linkbases for presentation, labels, calculations and other views.
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.
32
© 2014 SAP AG or an SAP affiliate company. All rights reserved.
SAP Taxonomy Designer Authoring a Taxonomy
Creating a New Taxonomy on page 36). 2.
In the Presentation pane, click the Presentation node, and then right-click to open the context menu. Click Add, and then click Extended Link.
3.
In the Choose Extended Link Role dialog box, you can choose one of two options: ○
To use the standard extended link definition, click OK ( defined by XBRL.org in the 2003 standards.
○
To create a custom extended link definition, click Add New Extended Link ( enter a description of the extended link role and then click OK.
). This extended link uses the role "link" as
). In the Definition field,
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.
5.4
Creating a Root Concept
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.
To create a root concept 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.
SAP Taxonomy Designer Authoring a Taxonomy
© 2014 SAP AG or an SAP affiliate company. All rights reserved.
33
5.5
Defining Concepts
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.
5.6
About Concept Fields
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. Concept Field
Permitted Values and Description
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.
ID
An ID is used to further identify an element or concept and contains a string without spaces that is unique to this concept; it must begin with a letter and can include letters,
34
© 2014 SAP AG or an SAP affiliate company. All rights reserved.
SAP Taxonomy Designer Authoring a Taxonomy
Concept Field
Permitted Values and Description 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.
Fixed
Allows you to set the fact value to a particular fact.
References
References relate the definitions of concepts in authoritative statements in published business, financial, and accounting literature. References should help the user find ma terials relevant to understanding appropriate usage of the concept, but does not include the actual reference materials.
5.7
About Fact Fields
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. Fact Field
Description
Concept
The name of the concept associated with this fact.
Line
The line number of the fact in instance display grid.
ContextRef
The ID of the context referred to by this fact.
EntityIdentifier
The URI (identifier) of the reporting entity.
UnitRef
The name of the unit referred to by this fact.
SAP Taxonomy Designer Authoring a Taxonomy
© 2014 SAP AG or an SAP affiliate company. All rights reserved.
35
Fact Field
Description
IsNil
True or false; if true, no fact value has been entered for this fact.
Decimals
The number of decimal places to use for numeric facts.
Precision
The number of significant digits for numeric facts.
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.
5.8
Hiding or Deleting Concepts
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 relationships or Delete Subtree relationships
36
© 2014 SAP AG or an SAP affiliate company. All rights reserved.
Delete Subtree
Concept and
commands to delete the relationships down the tree.
SAP Taxonomy Designer Authoring a Taxonomy
Prohibiting a Relationship 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.
To prohibit a subtree 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 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.
5.9
Defining Tuples
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.
SAP Taxonomy Designer Authoring a Taxonomy
© 2014 SAP AG or an SAP affiliate company. All rights reserved.
37
Example In your taxonomy, you might wish to include some background information about your company. It might be helpful to create a tuple called Company Details with child concepts including Company Name, Company Address, and Company Website. Within the Company Details tuple, the Company Address and Company Website concepts are also tuples, each containing concepts representing specific information related to the tuple grouping, such as Website Description and Website URL. 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].
3.
○
Label: visible text that identifies the tuple to taxonomy users.
○
Name: short name that is encoded as the unique identifier for the tuple; Taxonomy Designer fills this field for you after you enter a label.
○
Data Type: specifies the kind of information to be reported as fact values for the tuple; since tuples are abstract concepts, choose string from the list.
○
Substitution Group: choose xbrl:tuple.
○
Abstract: indicates that this tuple concept does not contain any fact values, so choose true.
○
Add Attribute: (optional) allows you to directly enter XML attributes for the tuple.
○
Add Reference: (optional) allows you to add reference parts to the tuple.
Click Add to add the tuple to the taxonomy. It is displayed in the Presentation view.
5.10 Creating Labels 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.
38
© 2014 SAP AG or an SAP affiliate company. All rights reserved.
SAP Taxonomy Designer Authoring a Taxonomy
To create a label 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: 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 dialog box, enter the following information: ○
Label Value: (required) label text
○
Label Role: (required) label roles
○
Language: (required) language for this label
6.
Click the Language drop-down list.
7.
Click Others .
8.
In the drop down list at the bottom of the dialog box, select the language to use for this label and then click OK. ○
9.
Title: (optional) title for this label
Click Add.
5.11
Using Drag and Drop
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.
SAP Taxonomy Designer Authoring a Taxonomy
© 2014 SAP AG or an SAP affiliate company. All rights reserved.
39
Note If you hover over a place where the concept cannot be moved, the Prohibited icon appears in place of your cursor. 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.
5.12 Generating Linkbases 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.
Generating a Label Linkbase 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].
To save the default label linkbase 1.
Open the taxonomy that you want to use.
2.
Click File and then click Save As.
3.
In the Save DTS Files dialog box, configure Save Options:
4.
○
Local directory, ZIP file, or WebDAV directory
○
Indicate the location for the files in the path field
○
Which files to save: choose Changed files
○
In the file list, select the label linkbase and any other files you would like to save
Click Save.
Exporting a Label Linkbase 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
40
© 2014 SAP AG or an SAP affiliate company. All rights reserved.
SAP Taxonomy Designer Authoring a Taxonomy
create a file that contains labels for a single language or role. Before generating the label linkbase, edit the taxonomy to include the label text you wish to include in the linkbase.
To export a label linkbase 1.
Open the taxonomy that you want to use.
2.
If you want to save a label linkbase for a particular language, click Tools, click Preferences, and then change the Default language to the language you would like to export. Click OK to change the displayed language.
3.
Click File and then click Export.
4.
In the Export DTS dialog box, select all parameters required for the label linkbase. ○
Export format: choose XML
○
File name: enter a file name
○
Export type: choose Labels
○
Top Element: indicate the top element to use for the export. For a label linkbase, choose TaxonomyTable.
○
Export Order: choose either Concept (order by name) or Concept (order by label). Specify the number of spaces to use when indenting the tree (the default is 4).
○
Export Options: choose the information that applies. ○
Element information only is selected by default.
○
Current language only should be selected if you wish to generate a label linkbase that contains a single language.
○
Current role only should be selected if you wish to restrict the generated linkbase by role.
○
Documentation should be selected if you wish to include labels in the documentation role in addition to the labels for the current role.
○
Label rows across columns is not available for a label linkbase export.
5.
Click Save (
6.
Click Preview to see the label linkbase contents in a table before performing the export.
) to create the label linkbase file.
7.
Click Start to export the label linkbase.
Generating a Calculation Linkbase 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.
SAP Taxonomy Designer Authoring a Taxonomy
© 2014 SAP AG or an SAP affiliate company. All rights reserved.
41
To generate a calculation linkbase 1.
Open the taxonomy and navigate to Presentation view.
2.
Click Tools, point to Generate Linkbases, point to Xbrl-US, and then click Generate Calculation Linkbase.
3.
Save the linkbase using the
42
File
Save As … command.
© 2014 SAP AG or an SAP affiliate company. All rights reserved.
SAP Taxonomy Designer Authoring a Taxonomy
6
Creating Instance Documents
The Taxonomy Designer interface has been created for maximum flexibility and capability. Creating instance documents to validate taxonomies and working with instance documents are tasks of moderate complexity.
6.1
Understanding Instance Documents
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 Documents
An XBRL instance document is a collection of facts defined by the referenced taxonomy 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.
6.2
Creating a New Instance Document
To create a new instance document, you must open a taxonomy or other recognized document. Recognized document types include: ●
Taxonomy files (*.xsd)
●
Linkbase files (*.xml)
●
Instance files (*.xml or *.xbrl)
●
ZIP files containing recognized document types (*.zip)
●
EDGAR XFDL files (*.xfd or *.frm)
Follow one of the procedures below to create an instance document.
SAP Taxonomy Designer Creating Instance Documents
© 2014 SAP AG or an SAP affiliate company. All rights reserved.
43
To create an instance document from a taxonomy file on your computer 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.
To create an instance document from a standard taxonomy available on the Web 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.
To create an instance document from a custom taxonomy available on the Web 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.
6.3
Opening an Instance Document
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.
To open an instance document 1.
Click File, click Open, and then click File.
2.
In the Select XBRL document to load dialog box, change the file type drop down to Instance (*.xml, *.xbrl), navigate to your instance document, and then click Open.
44
© 2014 SAP AG or an SAP affiliate company. All rights reserved.
SAP Taxonomy Designer Creating Instance Documents
3.
Taxonomy Designer loads the instance document and all associated schema and linkbase files. The concepts are presented with their effective values and other information in the Instance Grid view.
Note You can view the discoverable taxonomy set (DTS) by clicking the DTS - tab.
SAP Taxonomy Designer Creating Instance Documents
© 2014 SAP AG or an SAP affiliate company. All rights reserved.
45
7
Understanding Properties
Properties are used to define attributes of XBRL elements such as extended links, concepts, tuples, instances, discoverable taxonomy sets, and others. Taxonomy Designer provides full control over these attributes through the element propertiesr. Properties for any item can be viewed in the Properties pane.
Note If you have closed the Properties pane, you can reopen it by using the
7.1
View
Properties
command.
Extended Link Properties
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.
Definition
A display name for this extended link role.
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.
7.2
Concept Properties
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
46
© 2014 SAP AG or an SAP affiliate company. All rights reserved.
SAP Taxonomy Designer Understanding Properties
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, numbers, hyphens, underscores, colons, and full stops. It cannot begin with the string xml. 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 Properties
The BaseType specifies the atomic, or standard, data type for this concept. The BaseType cannot be changed by a taxonomy user. Possibilities include:
SAP Taxonomy Designer Understanding Properties
●
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
© 2014 SAP AG or an SAP affiliate company. All rights reserved.
47
●
Token
●
unsignedByte
●
unsignedInt
●
unsignedLong
●
unsignedShort
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. ●
An item (xbrl:item) represents a concept with a single, reportable value.
●
A tuple is a grouping of related reportable concepts but it is not itself a reportable concept. The tuple concept (xbrli:tuple) is an abstract concept. The tuple and the concepts it contains are defined using the standard concept properties.
●
A custom substitution group (xbrli:) is user-defined and allows one concept to be substituted with another. This can be useful if you wish to create a template for concept definitions.
Abstract Properties
A concept that cannot contain any fact values is designated as an abstract element. Abstract 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 Properties
The balance property is used when the Type is set to MonetaryItemType. It can be either “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 Properties
Each fact must be connected to a context. If the concept is defined with the Period 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 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. Tuple concepts do not have this attribute.
48
© 2014 SAP AG or an SAP affiliate company. All rights reserved.
SAP Taxonomy Designer Understanding Properties
Nillable Properties
When concepts are defined as nillable true, you can report facts with an isnil attribute in an instance. This provides information; instead of having the potentially-incorrect value “0” or remaining unreported, the fact intentionally has the attribute . If is set to false, the concept must contain a fact value or an error is generated during the validation process.
Tip Set 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 Properties
The optional AddAttribute property allows you to specify XML attributes to be applied to this concept. Enter the attributes without XML brackets.
AddReference Properties
The optional AddReference property allows you to specify reference parts to be applied to this concept. Additional dialog boxes allow you to create new reference parts if needed. References relate the definitions of concepts in authoritative statements in published business, financial, and accounting literature. References should help the user find materials relevant to understanding appropriate usage of the concept, but does not include the actual reference materials.
7.3
Tuples Properties
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] .
SAP Taxonomy Designer Understanding Properties
© 2014 SAP AG or an SAP affiliate company. All rights reserved.
49
8
Command Reference
The Taxonomy Designer user interface usually has more than one way to execute a command. Throughout this user guide, most commands have been described using the application's menus, but many commands are available on context-based toolbars or context-driven menus. These shortcuts are described in this chapter.
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. Menu item and keyboard shortcut
Used to
New ALT + F , N
Create a new XBRL taxonomy.
●
Taxonomy ALT + F , N , T
●
Instance of Taxonomy from File ALT + F, N, I, F
● ●
Create a new instance document referencing a remote taxonomy Instance of Taxonomy from Web ALT + (using the Web or a WebDAV server). F, N, I, B
Edgar Extension Taxonomy ALT + F , N, E
Open ALT + F , O ●
File ALT + F , O , F
●
Web ALT + F , O , W
Attach ALT + F , T ●
Folder ALT + F , T , O
●
File ALT + F , T , F
●
Web ALT + F , T , W
Reference ALT + F , F ●
50
Create a new XBRL instance document referencing a local file sys tem taxonomy.
from Instance ALT + F , F , I ○
File ALT + F , F , I , F
○
Web ALT + F , F , I , W
Create a new EDGAR extension taxonomy using the Extension Taxonomy Wizard. Open an XBRL document from the local computer or mapped net work drive. Open an XBRL document file from the Internet or a WebDAV server. Attach an XBRL document such as a label or formula linkbase to the loaded taxonomy temporarily for use during this session from a local file, a network folder, or the Web (Internet or WebDAV server).
From this taxonomy, reference a specified XBRL document (cre ates a permanent reference in the schema). Add the taxonomy schema references to the loaded DTS based upon the schemas referenced in the instance document on the lo cal computer or the Web (Internet or WebDAV server).
© 2014 SAP AG or an SAP affiliate company. All rights reserved.
SAP Taxonomy Designer Command Reference
Menu item and keyboard shortcut
Used to
●
Reference a taxonomy on the local computer or the Web (Internet or WebDAV server).
from Taxonomy ALT + F , F , T ○
File ALT + F , F , T , F
○
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. You must open an XBRL document before importing another file.
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.
Exit ALT + F , X
Close Taxonomy Designer.
View Menu Command Reference 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. Menu item and keyboard shortcut
Used to
Add Tree View ALT + V , R
Adds a tree-type view of the selected type.
●
Presentation ALT + V , R , P
●
Calculation ALT + V , R , C
●
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
SAP Taxonomy Designer Command Reference
Choosing Other Relations… opens a dialog box where you can choose the arcrole for the tree view display.
Adds a grid-type view of the selected type.
© 2014 SAP AG or an SAP affiliate company. All rights reserved.
51
Menu item and keyboard shortcut
Used to
●
Presentation ALT + V , G , P
●
Calculation ALT + V , G , C
Choosing Other Relations… opens a dialog box where you can 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. When a concept is selected, the View XML command will go to the definition of that concept in the schema.
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.
Tools Menu Command Reference The Tools menu provides access to the features related to wizards, validation, server access, and preferences. Menu item and keyboard shortcut
Used to
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
●
Calculations ALT + T , V , C
●
Formulas ALT + T , V , F
52
Executes XBRL Calculations on an XBRL instance document ensur ing that the data reported is consistent. Validates that the XBRL formulas are well formed and the XBRL is valid.
© 2014 SAP AG or an SAP affiliate company. All rights reserved.
SAP Taxonomy Designer Command Reference
Menu item and keyboard shortcut
Used to
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 view.
●
XBRL-US ALT + T , L , X ○
Generate Calculation Linkbase ALT Creates a dimension linkbase based upon the XBRL presentation view, inferring the necessary hypercubes, dimensions, and dimen Generate Dimension Linkbase ALT sional members.
+ T, L, X, C
○
+ T, L, X, D
Wizards ALT + T , Z ●
Edgar Extension Taxonomy ALT + T , Z, E
Web Cache ALT + T , W ●
Work Offline ALT + T , W , O
●
Explore ALT + T , W , E
●
Clear ALT + T , W , L
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]. The application will not attempt to refresh Web-linked files. If a file is available in the Web cache it will be used. Opens the application's Web cache directory in a Windows Explorer window. Deletes all files from the Web cache directory.
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]
Preferences ALT + T , P
Configure user preferences and available elements in taxonomies and instance documents. See User Preferences [page 14].
Windows Menu Command Reference The Windows menu provides access to the windows currently open in your workspace. Menu item and keyboard shortcut
Used to
> ALT + W
The Windows menu lists each pane that is currently open in the in terface.
SAP Taxonomy Designer Command Reference
© 2014 SAP AG or an SAP affiliate company. All rights reserved.
53
8.2 Standard Windows Keyboard Shortcuts Available in Taxonomy Designer The following standard Windows keyboard shortcuts are available in Taxonomy Designer. Shortcut
Command
CTRL + N
Create a new taxonomy.
CTRL + O
Open a file from the local file system.
ALT + SHIFT + O
Open a file from the Web or a WebDAV server.
CTRL + F
Find text within the current pane.
CTRL + P
Print (print dialog varies based on taxonomy or instance view that has the current fo cus).
CTRL + W
Close a file.
CTRL + S
Save a file.
ALT + F4
Exit application.
F1
Open online Help.
8.3
Toolbars
Toolbars make many commands easier to access. When you first open Taxonomy Designer, the toolbar is very New , File Open Local , and File Open Web command icons simple, with only the File 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.
Presentation View Toolbar After creating or loading a taxonomy, the presentation view toolbar will open.
54
© 2014 SAP AG or an SAP affiliate company. All rights reserved.
SAP Taxonomy Designer Command Reference
Icon
Command New taxonomy or instance document (on the File menu) Open local file (on the File menu) Open file from web location (on the File menu) Save XBRL files (on the File menu) Close DTS (taxonomy or instance) (on the File menu) Insert extended link (available on context-sensitive menus) Insert sibling concept (available on context-sensitive menus) Insert child concept (available on context-sensitive menus) Move concept down (available on context-sensitive menus) Move concept up (available on context-sensitive menus) Delete concept (available on context-sensitive menus) Validate DTS (available on the Tools menu) Find options (not available on the menus)
Instance Grid Toolbar After creating or loading an instance document, the instance grid toolbar will open.
Icon
Command New taxonomy or instance document (on the File menu) Open local file (on the File menu) Open file from web location (on the File menu)
SAP Taxonomy Designer Command Reference
© 2014 SAP AG or an SAP affiliate company. All rights reserved.
55
Icon
Command Save XBRL files (on the File menu) Close DTS Views (on the File menu) Insert fact above (available on the context menu) Insert fact below (available on the context menu) Delete fact(s) (available on the context menu) Validate DTS (available on the Tools menu) Find options (not available on the menus)
Multi-Dimension Grid Toolbar After loading an instance document with multi-dimensional data, icons will be added to the toolbar.
Icon
Command New taxonomy or instance document (on the File menu) Open local file (on the File menu) Open file from web location (on the File menu) Save XBRL files (on the File menu) Close DTS Views (on the File menu) Arrange Rows & Cols Dimensions Insert fact (available on the context menu) Delete fact(s) (available on the context menu) Validate DTS (available on the Tools menu)
56
© 2014 SAP AG or an SAP affiliate company. All rights reserved.
SAP Taxonomy Designer Command Reference
Icon
Command Find options
Formula Views Toolbar 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 taxonomy or instance document (on the File menu) Open local file (on the File menu) Open file from web location (on the File menu) Save XBRL files (on the File menu) Close DTS Views (on the File menu) New formula Save variable set edits to DTS Execute formula Find options
8.4
Context Menus
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.
SAP Taxonomy Designer Command Reference
© 2014 SAP AG or an SAP affiliate company. All rights reserved.
57
Presentation and Calculation Tree View Context Menus In the Presentation and Calculation tree views, right-click or press SHIFT + F10 to open the context menu. Menu item and keyboard shortcut
Used to
View SHIFT + F10 , V
Show the presentation view.
●
Presentation SHIFT + F10 , V , P
●
Calculation SHIFT + F10 , V , C
●
Dimensions SHIFT + F10 , V , D
●
Other relations SHIFT + F10 , V , R
Open arcrole dialog to view other relations tree views.
●
Tuples SHIFT + F10 , V , T
●
Element Qname SHIFT + F10 , V , Q
Show the tuples tree view.
●
Language SHIFT + F10 , V , A
●
Label Role SHIFT + F10 , V , O
Choose the label language to display.
●
XML SHIFT + F10 , V , X
Choose the label role to display.
Show the calculation tree view. Show the dimensions tree view.
Show an element's Qname.
Show XML formatting of selected item. Show SHIFT + F10 , W ●
Add Another Relationships Pane SHIFT + F10 , W , A
Close a relationships pane.
○
Presentation tree SHIFT + F10 , W , A , P
○
Calculation tree SHIFT + F10 , W , A , C
○
Dimensions tree SHIFT + F10 , W , A , D
○
Other tree SHIFT + F10 , W , A , O
○
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 SHIFT + F10 , F , C
●
Matching SHIFT + F10 , F , M
●
Range SHIFT + F10 , F , R
●
Set SHIFT + F10 , F , S
Sort SHIFT + F10 , S ●
Ascending SHIFT + F10 , S , A
●
Descending SHIFT + F10 , S , D
Remove Childless Node SHIFT + F10 , M
58
Open another tree view or grid view pane. The most common views are listed and others can be chosen.
© 2014 SAP AG or an SAP affiliate company. All rights reserved.
Update other panes to reflect changes made in the Pre sentation view. Update the Presentation view to reflect changes made in other panes.
Clear the extended link filter. Filter by matching the first letter of the selected extended link. Filter by matching all extended links between selected extended links by first letter. Filter the selected extended links. Change the order in which items are displayed.
Remove a concept that has no child concepts under it.
SAP Taxonomy Designer Command Reference
Menu item and keyboard shortcut
Used to
Delete SHIFT + F10 , D
Remove the selected extended link.
●
Extended Link SHIFT + F10 , D , E
●
Concept SHIFT + F10 , D , C
●
Relationship SHIFT + F10 , D , R
●
Subtree SHIFT + F10 , D , S ○
Concept and Relationships SHIFT + F10 , D , S , C
○
Relationships Only SHIFT + F10 , D , S , R
Prohibit SHIFT + F10 , H ●
Relationship SHIFT + F10 , H , R
●
Subtree Relationships SHIFT + F10 , H , S
Cut SHIFT + F10 , U ●
Concept SHIFT + F10 , U , C
●
Relationship SHIFT + F10 , U , R
●
Subtree SHIFT + F10 , U , S ○
Concept and Relationships SHIFT + F10 , U , S , C
○
Relationships Only SHIFT + F10 , U , S , R
Remove the selected concept. Break the relationship between a selected concept and another. Delete an entire selected subtree (concept and relation ships). Delete a selected subtree's relationships (leave the con cepts intact).
Set an attribute preventing a relationship between this concept and its parent. Set an attribute preventing relationships between this concept and its children. Removes elements from the view and places them on the Taxonomy Designer clipboard. Remove concept from the view and place it on the clip board. Remove relationship and place it on the clip board. Remove an entire selected subtree (concepts and rela tionships) and place it on the clipboard. Remove the relationships between elements in a se lected subtree and place them on the clipboard.
Copy SHIFT + F10 , C ●
Concept SHIFT + F10 , C , C
●
Relationship SHIFT + F10 , C , R
●
Subtree SHIFT + F10 , C , S ○
Concept and Relationships SHIFT + F10 , C , S , C
○
Relationships Only SHIFT + F10 , C , S , R
Leaves elements in the view and also places them on the Taxonomy Designer clipboard. Keep concept in the view and place a copy on the clip board. Keep relationship in the view and place a copy on the clipboard. 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.
Paste SHIFT + F10 , P
Paste a concept, relationship, or subtree from another view.
Expand SHIFT + F10 , X
Open the selected node.
Collapse SHIFT + F10 , O
Close the selected node.
Refresh SHIFT + F10 , R
Refresh the current view.
SAP Taxonomy Designer Command Reference
© 2014 SAP AG or an SAP affiliate company. All rights reserved.
59
Console and Messages Context Menus In the Console and Messages panes, right-click or press SHIFT + F10 to open the context menu. Menu item and keyboard shortcut
Used to
Clear SHIFT + F10 , L
Clear all messages from the pane.
Copy SHIFT + F10 , C
Copy all messages to the clipboard.
Save SHIFT + F10 , S
Save all messages in a text file.
Discoverable Taxonomy Set (DTS) Tree View Context Menu In the Discoverable Taxonomy Set (DTS) tree view, right-click or press SHIFT + F10 to open the context menu. Menu item and keyboard shortcut
Used to
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
Expand SHIFT + F10 , X
Open the selected node.
Collapse SHIFT + F10 , O
Close the current node.
Refresh SHIFT + F10 , R
Refresh the current view.
Dimensions Tree View Context Menu In the Dimensions tree view, right-click or press SHIFT + F10 to open the context menu. Menu item and keyboard shortcut
Used to
View SHIFT + F10 , V
Show the presentation view.
●
Presentation SHIFT + F10 , V , P
●
Calculation SHIFT + F10 , V , C
●
Other relations SHIFT + F10 , V , R
●
Tuples SHIFT + F10 , V , T
Show the tuples tree view.
●
Element Qname SHIFT + F10 , V , Q
●
Language SHIFT + F10 , V , A
Show an element's Qname.
●
Label Role SHIFT + F10 , V , O
●
XML SHIFT + F10 , V , X
Show the calculation tree view. Open arcrole dialog to view other relations tree views.
Choose the label language to display. Choose the label role to display. Show XML formatting of selected item.
60
© 2014 SAP AG or an SAP affiliate company. All rights reserved.
SAP Taxonomy Designer Command Reference
Menu item and keyboard shortcut
Used to
Show SHIFT + F10 , W
Open another tree view or grid view pane. The most common views are listed and others can be chosen.
●
Add Another Relationships Pane SHIFT + F10 , W , A
Close a relationships pane.
○
Presentation tree SHIFT + F10 , W , A , P
○
Calculation tree SHIFT + F10 , W , A , C
○
Dimensions tree SHIFT + F10 , W , A , D
○
Other tree SHIFT + F10 , W , A , O
○
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
Update other panes to reflect changes made in the Pre sentation view. Update the Presentation view to reflect changes made in other panes.
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.
●
Arc Role SHIFT + F10 , N , A
Filter SHIFT + F10 , F ●
Clear SHIFT + F10 , F , C
●
Matching SHIFT + F10 , F , M
●
Range SHIFT + F10 , F , R
●
Set SHIFT + F10 , F , S
Clears the extended link filter. Filter by matching the first letter of the selected ex tended link. Filter by matching all extended links between selected extended links by first letter. Filter the selected extended links.
Sort SHIFT + F10 S ●
Ascending SHIFT + F10 S , A
●
Descending SHIFT + F10 S , D
Add SHIFT + F10 A ●
Extended Link SHIFT + F10 A , E
●
Child SHIFT + F10 A , C
●
Sibling SHIFT + F10 A , S
Change the order in which items are displayed.
Add a new extended link. Add a child concept under the selected concept. Add a sibling concept next to the selected concept.
Remove Childless Node SHIFT + F10 M
Remove a concept that has no child concepts under it.
Delete SHIFT + F10 , D
Remove the selected extended link.
●
Extended Link SHIFT + F10 , D , E
●
Concept SHIFT + F10 , D , C
●
Relationship SHIFT + F10 , D , R
●
Subtree SHIFT + F10 , D , S
SAP Taxonomy Designer Command Reference
Remove the selected concept. Break the relationship between a selected concept and another.
© 2014 SAP AG or an SAP affiliate company. All rights reserved.
61
Menu item and keyboard shortcut ○
Concept and Relationships SHIFT + F10 , D , S , C
○
Relationships Only SHIFT + F10 , D , S , R
Prohibit SHIFT + F10 , H ●
Relationship SHIFT + F10 , H , R
●
Subtree Relationships SHIFT + F10 , H , S
Cut SHIFT + F10 , U
Used to Delete an entire selected subtree (concept and relation ships). Delete a selected subtree's relationships (leave the con cepts intact). Set an attribute preventing a relationship between this concept and its parent. Set an attribute preventing relationships between this concept and its children.
●
Concept SHIFT + F10 , U , C
Removes elements from the view and places them on the Taxonomy Designer clipboard.
●
Relationship SHIFT + F10 , U , R
Remove concept from the view.
●
Subtree SHIFT + F10 , U , S ○
Concept and Relationships SHIFT + F10 , U , S , C
○
Relationships Only SHIFT + F10 , U , S , R
Remove relationship and place it on the clipboard. Remove an entire selected subtree (concepts and rela tionships) and place it on the clipboard. Remove the relationships between elements in a se lected subtree and place them on the clipboard.
Copy SHIFT + F10 , C ●
Concept SHIFT + F10 , C , C
●
Relationship SHIFT + F10 , C , R
●
Subtree SHIFT + F10 , C , S ○
Concept and Relationships SHIFT + F10 , C , S , C
○
Relationships Only SHIFT + F10 , C , S , R
Leaves elements in the view and also places them on the Taxonomy Designer clipboard. Keep concept in the view and place a copy on the clip board. Keep relationship in the view and place a copy on the clipboard. 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.
Paste SHIFT + F10 , P
Paste a concept from another view.
Expand SHIFT + F10 , X
Open the selected node.
Collapse SHIFT + F10 , O
Close the selected node.
Refresh SHIFT + F10 , R
Refresh the current view.
Tuples Tree View Context Menu In the Tuples tree view, right-click or press SHIFT + F10 to open the context menu.
62
© 2014 SAP AG or an SAP affiliate company. All rights reserved.
SAP Taxonomy Designer Command Reference
Menu item and keyboard shortcut
Used to
View SHIFT + F10 , V
Choose the label language to display.
●
Language SHIFT + F10 , V , A
●
Label Role SHIFT + F10 , V , O
●
XML SHIFT + F10 , V , X
Show SHIFT + F10 , W ●
Add Another Relationships Pane SHIFT + F10 , W , A
Choose the label role to display. Show XML formatting of selected item.
Open another tree view or grid view pane. The most common views are listed and others can be chosen. Close a relationships pane.
○
Presentation tree SHIFT + F10 , W , A , P
○
Calculation tree SHIFT + F10 , W , A , C
○
Dimensions tree SHIFT + F10 , W , A , D
○
Other tree SHIFT + F10 , W , A , O
○
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
Update other panes to reflect changes made in the Tu ples view. Update the Tuples view to reflect changes made in other panes.
Paste SHIFT + F10 , P
Paste a concept from another view.
Refresh SHIFT + F10 , R
Refresh the current view.
Presentation, Calculation, and Dimensions Grid View Context Menus In the Presentation, Calculation, and Dimensions grid views, right-click or press SHIFT + F10 to open the context menu. Menu item and keyboard shortcut
Used to
View SHIFT + F10 , V
Choose the label language to display.
●
Language SHIFT + F10 , V , A
●
Label Role SHIFT + F10 , V , O
●
XML SHIFT + F10 , V , X
Show SHIFT + F10 , W ●
Add Another Relationships Pane SHIFT + F10 , W , A
Choose the label role to display. Show XML formatting of selected item.
Open another tree view or grid view pane. The most common views are listed and others can be chosen. Close a relationships pane.
○
Presentation tree SHIFT + F10 , W , A , P
○
Calculation tree SHIFT + F10 , W , A , C
SAP Taxonomy Designer Command Reference
Update other panes to reflect changes made in the se lected view.
© 2014 SAP AG or an SAP affiliate company. All rights reserved.
63
Menu item and keyboard shortcut ○
Dimensions tree SHIFT + F10 , W , A , D
○
Other tree SHIFT + F10 , W , A , O
○
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 SHIFT + F10 , F , C
●
Matching SHIFT + F10 , F , M
●
Range SHIFT + F10 , F , R
●
Set SHIFT + F10 , F , S
Used to Update the selected view to reflect changes made in other panes.
Clears the extended link filter. Filter by matching the first letter of the selected ex tended link. Filter by matching all extended links between selected extended links by first letter. Filter the selected extended links.
Sort SHIFT + F10 , S ●
Ascending SHIFT + F10 , S , A
●
Descending SHIFT + F10 , S , D
Add SHIFT + F10 , A ●
Extended Link SHIFT + F10 , A , E
●
Child SHIFT + F10 , A , C
●
Sibling SHIFT + F10 , A , S
Change the order in which items are displayed.
Add a new extended link. Add a child concept under the selected concept. Add a sibling concept next to the selected concept.
Remove Childless Node SHIFT + F10 , M
Remove a concept that has no child concepts under it.
Delete SHIFT + F10 , D
Remove an extended link.
●
Extended Link SHIFT + F10 , D , E
●
Concept SHIFT + F10 , D , C
●
Relationship SHIFT + F10 , D , R
●
Subtree SHIFT + F10 , D , S ○
Concept and Relationships SHIFT + F10 , D , S , C
○
Relationships Only SHIFT + F10 , D , S , R
Prohibit SHIFT + F10 , H ●
Relationship SHIFT + F10 , H , R
●
Subtree Relationships SHIFT + F10 , H , S
64
© 2014 SAP AG or an SAP affiliate company. All rights reserved.
Remove the selected concept. Break the relationship between a selected concept and another. Delete an entire selected subtree (concept and relation ships). Delete a selected subtree's relationships (leave the con cepts). Set an attribute preventing a relationship between this concept and its parent. Set an attribute preventing relationships between this concept and its children.
SAP Taxonomy Designer Command Reference
Menu item and keyboard shortcut
Used to
Cut SHIFT + F10 , U
Removes elements from the view and places them on the Taxonomy Designer clipboard.
●
Concept SHIFT + F10 , U , C
●
Relationship SHIFT + F10 , U , R
●
Subtree SHIFT + F10 , U , S
Remove concept from the view and place it on the clip board.
○
Remove relationship and place it on the clipboard.
Concept and Relationships SHIFT + F10 , U , S , C
○
Relationships Only SHIFT + F10 , U , S , R
Remove an entire selected subtree (concepts and rela tionships) and place it on the clipboard. Remove the relationships between elements in a se lected subtree and place them on the clipboard.
Copy SHIFT + F10 , C ●
Concept SHIFT + F10 , C , C
●
Relationship SHIFT + F10 , C , R
●
Subtree SHIFT + F10 , C , S ○
Concept and Relationships SHIFT + F10 , C , S , C
○
Relationships Only SHIFT + F10 , C , S , R
Leaves elements in the view and also places them on the Taxonomy Designer clipboard. Keep concept in the view and place a copy on the clip board. Keep relationship in the view and place a copy on the clipboard. 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.
Paste SHIFT + F10 , P
Paste a concept from another view.
Expand SHIFT + F10 , X
Open the selected node.
Collapse SHIFT + F10 , O
Close the selected node.
Refresh SHIFT + F10 , R
Refresh the current view.
Concepts Grid Context Menu In the Concepts grid view, right-click or press SHIFT + F10 to open the context menu. Menu item and keyboard shortcut
Used to
View SHIFT + F10 , V
Choose the label language to display.
●
Language SHIFT + F10 , V , A
●
Label Role SHIFT + F10 , V , O
●
XML SHIFT + F10 , V , X
Show SHIFT + F10 , W
SAP Taxonomy Designer Command Reference
Choose the label role to display. Show XML formatting of selected item.
Open another tree view or grid view pane.
© 2014 SAP AG or an SAP affiliate company. All rights reserved.
65
Menu item and keyboard shortcut
Used to
●
The most common views are listed and others can be chosen.
Add Another Relationships Pane SHIFT + F10 , W , A
○
Presentation tree SHIFT + F10 , W , A , P
○
Calculation tree SHIFT + F10 , W , A , C
○
Dimensions tree SHIFT + F10 , W , A , D
○
Other tree SHIFT + F10 , W , A , O
○
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 SHIFT + F10 , F , C
●
Matching SHIFT + F10 , F , M
●
Range SHIFT + F10 , F , R
●
Set SHIFT + F10 , F , S
Close a relationships pane. Update other panes to reflect changes made in the Concepts grid view. Update the Concepts grid view to reflect changes made in other panes.
Clears the extended link filter. Filter by matching the first letter of the selected ex tended link. Filter by matching all extended links between selected extended links by first letter. Filter the selected extended links.
Sort SHIFT + F10 , S ●
Ascending SHIFT + F10 , S , A
●
Descending SHIFT + F10 , S , D
Change the order in which items are displayed.
Add Concept SHIFT + F10 , D
Add a new concept below the selected item.
Delete Concept SHIFT + F10 , T
Delete the selected concept.
Paste SHIFT + F10 , P
Paste a concept from another view.
Refresh SHIFT + F10 , R
Refresh the current view.
Instance Grid Context Menu In the Instance grid view, right-click or press SHIFT + F10 to open the context menu. Menu item and keyboard shortcut
Used to
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
66
© 2014 SAP AG or an SAP affiliate company. All rights reserved.
SAP Taxonomy Designer Command Reference
Menu item and keyboard shortcut
Used to
View SHIFT + F10 , V
Display the selected item's Qname.
●
Element Qname SHIFT + F10 , V , Q
●
Language SHIFT + F10 , V , A
●
Label Role SHIFT + F10 , V , O
●
XML SHIFT + F10 , V , X
Insert SHIFT + F10 , I ●
Above SHIFT + F10 , I , A
●
Below SHIFT + F10 , I , B
Delete SHIFT + F10 , D ●
Rows SHIFT + F10 , D , R
●
Cells SHIFT + F10 , D , C
Choose the label language to display. Choose the label role to display. Show XML formatting of selected item. Insert a new row above the selection. Insert a new row below the selection . Delete selected rows. Delete selected cells.
Copy to Clipboard SHIFT + F10 , C
Copy selection to the clipboard.
Paste from Clipboard SHIFT + F10 , P
Paste from the keyboard.
Fill SHIFT + F10 , F
Auto-fill cells above the selection using the selected value.
●
Up SHIFT + F10 , F , U
●
Down SHIFT + F10 , F , D
Refresh SHIFT + F10 , R
Auto-fill cells below the selection using the selected value. Refresh the view.
View XML Context Menu In the View XML pane, right-click or press SHIFT + F10 to open the context menu. Menu item and keyboard shortcut
Used to
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.
Paste CTRL + V
Paste the clipboard contents at the insertion point.
Select All SHIFT + F10 , A
Select all XML in the View XML pane.
Outlining SHIFT + F10 , O ●
Expand All SHIFT + F10 , O , E
Use the View XML outlining feature to expand or col lapse the XML code.
●
Collapse All SHIFT + F10 , O , C
Expand all XML items in the file to view attributes. Collapse all items in the file so that a top-level view can be seen.
SAP Taxonomy Designer Command Reference
© 2014 SAP AG or an SAP affiliate company. All rights reserved.
67
Menu item and keyboard shortcut
Used to
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. This does not delete the XML code.
Uncomment Lines SHIFT + F10 , U
Remove XML comment tags from this line so that it will be used when the XML is processed.
Pane Header Context Menu In the header for each pane, right-click to open the context menu. Menu item
Used to
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.
Tab Context Menu On any tab, right-click to open the context menu. Menu item
Used to
Close
Close this pane.
Close All But This
Close all panes except for the selected pane.
Close All
Close all panes.
68
© 2014 SAP AG or an SAP affiliate company. All rights reserved.
SAP Taxonomy Designer Command Reference
Menu item
Used to
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.
Document
Show the current document.
SAP Taxonomy Designer Command Reference
© 2014 SAP AG or an SAP affiliate company. All rights reserved.
69
9
Important Disclaimers on Legal Aspects
This document is for informational purposes only. Its content is subject to change without notice, and SAP does not warrant that it is error-free. SAP MAKES NO WARRANTIES, EXPRESS OR IMPLIED, OR OF MERCHANTABILITY, OR FITNESS FOR A PARTICULAR PURPOSE. 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
70
© 2014 SAP AG or an SAP affiliate company. All rights reserved.
SAP Taxonomy Designer Important Disclaimers on Legal Aspects
SAP Taxonomy Designer Important Disclaimers on Legal Aspects
© 2014 SAP AG or an SAP affiliate company. All rights reserved.
71
www.sap.com/contactsap
© 2014 SAP AG or an SAP affiliate company. All rights reserved.
No part of this publication may be reproduced or transmitted in any form or for any purpose without the express permission of SAP AG. The information contained herein may be changed without prior notice. Some software products marketed by SAP AG and its distributors contain proprietary software components of other software vendors. National product specifications may vary. These materials are provided by SAP AG and its affiliated companies ("SAP Group") for informational purposes only, without representation or warranty of any kind, and SAP Group shall not be liable for errors or omissions with respect to the materials. The only warranties for SAP Group products and services are those that are set forth in the express warranty statements accompanying such products and services, if any. Nothing herein should be construed as constituting an additional warranty. SAP and other SAP products and services mentioned herein as well as their respective logos are trademarks or registered trademarks of SAP AG in Germany and other countries. Please see http://www.sap.com/corporate-en/legal/copyright/ index.epx for additional trademark information and notices.
