OASIS Committee Note

UBL 2.2 Abstract Syntax Notation 1 (ASN.1) Alternative Representation Version 1.0

Committee Note 01

13 March 2019

Specification URIs
This version:
https://docs.oasis-open.org/ubl/UBL-2.2-ASN.1/v1.0/cn01/UBL-2.2-ASN.1-v1.0-cn01.html
https://docs.oasis-open.org/ubl/UBL-2.2-ASN.1/v1.0/cn01/UBL-2.2-ASN.1-v1.0-cn01.pdf
https://docs.oasis-open.org/ubl/UBL-2.2-ASN.1/v1.0/cn01/UBL-2.2-ASN.1-v1.0-cn01.xml (Authoritative)
Previous version:
N/A
Latest version:
https://docs.oasis-open.org/ubl/UBL-2.2-ASN.1/v1.0/UBL-2.2-ASN.1-v1.0.html
https://docs.oasis-open.org/ubl/UBL-2.2-ASN.1/v1.0/UBL-2.2-ASN.1-v1.0.pdf
Technical Committee:
OASIS Universal Business Language TC
Chair:
G. Ken Holman (gkholman@CraneSoftwrights.com), Crane Softwrights Ltd.
Editor:
G. Ken Holman (gkholman@CraneSoftwrights.com), Crane Softwrights Ltd.
Additional artefacts:

This prose specification is one component of a Work Product that also includes:

The ZIP containing the complete files of this release is found in the directory:

Related work:

This note is related to:

Universal Business Language Version 2.2. Edited by G. Ken Holman. 09 July 2018. OASIS Standard. http://docs.oasis-open.org/ubl/os-UBL-2.2/UBL-2.2.html. Latest version: http://docs.oasis-open.org/ubl/UBL-2.2.html.

Abstract:

This committee note supplements the Universal Business Language version 2.2 XSD schema expressions with a suite of equivalent ASN.1 constraint expressions.

Status:

This is a Non-Stanadards Track Work Product. The patent provisions of the OASIS IPR Policy do not apply

This document was last revised or approved by the OASIS Universal Business Language TC on the above date. The level of approval is also listed above. Check the “Latest version” location noted above for possible later revisions of this document. Any other numbered Versions and other technical work produced by the Technical Committee (TC) are listed at https://www.oasis-open.org/committees/tc_home.php?wg_abbrev=ubl#technical.

Technical Committee members should send comments on this specification to the TC’s email list. Others should send comments to the TC’s public comment list, after subscribing to it by following the instructions at the “Send A Comment” button on the TC’s web page at https://www.oasis-open.org/committees/ubl/.

See Appendix A, Release Notes for more information regarding this release package.

Citation format:

When referencing this note the following citation format should be used:

[UBL-2.2-ASN.1] UBL 2.2 Abstract Syntax Notation 1 (ASN.1) Alternative Representation Version 1.0. 13 March 2019. OASIS Committee Note 01. https://docs.oasis-open.org/ubl/UBL-2.2-ASN.1/v1.0/cn01/UBL-2.2-ASN.1-v1.0-cn01.html. Latest version: https://docs.oasis-open.org/ubl/UBL-2.2-ASN.1/v1.0/UBL-2.2-ASN.1-v1.0.html.


Notices

Copyright © OASIS Open 2019. All Rights Reserved.

All capitalized terms in the following text have the meanings assigned to them in the OASIS Intellectual Property Rights Policy (the “OASIS IPR Policy”). The full Policy may be found at the OASIS website.

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 section are included on all such copies and derivative works. However, this document itself may not be modified in any way, including by removing the copyright notice or references to OASIS, except as needed for the purpose of developing any document or deliverable produced by an OASIS Technical Committee (in which case the rules applicable to copyrights, as set forth in the OASIS IPR Policy, must be followed) or as required to translate it into languages other than English.

The limited permissions granted above are perpetual and will not be revoked by OASIS or its successors or assigns.

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


Table of Contents

1 Introduction
1.1 Overview
1.2 Terminology
1.2.1 Terms and Definitions
1.2.2 Symbols and Abbreviations
1.3 References
2 ASN.1 Representation of UBL Schemas
3 UBL 2.2 ASN.1 Schemas

Appendixes

A Release Notes
A.1 Availability
A.2 Status of this Release
A.3 Package Structure
A.4 Support
B Revision History
C Acknowledgements

1 Introduction

1.1 Overview

The OASIS Universal Business Language (UBL) defines a generic XML interchange format for business documents that can be restricted or extended to meet the requirements of particular industries. Specifically, UBL provides the following:

  • A suite of structured business objects and their associated semantics expressed as reusable data components and common business documents.

  • A library of XML schemas for reusable data components such as “Address”, “Item”, and “Payment”—the common data elements of everyday business documents.

  • A set of XML schemas for common business documents such as “Order”, “Despatch Advice”, and “Invoice” that are constructed from the UBL library components and can be used in generic procurement and transportation contexts.

This Committee Note provides an alternative non-normative representation of the UBL XML schemas for use in systems supporting Abstract Syntax Notation 1 (ASN.1), ISO/IEC 8825-1.

1.2 Terminology

1.2.1 Terms and Definitions

Document

A set of information components that are exchanged as part of a business transaction; for example, in placing an order.

XSD schema

An XML document definition conforming to the W3C XML Schema language [XSD1][XSD2].

The keywords MUST, MUST NOT, REQUIRED, SHALL, SHALL NOT, SHOULD, SHOULD NOT, RECOMMENDED, MAY and OPTIONAL, when they appear in this document, are to be interpreted as described in [RFC2119].

1.2.2 Symbols and Abbreviations

ASN

Abstract Syntax Notation

IEC

International Electrotechnical Commission

ISO

International Organization for Standardization

XML

Extensible Markup Language [XML]

XSD

W3C XML Schema Language [XSD1][XSD2]

2 ASN.1 Representation of UBL Schemas

UBL 2.2 continues the practice, adopted at the beginning of the UBL effort, of creating its normative XML specifications using W3C Schema (XSD) syntax. Alternative representations of the same content are generated directly from the XSD and are intended to implement the same document instance constraints.

Alternative representations of the same content are technically non-normative.

The UBL ASN.1 specification provides an alternative schema definition for UBL documents in accordance with ITU-T X.680-X.693 [ASN.1]. The UBL ASN.1 specification defines the same UBL documents as the UBL XSD schemas that constitute the normative definitions of valid UBL documents. The UBL ASN.1 XML specification enables ASN.1 tools to be used for UBL transfers, and in conjunction with the ASN.1 Packed Encoding Rules, it provides a specification for an efficient binary encoding of UBL messages.

The ASN.1 modules were created using a tool from OSS Nokalva that conforms to ITU-T Recommendation X.694 | ISO/IEC 8825-5 for converting XSD Schema to ASN.1.

3 UBL 2.2 ASN.1 Schemas

This software-generated summary documentation file describes the contents of the ASN.1 schemas for UBL 2.2 in a human-readable format in HTML:

The following ASN.1 schemas are for the UBL 2.2 document models:

The following schemas are not addressed directly for validation of a UBL document but are referenced from the document schemas in support of their requirements:

Appendix A Release Notes

A.1 Availability

Online and downloadable versions of this release are available from the locations specified at the top of this document.

A.2 Status of this Release

Release of this package to the public marks the beginning of its first public review of Committee Note 01. The UBL Technical Committee actively solicits input from the user community regarding this release. See Status at the beginning of this document for procedures to be used in submitting comments to the Committee. Note that in accordance with OASIS policies regarding intellectual property, the UBL TC cannot accept input from persons outside the UBL TC (including OASIS members) unless it is submitted via the comment list.

A.3 Package Structure

This OASIS Committee Note is published as a zip archive in the https://docs.oasis-open.org/ubl/UBL-2.2-ASN.1/v1.0/cn01/ directory. Unzipping this archive creates a directory tree containing a master DocBook XML file (UBL-2.2-ASN.1-v1.0-cn01.xml), a generated hypertext version of this file (UBL-2.2-ASN.1-v1.0-cn01.html), a generated PDF version of this file (UBL-2.2-ASN.1-v1.0-cn01.pdf), and a number of subdirectories. The files in these subdirectories contain the various components of this release. A description of each subdirectory is given below. Note that while the UBL-2.2-ASN.1-v1.0-cn01.xml file is the “original” of this specification, it may not be viewable in all currently available web browsers.

asn

ASN.1 UBL 2.2 schemas and documentation

dbasn

DocBook documentation support files

Note that the files and directories in this package are named such that the contents of this package can be overlaid on top of the unzipped UBL 2.2 package contents without overwriting any files.

A.4 Support

UBL is a volunteer project of the international business community. Inquiries regarding UBL may be posted to the public ubl-dev list, archives for which are located at

Subscriptions to ubl-dev can be made through the OASIS list manager at

OASIS provides an official community gathering place and information resource for UBL at

Appendix B Revision History

This is the first release of these ASN.1 artefacts.

Appendix C Acknowledgements

The following persons contributed to the work of the committee during the preparation of this work product.

Todd Albers, Federal Reserve Bank of Minneapolis
Oriol Bausa Peris, Individual
Kenneth Bengtsson, Individual
Erlend Klakegg Bergheim, Difi-Agency for Public Management and eGovernment
Peter Borresen, ClearView Trade
Kees Duvekot, RFS Holland Holding B.V.
Cécile Guasch, Individual
G. Ken Holman, Crane Softwrights Ltd.
Yves Jordan, Publications Office of the European Union
Ole Madsen, Danish Business Authority
Andre Mitchell, Individual
Natalie Muric, Publications Office of the European Union
Levine Naidoo, Individual
Olli Pajari, Individual
Steve Ryan, Individual
Enric Staromiejski Torregrosa, everis, S.L.U.
Matt Vickers, Xero
UBL-2.2-ASN.1-v1.0-cn01
Non-standards Track

Copyright © OASIS Open 2019. All Rights Reserved.
13 March 2019