# Conformance test definition 1.0

## Recommendation 22 June 2009

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

This version:
  <http://www.xbrl.org/Specification/conformance/REC-2009-06-22/conformance-REC-2009-06-22.html>
Editor:
  Geoff Shuetrim, Galexy <geoff@galexy.net>

## Status

Circulation of this Recommendation is unrestricted. This document is normative. 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 defines a syntax for a generic conformance suite test. Specific types of tests will need to customise this generic conformance suite test to support documentation of the specific inputs and outputs being tested.

# 1 Introduction

This specification defines a syntax for a generic conformance suite test. Specific types of tests will need to customise this generic conformance suite test to support documentation of the specific inputs and outputs being tested.

## 1.1 Background

This specification is intended to support the creation, maintenance, and publication of XBRL conformance suites.

## 1.2 Relationship to other work

This specification works with the XBRL registry specification.

## 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
--- | ---
`conf` | `http://xbrl.org/2008/conformance`
`confe` | `http://xbrl.org/2008/conformance/error`
`xml` | `http://www.w3.org/XML/1998/namespace`
`xlink` | `http://www.w3.org/1999/xlink`

# 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 Attributes in the XML namespace

Any attribute in the XML namespace (`http://www.w3.org/XML/1998/namespace`) MAY be used on any element within a test case.

The `@xml:lang` attribute MAY be used to indicate the language used to express information in the test case, as per the XML Specification [XML].

The `@xml:base` attribute MAY be used when resolving URIs as per the XML Base Specification [XMLBASE].

## 2.2 Element: testcase

A test case is an XML resource with the `<conf:testcase>` element as its root.

### 2.2.1 Element: owners

The optional `<conf:owners>` element contains one or more `<reg:owner>` elements, as defined in the XBRL registry specification [REGISTRY].

Each owner is a person with responsibility for maintaining the test case. Without using this element, test case history relies upon information in the source control system being used.

### 2.2.2 Element: number

The `<conf:number>` element contains the identifying number of the conformance suite test. That number SHOULD be unique among all tests in the entire suite.

### 2.2.3 Element: name

The `<conf:name>` element contains a brief name of the test case

### 2.2.4 Element: documentation

The `<reg:documentation>` element contains either a URL that resolves to documentation of the test case or it contains XHTML [XHTML] markup documenting the test case.

### 2.2.5 Element: reference

The `<conf:reference>` element contains a link to a a part of a specification that is relevant to the test case.

The `<conf:reference>` element contains an `@xlink:type` attribute that equals `simple` and an `@xlink:href` attribute that contains a URI that MUST resolve to the part of the specification being referenced.

The `<conf:reference>` element MAY contain string content documenting the nature of the resource that the URL is linking to.

A test case MAY contain several references, if the test case addresses several aspects of a specification or several specifications.

### 2.2.6 Element: variation

A test case variation is an XML resource with the `<conf:variation>` element as its root.

The `<conf:variation>` element contains the information about a specific variation of the test case.

A test case variation contains many of the same elements as a test case. In particular, it MAY contain its own elements documenting the owners, its number and name, its own documentation, and its references to normative specifications. All of these except for the documentation are optional. The syntax for all of this information matches that for the same information at the level of the test case.

Each test case variation also documents its specific inputs and expected outputs.

#### 2.2.6.1 Element: inputs

The `<conf:inputs>` element contains a list of elements, one per input to the test case variation.

Each element in a `<conf:inputs>` element MUST be in the substitution group for the abstract `<conf:input>` element. This enables different kinds of conformance suites to specify appropriate kinds of inputs.

The syntax for the input files is defined as part of the generic conformance test syntax because input files are common to a broad range of conformance suite tests.

##### 2.2.6.1.1 Input files

Three different kinds of input files are defined as inputs to function test case variations. Input schema files are identified by a `<conf:schema>` element; input linkbase files are identified by a `<conf:linkbase>` ; and input instance files are identified by a `<conf:linkbase>` element.

All three of these elements have the same content model.

The `@id` attribute is required on all of them to enable them to be referenced by other parts of the test case variation.

If the elements have a `@readMeFirst` attribute equal to `true` then they are a starting point for the DTS discovery process that MUST occur as part of initialising the software to perform the test case variation. Otherwise the file MUST NOT be used as a starting point for the DTS discovery process.

The elements also contain an `@xlink:type` attribute that equals `simple` and an `@xlink:href` attribute that contains a URI that MUST resolve to the file that it identifies.

The elements MAY contain string content documenting the nature of the resource that the URL is linking to.

#### 2.2.6.2 Element: outputs

The `<conf:outputs>` element contains a list of elements, one per output from the test case variation.

Each element in a `<conf:outputs>` element MUST be in the substitution group for the abstract `<conf:output>` element. This enables different kinds of conformance suites to specify appropriate kinds of outputs.

##### 2.2.6.2.1 Output error codes

Syntax for an output QName error code is provided as part of the generic conformance test syntax because of the general need for such codes.

Output error codes are expressed by the `<conf:error>` element. Its QName value is the QName of the error code that MUST be produced by software running the conformance suite test if the software is to pass the test.

### 2.2.7 Element: revisions

The optional `<reg:revisions>` element conforms to the XBRL registry specification [REGISTRY]. It provides a syntax for tracking explanations of changes to the conformance suite tests. This is intended to augment the information captured in source control systems, should such augmentation be required.

# 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/2008/conformance.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.

<xs:schema
xmlns:reg="http://xbrl.org/2008/registry"
xmlns:xs="http://www.w3.org/2001/XMLSchema"
xmlns:xlink="http://www.w3.org/1999/xlink"
xmlns="http://xbrl.org/2008/conformance" targetNamespace="http://xbrl.org/2008/conformance" elementFormDefault="qualified" attributeFormDefault="unqualified">
<xs:import namespace="http://xbrl.org/2008/registry" schemaLocation="registry.xsd"/>
<xs:import namespace="http://www.w3.org/1999/xlink" schemaLocation="http://www.xbrl.org/2003/xlink-2003-12-31.xsd"/>
<xs:element id="xml-testcase" name="testcase" substitutionGroup="reg:test">
<xs:complexType>
<xs:sequence>
<xs:element id="xml-owners" name="owners" type="reg:owners.elt.type" minOccurs="0"/>
<xs:element id="xml-number" name="number" type="number.elt.type"/>
<xs:element id="xml-name" name="name" type="name.elt.type"/>
<xs:element id="xml-documentation" name="documentation" type="reg:documentation.elt.type"/>
<xs:element id="xml-reference" name="reference" type="reg:url.elt.type" minOccurs="0" maxOccurs="unbounded"/>
<xs:element id="xml-variation" name="variation" type="variation.elt.type" maxOccurs="unbounded"/>
<xs:element id="xml-revisions" name="revisions" type="reg:revisions.elt.type" minOccurs="0"/>
</xs:sequence>
<xs:attributeGroup ref="reg:common.attribute.group"/>
</xs:complexType>
</xs:element>
<xs:complexType name="number.elt.type">
<xs:simpleContent>
<xs:extension base="xs:string">
<xs:attributeGroup ref="reg:common.attribute.group"/>
</xs:extension>
</xs:simpleContent>
</xs:complexType>
<xs:complexType name="name.elt.type">
<xs:simpleContent>
<xs:extension base="xs:string">
<xs:attributeGroup ref="reg:common.attribute.group"/>
</xs:extension>
</xs:simpleContent>
</xs:complexType>
<xs:complexType name="variation.elt.type">
<xs:sequence>
<xs:element name="owners" type="reg:owners.elt.type" minOccurs="0"/>
<xs:element name="number" type="number.elt.type" minOccurs="0"/>
<xs:element name="name" type="name.elt.type" minOccurs="0"/>
<xs:element name="documentation" type="reg:documentation.elt.type"/>
<xs:element name="reference" type="reg:url.elt.type" minOccurs="0" maxOccurs="unbounded"/>
<xs:element id="xml-inputs" name="inputs" type="inputs.elt.type"/>
<xs:element id="xml-outputs" name="outputs" type="outputs.elt.type"/>
</xs:sequence>
<xs:attributeGroup ref="reg:common.attribute.group"/>
</xs:complexType>
<xs:complexType name="inputs.elt.type">
<xs:sequence>
<xs:element ref="input" maxOccurs="unbounded"/>
</xs:sequence>
<xs:attributeGroup ref="reg:common.attribute.group"/>
</xs:complexType>
<xs:element name="input" abstract="true"/>
<xs:element name="schema" type="input.file.elt.type" substitutionGroup="input"/>
<xs:element name="linkbase" type="input.file.elt.type" substitutionGroup="input"/>
<xs:element name="instance" type="input.file.elt.type" substitutionGroup="input"/>
<xs:complexType name="input.file.elt.type">
<xs:complexContent>
<xs:extension base="xs:anyType">
<xs:attribute ref="xlink:type" use="required" fixed="simple"/>
<xs:attribute ref="xlink:href" use="required"/>
<xs:attribute name="readMeFirst" type="xs:boolean" use="optional" default="false"/>
<xs:attributeGroup ref="reg:common.attribute.group"/>
</xs:extension>
</xs:complexContent>
</xs:complexType>
<xs:complexType name="outputs.elt.type">
<xs:sequence>
<xs:element ref="output" maxOccurs="unbounded"/>
</xs:sequence>
<xs:attributeGroup ref="reg:common.attribute.group"/>
</xs:complexType>
<xs:element name="output" abstract="true"/>
<xs:element name="error" type="output.error.elt.type" substitutionGroup="output"/>
<xs:complexType name="output.error.elt.type">
<xs:simpleContent>
<xs:extension base="xs:QName">
<xs:attributeGroup ref="reg:common.attribute.group"/>
</xs:extension>
</xs:simpleContent>
</xs:complexType>
</xs:schema>

# Appendix B References

REGISTRY
  XBRL International Inc.. "XBRL Registry 1.0"
  Geoff Shuetrim.
  (See registry-PWD-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)
XHTML
  W3C (World Wide Web Consortium). " XHTML™ 1.0 The Extensible HyperText Markup Language (Second Edition)"
  (See http://www.w3.org/TR/xhtml1/)
XML
  W3C (World Wide Web Consortium). "Extensible Markup Language (XML) 1.0 (Fourth Edition)"
  Tim Bray, Jean Paoli, C. M. Sperberg-McQueen, Eve Maler, and François Yergeau.
  (See http://www.w3.org/TR/REC-xml/)
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/)
XMLBASE
  W3C (World Wide Web Consortium). "XML Base"
  Johnathan Marsh.
  (See http://www.w3.org/TR/xmlbase/)

# 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 FWG.

# Appendix E Document history (non-normative)

Date | Author | Details
--- | --- | ---
29 January 2008 | Geoff Shuetrim | First internal working draft created.
30 January 2008 | Geoff Shuetrim | Fixed up various XML Schema errors.
31 January 2008 | Geoff Shuetrim | Adapted hyperlinks to use XLink simple link syntax. Added revision tracking.

# 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 FWG up to and including 22 June 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.