Copyright © 2021, 2022 XBRL International Inc., All Rights Reserved.
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.
This specification is an extension to the Formula Validation Specification [VALIDATION]. It defines elements and relationships that allow formula authors to associate standard severity levels with 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.5.1 Typographic conventions
1.5.1.1 Definition notation
1.5.1.2 Footnote notation
1.5.1.3 Element and attribute notation
1.5.1.4 Error code notation
1.5.2 Formatting conventions
1.6 Namespaces and namespace prefixes
2 Severity resources
3 Assertion-unsatisfied-severity relationships
4 Validation
5 Default Severity
A Schema and Linkbase
A.1 Assertion Severity schema
A.2 Assertion Severity linkbase
B References
C Intellectual property status (non-normative)
D Acknowledgements (non-normative)
E Document history
F Errata corrections in this document
1 Namespaces and namespace prefixes
1 A normative example
2 A non-normative example
3 An example of poor usage
assertion-unsatisfied-severity relationship
Publication URL
Severity
seve:assertionSeveritySourceError
seve:assertionSeverityTargetError
seve:invalidSeverityExpressionResultError
seve:multipleSeveritiesForAssertionError
All formula assertions specifications ([VALUE ASSERTIONS], [EXISTENCE ASSERTIONS] and [CONSISTENCY ASSERTIONS]) define a standard XML-based syntax for validations on XBRL business reports. The technical nature of an assertion is that the assertion is either "satisfied" or "unsatisfied". From a business perspective, not all assertions express rules which have the same level of importance, and consequently there is a need to be able to attach differing severities in order to classify the severity of an assertion that is unsatisfied.
This specification defines three standard severity levels and the syntax for associating them such that an appropriate severity is applied when an assertion is unsatisfied.
This specification extends the suite of formula specifications without modifying any existing specifications.
This specification depends upon the XBRL Specification [XBRL 2.1], the XBRL Generic Link Specification [GENERIC LINKS] and the Formula Validation Specification [VALIDATION] which defines assertions. 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.
Comments which are informative, but not essential to the understanding of the point at hand, are provided in footnotes. All footnotes are non-normative.
When referring to a specific element, it will be identified by
its namespace prefix and local name. For example, the root
element for a specification container element would be referred to as
<variable:generalVariable> .
Attributes are also identified by their local name and, where
appropriate, their namespace prefix. Attributes are
distinguished from elements by prefixing them by an
@
symbol. Thus,
@id
refers to the attribute with the name id.
When referring to any attribute, so long as it has a specific
namespace, the local name is replaced by an asterisk (
*).
Thus, the notation @xml:* specifies any attribute
in the namespace
http://www.w3.org/XML/1998/namespace.
The following highlighting is used for normative technical material in this document:
Text of the normative example.
The following highlighting is used for non-normative examples in this document:
Text of the helpful example.
Next paragraph of the helpful example.
Example 3 shows the formatting for non-normative examples of poor, discouraged or disallowed usage.
The example itself.
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 |
|---|---|
sev |
http://xbrl.org/PR/2022-02-02/assertion-severity |
seve |
http://xbrl.org/PR/2022-02-02/assertion-severity/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 |
A severity resource is
one of the three static instantiations of resources,
published in the assertion severity linkbase (A.2)
( <sev:error> , <sev:warning> and <sev:ok> ) or a <sev:expression> element.
The severity level is specified by the name of a static element ( <sev:error> , <sev:warning> and <sev:ok> )
or by the evaluation of the XPath expression [XPATH 2.0] in the
@severity attribute of the
<sev:expression> element.
The XPath expression is evaluated in the same expression context as messages in assertion evaluations, as defined in Section 3.1 of Validation Messages 1.0, and
returns one of the string values:
"ERROR", "WARNING" or "OK" (seve:invalidSeverityExpressionResultError).
An assertion-unsatisfied-severity relationship is a relationship between an assertion and one of the severity resource elements and is defined by an XLink arc.
An assertion-unsatisfied-severity relationship MAY be used to associate an assertion with the severity level that should apply when this assertion is not satisfied.
To declare an assertion-unsatisfied-severity relationship an XLink arc MUST:
http://xbrl.org/arcrole/PR/2022-02-02/assertion-unsatisfied-severity;
The arcrole value
http://xbrl.org/arcrole/PR/2022-02-02/assertion-unsatisfied-severity
is declared in the normative schema for messages.
Assertion-unsatisfied-severity relationships SHALL be expressed by generic arcs.
This specification prescribes certain constraints on the components that may be linked by assertion-unsatisfied-severity relationships.
The source of an
assertion-unsatisfied-severity relationship
MUST be an element in the
<validation:assertion>
or
<validation:variableSetAssertion>
substitution groups
(seve:assertionSeveritySourceError).
The target of an assertion-unsatisfied-severity relationship MUST be a severity resource (seve:assertionSeverityTargetError).
An assertion MUST NOT be the source of more than one effective assertion-unsatisfied-severity relationship (seve:multipleSeveritiesForAssertionError).
Where an assertion is not associated with a severity resource element
assertion-unsatisfied-severity relationship processors
MUST treat the assertion as if it has a severity of
ERROR.
This section contains XML files that form part of this specification. Each document has a standard Publication URL, at which the normative copy of the document is published. A non-normative copy of each document is included in this appendix for convenience.
All references to these documents made for the purposes of DTS Discovery MUST resolve to the Publication URL, after applying XML Base processing (where applicable) and resolving any relative URLs.
It should be noted that the path component of a URL is case-sensitive, and so must match exactly. Further, alternative hosts and schemes that happen to resolve to the same location are not considered equivalent and may not be used. See [URI] for more details on URL equivalence.
The requirement to reference documents by Publication URL does not prevent processors from substituting local copies of the documents for performance or other reasons.
The Publication URL for this document is: http://www.xbrl.org/PR/2022-02-02/assertion-severity.xsd.
The Publication URL for this document is: http://www.xbrl.org/PR/2022-02-02/severities.xml.
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.
| Date | Author | Details |
|---|---|---|
| 28 April 2021 | Paul Warren |
Initial Public Working Draft of Assertion Severities 2.0, adding support for dynamic severity definition. |
| 07 July 2021 | Paul Warren |
Candidate Recommendation release of 2.0 specification. |
| 29 September 2021 | David Bell |
Corrected resource definition for |
| 02 February 2022 | Paul Warren |
Proposed Recommendation release of 2.0 specification. |
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 02 February 2022. 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.