# Function conformance test inputs and outputs 1.0

## Proposed Recommendation 31 March 2009

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

This version:
  <http://www.xbrl.org/Specification/conformanceFunction/PR-2009-03-31/conformanceFunction-PR-2009-03-31.html>
Editor:
  Geoff Shuetrim, Galexy <geoff@galexy.net>

## Status

Circulation of this Proposed Recommendation 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 defines syntax for the inputs and outputs of function registry conformance suite tests.

# 1 Introduction

This specification defines syntax for the inputs and outputs of function registry conformance suite tests.

## 1.1 Background

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

## 1.2 Relationship to other work

This specification works with the XBRL conformance test 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
--- | ---
`cfcn` | `http://xbrl.org/2008/conformance/function`
`cfcne` | `http://xbrl.org/2008/conformance/function/error`
`xml` | `http://www.w3.org/XML/1998/namespace`

# 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 Inputs

Function conformance suite tests MAY have input files, and input XPath expressions selecting information from the input files to use as function parameter values.

The syntax for the input files is defined in the Conformance Specification [CONFORMANCE].

### 2.1.1 Input function call

The syntax for the input function call is provided by the `<cfcn:call>` element.

If provided, the `@file` attribute MUST contain the ID of one of the test case variation's input files.

The content of a `<cfcn:call>` is interpreted as an XPath expression that is expected to be evaluated using a context that is an empty sequence if there is no `@file` attribute and that is the root element of the specified input file otherwise.

The XPath expression will generally call the function being tested.

A function test case variation MUST have exactly one input function call among its inputs.

## 2.2 Outputs

Function conformance suite tests MAY have error codes as outputs. They MAY also produce results that are expected to fulfil certain conditions that can be tested for by executing XPath expressions and requiring the result to be an effective Boolean value of `true`. The syntax for error code outputs is defined in the XBRL Conformance Specification [CONFORMANCE].

### 2.2.1 Output tests

The syntax for the output tests is provided by the `<cfcn:test>` element.

The content of a `<cfcn:test>` is interpreted as an XPath expression that is expected to be evaluated using a context that is the result of evaluating the XPath expression that provided as an input to the test case variation.

The XPath expression in the `<cfcn:test>` element MAY contain a reference to the variable `$result` that is equal to the result of evaluating the XPath expression provided as an input to the test case variation.

The result of evaluating the output test XPath expression MUST be an effective Boolean value of `true` if the test is to be considered passed.

A test case variation MAY contain more than one output test.

# 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/conformanceFunction.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:conf="http://xbrl.org/2008/conformance" xmlns:xs="http://www.w3.org/2001/XMLSchema" xmlns="http://xbrl.org/2008/conformance/function" xmlns:reg="http://xbrl.org/2008/registry" targetNamespace="http://xbrl.org/2008/conformance/function" elementFormDefault="qualified" attributeFormDefault="unqualified">
<xs:import namespace="http://xbrl.org/2008/conformance" schemaLocation="conformance.xsd"/>
<xs:import namespace="http://xbrl.org/2008/registry" schemaLocation="registry.xsd"/>
<xs:element id="xml-call" name="call" type="input.call.elt.type" substitutionGroup="conf:input"/>
<xs:complexType name="input.call.elt.type">
<xs:simpleContent>
<xs:extension base="xs:string">
<xs:attribute name="file" type="xs:IDREF" use="optional"/>
<xs:attributeGroup ref="reg:common.attribute.group"/>
</xs:extension>
</xs:simpleContent>
</xs:complexType>
<xs:element id="xml-test" name="test" type="output.test.elt.type" substitutionGroup="conf:output"/>
<xs:complexType name="output.test.elt.type">
<xs:simpleContent>
<xs:extension base="xs:string">
<xs:attributeGroup ref="reg:common.attribute.group"/>
</xs:extension>
</xs:simpleContent>
</xs:complexType>
</xs:schema>

# Appendix B References

CONFORMANCE
  XBRL International Inc.. "Conformance test definition 1.0"
  Geoff Shuetrim.
  (See conformance-PR-2009-03-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 ../../../../../specifications/pub/Specification/variables/PR-2009-03-31/variables-PR-2009-03-32.html)
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 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 | Simplified the syntax for the input XPath expressions in function tests by including an explicit function call in the XPath expression rather than generating one XPath expression per input parameter of the function being called. Fixed up various XML Schema errors.
09 April 2008 | Geoff Shuetrim | Introduced the `$result` variable for output XPath expressions to be able to refer to the result of evaluating the input XPath expression. Fixed up various XML Schema errors.

# 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 31 March 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.