Copyright ©2011 XBRL International Inc., All Rights Reserved.
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.
This document describes an extension to the XBRL 2.1 specification [XBRL 2.1] that builds upon the generic messages specification [GENERIC MESSAGES] and the validation specification [VALIDATION] to define the base syntax and semantics for messages that can provide information in the context of evaluation of assertions.
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
2 Syntax
2.1 Assertion-satisfied-message relationships
2.2 Assertion-unsatisfied-message relationships
3 Expansion of validation messages
3.1 Expression context of messages in assertion evaluations
3.1.1 Value assertions
3.1.2 Consistency assertions
3.1.3 Existence assertions
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
1 Namespaces and namespace prefixes
XML schema
assertion-satisfied-message relationship
assertion-unsatisfied-message relationship
rfc2119 terminology
Assertions are an important feature of XBRL in certain scenarios in order to warrant a minimum quality of the data exchanged. In those cases, the capability of producing a clear description of a potential error is sometimes as important as the capability of detecting the error itself.
This document specifies the syntax and semantics for messages that can be generated dynamically in the context of the evaluation of an assertion. These messages are based on the generic messages specification [GENERIC MESSAGES].
Messages are conformant with the XBRL Specification [XBRL 2.1]. This document makes no statement about:
This specification also does not define any XLink extended link roles but defines resource roles for use with messages for satisfied and unsatisfied messages.
This specification extends the documentation capabilities of the XBRL Specification [XBRL 2.1].
This specification depends upon the XBRL Specification [XBRL 2.1]. This specification depends upon the XBRL Generic Link Specification [GENERIC LINKS]. In the event of any conflicts between this specification and the specifications upon which it depends, this specification does not prevail.
The official language of XBRL International's own work products is English and the preferred spelling convention is UK English.
This specification is consistent with the definitions of any of the terms defined in specifications that it depends on.
Where this document refers to an XML schema, it is referring to an XML document [XML] that contains a declaration of a schema that is compliant with XML Schema [XML SCHEMA STRUCTURES].
The key words MUST, MUST NOT, REQUIRED, SHALL, SHALL NOT, SHOULD, SHOULD NOT, RECOMMENDED, MAY, and OPTIONAL, in this specification, are to be interpreted as described in [IETF RFC 2119].
Documentation conventions follow those set out in the XBRL Variables Specification [VARIABLES].
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.
Prefix | Namespace URI |
---|---|
valm
|
http://xbrl.org/2010/message/validation
|
xbrlvalme
|
http://xbrl.org/2010/message/validation/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
|
va |
http://xbrl.org/2008/assertion/value
|
ea |
http://xbrl.org/2008/assertion/existence
|
ca |
http://xbrl.org/2008/assertion/consistency
|
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.
An assertion-satisfied-message relationship is a specific case of element-message relationship between an assertion and a message expressed by an XLink arc.
To declare an assertion-satisfied-message relationship an XLink arc MUST:
http://xbrl.org/arcrole/2010/assertion-satisfied-message
The arcrole value,
http://xbrl.org/arcrole/2010/assertion-satisfied-message
,
is declared in the normative schema for messages.
Assertion-satisfied-message relationships MUST be expressed by generic arcs as indicated by the restrictions imposed by the arcrole declaration in the normative schema.
An assertion-unsatisfied-message relationship is a specific case of element-message relationship between an assertion and a message expressed by an XLink arc.
To declare an assertion-unsatisfied-message relationship an XLink arc MUST:
http://xbrl.org/arcrole/2010/assertion-unsatisfied-message
The arcrole value,
http://xbrl.org/arcrole/2010/assertion-unsatisfied-message
,
is declared in the normative schema for messages.
Assertion-unsatisfied-message relationships MUST be expressed by generic arcs as indicated by the restrictions imposed by the arcrole declaration in the normative schema.
Those messages whose referred element is an assertion SHOULD be expanded whenever the assertion is evaluated against a data set and its result is:
http://xbrl.org/arcrole/2010/assertion-satisfied-message
http://xbrl.org/arcrole/2010/assertion-unsatisfied-message
The message expression context to be used in the expansion of these messages depends on the type of assertion, as described in the following sections.
This section defines the expression context for messages involved in the evaluation of assertions. Some characteristics are specific of the type of assertion, but the following one applies to all of them:
@name
attribute in the <variable:parameter>
element,
The expression context for messages involved in the evaluation of value assertions MUST
<xbrli:xbrl>
element of the
input XBRL instance,
va:test-expression
the value of the @test
attribute
of the evaluated assertion.
The expression context for messages involved in the evaluation of consistency assertions MUST
ca:aspect-matched-facts
for the sequence of all
aspect matched input facts
in the evaluation of the assertion,
ca:acceptance-radius
for the value of the
acceptance radius
in the evaluation of the assertion,
ca:absolute-acceptance-radius-expression
for the value of the @absoluteAcceptanceRadius
attribute
in the consistency assertion, and
ca:proportional-acceptance-radius-expression
the value of the @proportionalAcceptanceRadius
attribute
in the consistency assertion.
The expression context for messages involved in the evaluation of existence assertions MUST
ea:test-expression
the value of the @test
attribute
of the evaluated assertion,
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:
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/validation-message.xsd.
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).
This document could not have been written without the contributions of many people including the participants in the Formula Working Group.
Date | Author | Details |
---|---|---|
09 June 2009 | Masatomo Goto |
First internal working draft created. |
19 November 2009 | Herm Fischer |
Incorporate changes per FWG meeting discussion. Removed references to assertion-sets. Added evaluation context definitions, to match that of the applicable assertion. Changed to one arcrole for both successful and not successful messages, and separate resource roles for satisfied and unsatisfied message resource. |
29 November 2009 | Victor Morilla |
Changed name of the specification from generic expression message labels to general messages. Previous name was a bit confusing. With the change, the term label defines documentation of DTS objects, whereas messages correspond to documentation of events or results in processes based on information of the DTS. As these processes have a dynamic nature, inline XPath expressions are quite convenient. Namespaces changed to 2010
Included new element Created resource roles for messages: standard, verbose and terse Created the idea of element-message relationship and reorganization of the text of the specification to facilitate future reusing of messages by new specifications. Included parameters in DTS as part of in-scope variables for the expansion of messages.
Included the special variable Added error for unmatched right curly brackets. Included suggestion by Andy of allowing structure data in message. Now XPath expressions can appear inside text nodes and attribute values Included examples of a plain text and a complex message.
Included |
08 December 2009 | Victor Morilla |
Specification renamed to Messages. References to generic messages removed. |
13 December 2009 | Victor Morilla |
Message specificaton splited into generic messages and assertion messages Included new in-scope variables required by Fujitsu |
13 December 2009 | Victor Morilla |
Changed name of the specification to validation messages Changed namespace and prefix accordingly Added paragraph about overriding in-scope variables referencing DTS parameters as suggested by Herm |
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 24 October 2011. 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.