Formula Tuples 1.0

Public Working Draft 16 December 2009

Copyright ©2009 XBRL International Inc., All Rights Reserved.

This version:
<http://www.xbrl.org/Specification/formulaTuples/PWD-2009-12-16/formulaTuples-PWD-2009-12-16.html>
Editors:
Herm Fischer, UBMatrix / Mark V Systems <fischer@markv.com>
Victor Morilla, Banco de España <victor.morilla@bde.es>
Andy Harris, UBMatrix <andy.harris@ubmatrix.com>
Contributors:
Cliff Binstock, Coyote Reporting <cliff.binstock@coyotereporting.com>
Paul Bull, Morgan Stanley <paul.bull@morganstanley.com>
Masatomo Goto, Fujitsu <mg@jp.fujitsu.com>
Walter Hamscher, Standard Advantage / Consultant to PricewaterhouseCoopers LLP <walter@hamscher.com>
Ignacio Hernández-Ros, Reporting Estandar S.L. <ignacio@hernandez-ros.com>
Roland Hommes, Rhocon / Consultant to Netherlands Tax and Customs Administration <roland@rhocon.nl>
Andy Harris, UBMatrix <andy.harris@ubmatrix.com>
Takahide Muramoto, Fujitsu <taka.muramoto@jp.fujitsu.com>
Hitoshi Okumura, Fujitsu <okmr@jp.fujitsu.com>
Pablo Navarro Salvador, Atos Origin sae <pablo.navarro@atosorigin.com>
Michele Romanelli, Banca d'Italia <michele.romanelli@bancaditalia.it>
Nathan Summers, CompSci Resources <nathan.summers@compsciresources.com>
Masaru Uchida, Fujitsu <m-uchida@jp.fujitsu.com>

Status

Circulation of this Public Working Draft is unrestricted. This document is normative. Other documents may supersede this document. Recipients are invited to submit comments to formula-feedback@xbrl.org, and to submit notification of any relevant patent rights of which they are aware and provide supporting documentation.

Abstract

This specification is provides the syntax and semantics for generation of tuples by use of an output location aspect and variables-scope relationships.

Table of Contents

1 Introduction
1.1 Background
1.2 Relationship to other work
1.3 Language independence
1.4 Terminology
1.5 Document conventions (non-normative)
1.6 Namespaces and namespace prefixes
1.7 XPath usage
2 Syntax
2.1 Tuple production
2.2 Location rules

Appendices

A Normative schema
B References
C Intellectual property status (non-normative)
D Acknowledgements (non-normative)
E Document history (non-normative)
F Errata corrections in this document

Table

1 Namespaces and namespace prefixes

Examples

1 Producing a tuple with three fact items by variables-scope relationships
2 Producing a tuple with three fact items by instance-variable relationships
3 Location rules

Definitions

location rule
tuple-formula


1 Introduction

The tuples specification provides the means to produce XBRL output instances containing tuples with nested tuples and items.

1.1 Background

This specification is a member of a suite of similar specifications that define specific types of criteria that can be used to produce output tuples constructed by multiple related formula evaluations[FORMULA].

1.2 Relationship to other work

This specification depends upon the XBRL Specification [XBRL 2.1], and the XBRL Variables Specification [VARIABLES]. In the event of any conflicts between this specification and the specifications upon which it depends, this specification does not prevail.

1.3 Language independence

The official language of XBRL International's own work products is English and the preferred spelling convention is UK English.

1.4 Terminology

This specification is consistent with the definitions of any of the terms defined in specifications that it depends on.

1.5 Document conventions (non-normative)

Documentation conventions follow those set out in the XBRL Variables Specification [VARIABLES].

1.6 Namespaces and namespace prefixes

Namespace prefixes [XML NAMES] will be used for elements and attributes in the form ns:name where ns is the namespace prefix and name is the local name. Throughout this specification, the mappings from namespace prefixes to actual namespaces is consistent with Table 1.

The prefix column in Table 1 is non normative. The namespace URI column is normative.

Table 1: Namespaces and namespace prefixes
Prefix Namespace URI
tuple http://xbrl.org/2010/formula/tuple
xbrltuplee http://xbrl.org/2008/filter/variable/instance/error
eg http://example.com/
fn http://www.w3.org/2005/xpath-functions
link http://www.xbrl.org/2003/linkbase
xbrli http://www.xbrl.org/2003/instance
xfi http://www.xbrl.org/2008/function/instance
xbrldi http://xbrl.org/2006/xbrldi
xbrldt http://xbrl.org/2005/xbrldt
xl http://www.xbrl.org/2003/XLink
xlink http://www.w3.org/1999/xlink
xs http://www.w3.org/2001/XMLSchema
xsi http://www.w3.org/2001/XMLSchema-instance
gen http://xbrl.org/2008/generic
variable http://xbrl.org/2008/variable
iso4217 http://www.xbrl.org/2003/iso4217

1.7 XPath usage

XPath usage is identical to that in the XBRL Variables Specification [VARIABLES].

2 Syntax

This specification only provides a textual declaration of syntax constraints when those constraints are not expressed by the normative schema supplied with this specification.

Explanations of elements and attributes are only supplied when explanations are not already provided in other specifications.

Unless explicitly stated otherwise, a reference to a specific element MUST be read as a reference to that element or to any element in its substitution group.

2.1 Tuple production

A tuple is declared by a <tuple:tuple> element. This is an equivalent to the formula intended to produce output tuples (whereas the formula element produces output items).

The syntax for the <tuple:tuple> element is defined by the normative schema supplied with this specification.

Tuples are produced in the output instance by a tuple:tuple element with a source aspect specifying a concept that is a tuple. (The tuple:tuple element is otherwise the same as the formula:formula element.)

The tuple element has all the behavior, semantics, and error conditions of the formula element (other than that of producing a value for an item).

Facts (items and tuples) are produced in the output instance within a containing element by a tuple:tuple element with a location aspect specifying a location aspect that is a containing tuple. In order to access the source tuple, which is in the output instance, either a variables-scope relationship from the source tuple to the contents producing formula is required, or a factVariable in the formula must bind to a tuple in the output instance by means of an instance-variable relationship. (The tuple:tuple element producing an item fact inside a tuple is otherwise the same as the formula:formula element.)

Example 1: Producing a tuple with three fact items by variables-scope relationships
This example shows use of variable-scope relationships to provide an output location of the produced tuple, to be used as the location aspect for dependent nested items. This (variable-scope) approach is the preferred one, because the tuple which is to be the parent of the nested children is unambiguously specified by the variable-scope relationship
Example 2: Producing a tuple with three fact items by instance-variable relationships
This example shows use of instance-variable relationships to provide an output location of the produced tuple, to be used as the location aspect for dependent nested items. This (variable-scope) approach is not preferred, because the tuple which is to be the parent of the nested children is (here) identified by concept name, so if there multiple tuples, the location aspect would be dependent on a fact variable (for tuple aspect) which may become complex to identify. For GL instance production, for example, the variable-scope relationship approach would be simpler. This approach may meet other needs.

2.2 Location rules

A location rule is an aspect rule that addresses the location aspect and that is expressed by the <tuple:location> element.

The syntax for the <tuple:location> element is defined by the normative schema supplied with this specification.

A location rule provides specific rules for constructing the fact in the location (as child) of a tuple in the output context.

The location rule has no child elements, its RAV is its SAV.

Example 3: Location rules
SAV Location rule Output location
t RAV is the SAV Output fact item for this formula has location (as child) of tuple of variabe $t. Tuple t is located in the output instance, either by $t being the result name on a variable-scope relationship, or by $t being a factVariable with an instance-variable relationship to the output instance.

Appendix A Normative schema

The following is the XML schema provided as part of this specification. This is normative. Non-normative versions (which should be identical to these except for appropriate comments indicating their non-normative status) are also provided as separate files for convenience of users of the specification.

NOTE: (non-normative) Following the schema maintenance policy of XBRL International, it is the intent (but is not guaranteed) that the location of non-normative versions of these schemas on the web will be as follows:

  1. While any schema is the most current RECOMMENDED version and until it is superseded by any additional errata corrections a non-normative version will reside on the web in the directory http://www.xbrl.org/2008/ - during the drafting process for this specification this directory should contain a copy of the most recent published version of the schema at http://www.xbrl.org/2010/formula/tuple.xsd.
  2. A non-normative version of each schema as corrected by any update to the RECOMMENDATION will be archived in perpetuity on the web in a directory that will contain a unique identification indicating the date of the update.
  1. While any schema is the most current RECOMMENDED version and until it is superseded by any additional errata corrections a non-normative version will reside on the web in the directory http://www.xbrl.org/2008/. During the drafting process for this specification this directory should contain a copy of the most recent published version of the schema at http://www.xbrl.org/2010/formula-tuple.xsd.
  2. A non-normative version of each schema as corrected by any update to the RECOMMENDATION will be archived in perpetuity on the web in a directory that will contain a unique identification indicating the date of the update.
<schema xmlns:formula="http://xbrl.org/2008/formula" xmlns:variable="http://xbrl.org/2008/variable" xmlns="http://www.w3.org/2001/XMLSchema" xmlns:tuple="http://xbrl.org/2008/formula/tuple" targetNamespace="http://xbrl.org/2008/formula/tuple" elementFormDefault="qualified" attributeFormDefault="unqualified">
<import namespace="http://www.xbrl.org/2003/instance" schemaLocation="http://www.xbrl.org/2003/xbrl-instance-2003-12-31.xsd"/>
<import namespace="http://xbrl.org/2008/formula" schemaLocation="http://www.xbrl.org/2008/formula.xsd"/>
<import namespace="http://xbrl.org/2008/variable" schemaLocation="http://www.xbrl.org/2008/variable.xsd"/>
<!-- tuple generation equivalent to formula:formula omitting precision, decimals, and value -->
<element id="xml-formula-tuple" name="tuple" substitutionGroup="variable:variableSet">
<complexType mixed="true">
<complexContent mixed="true">
<extension base="variable:variableSet.type">
<sequence>
<element ref="formula:aspects" minOccurs="0" maxOccurs="unbounded"/>
</sequence>
<attribute name="source" type="variable:QName" use="optional"/>
</extension>
</complexContent>
</complexType>
</element>
<!-- aspect rule for location -->
<element id="xml-location" name="location" substitutionGroup="formula:abstract.aspect"/>
</schema>

Appendix B References

FORMULA
XBRL International Inc.. "XBRL Formulae 1.0"
Phillip Engel, Herm Fischer, Victor Morilla, Jim Richards, Geoff Shuetrim, David vun Kannon, and Hugh Wallis.
(See http://www.xbrl.org/Specification/formula/CR-2008-12-31/formula-CR-2008-12-31.html)
VARIABLES
XBRL International Inc.. "XBRL Variables 1.0"
Phillip Engel, Herm Fischer, Victor Morilla, Jim Richards, Geoff Shuetrim, David vun Kannon, and Hugh Wallis.
(See http://www.xbrl.org/Specification/variables/REC-2009-06-22/variables-REC-2009-06-22.html)
XBRL 2.1
XBRL International Inc.. "Extensible Business Reporting Language (XBRL) 2.1"
Phillip Engel, Walter Hamscher, Geoff Shuetrim, David vun Kannon, and Hugh Wallis.
(See http://www.xbrl.org/Specification/XBRL-RECOMMENDATION-2003-12-31+Corrected-Errata-2008-07-02.htm)
XML NAMES
W3C (World Wide Web Consortium). "Namespaces in XML 1.0 (Second Edition)"
Tim Bray, Dave Hollander, Andrew Layman, and Richard Tobin.
(See http://www.w3.org/TR/REC-xml-names/)
XML SCHEMA STRUCTURES
W3C (World Wide Web Consortium). "XML Schema Part 1: Structures Second Edition"
Henry S. Thompson, David Beech, Murray Maloney, and Noah Mendelsohn.
(See http://www.w3.org/TR/xmlschema-1/)

Appendix C Intellectual property status (non-normative)

This document and translations of it may be copied and furnished to others, and derivative works that comment on or otherwise explain it or assist in its implementation may be prepared, copied, published and distributed, in whole or in part, without restriction of any kind, provided that the above copyright notice and this paragraph are included on all such copies and derivative works. However, this document itself may not be modified in any way, such as by removing the copyright notice or references to XBRL International or XBRL organizations, except as required to translate it into languages other than English. Members of XBRL International agree to grant certain licenses under the XBRL International Intellectual Property Policy (www.xbrl.org/legal).

This document and the information contained herein is provided on an "AS IS" basis and XBRL INTERNATIONAL DISCLAIMS ALL WARRANTIES, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO ANY WARRANTY THAT THE USE OF THE INFORMATION HEREIN WILL NOT INFRINGE ANY RIGHTS OR ANY IMPLIED WARRANTIES OF MERCHANTABILITY OR FITNESS FOR A PARTICULAR PURPOSE.

The attention of users of this document is directed to the possibility that compliance with or adoption of XBRL International specifications may require use of an invention covered by patent rights. XBRL International shall not be responsible for identifying patents for which a license may be required by any XBRL International specification, or for conducting legal inquiries into the legal validity or scope of those patents that are brought to its attention. XBRL International specifications are prospective and advisory only. Prospective users are responsible for protecting themselves against liability for infringement of patents. XBRL International takes no position regarding the validity or scope of any intellectual property or other rights that might be claimed to pertain to the implementation or use of the technology described in this document or the extent to which any license under such rights might or might not be available; neither does it represent that it has made any effort to identify any such rights. Members of XBRL International agree to grant certain licenses under the XBRL International Intellectual Property Policy (www.xbrl.org/legal).

Appendix D Acknowledgements (non-normative)

This document could not have been written without the contributions of many people including the participants in the Formula Working Group.

Appendix E Document history (non-normative)

DateAuthorDetails
13 December 2010Herm Fischer

First internal working draft created, drawing extensively on wiki page discussions in 2008 and early 2009, discussions with Fujitsu team at Bank of Japan hosted meeting in early 2009, and initial UBmatrix implementation.

Appendix F Errata corrections in this document

This appendix contains a list of the errata that have been incorporated into this document. This represents all those errata corrections that have been approved by the XBRL International Formula Working Group up to and including 16 December 2009. Hyperlinks to relevant e-mail threads may only be followed by those who have access to the relevant mailing lists. Access to internal XBRL mailing lists is restricted to members of XBRL International Inc.

No errata have been incorporated into this document.