UBL 2.1 Unified Modeling Language (UML) Alternative Representation Version 1.0

Committee Note 01

19 June 2013

Specification URIs
This version:
http://docs.oasis-open.org/ubl/UBL-2.1-UML/v1.0/cn01/UBL-2.1-UML-v1.0-cn01.html
http://docs.oasis-open.org/ubl/UBL-2.1-UML/v1.0/cn01/UBL-2.1-UML-v1.0-cn01.pdf
http://docs.oasis-open.org/ubl/UBL-2.1-UML/v1.0/cn01/UBL-2.1-UML-v1.0-cn01.xml (Authoritative)
Previous version:
N/A
Latest version:
http://docs.oasis-open.org/ubl/UBL-2.1-UML/v1.0/UBL-2.1-UML-v1.0.html
http://docs.oasis-open.org/ubl/UBL-2.1-UML/v1.0/UBL-2.1-UML-v1.0.pdf
Technical Committee:
OASIS Universal Business Language TC
Chairs:
Jon Bosak (bosak@pinax.com), Individual
Tim McGrath (tim.mcgrath@documentengineeringservices.com), Document Engineering Services
Editors:
Martin Forsberg (martin.forsberg@ecru.se), Swedish Association of Local Authorities & Regions
G. Ken Holman (gkholman@CraneSoftwrights.com), Crane Softwrights Ltd.
Tim McGrath (tim.mcgrath@documentengineeringservices.com), Document Engineering Services
Audun Vennesland (Audun.Vennesland@sintef.no), SINTEF
Additional artefacts:

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.1. OASIS Standard. http://docs.oasis-open.org/ubl/UBL-2.1.html.

Abstract:

This Committee Note describes the Universal Business Language version 2.1 common library and document models using the Unified Modeling Language (UML).

Status:

This document was last revised or approved by the UBL TC on the above date. The level of approval is also listed above. Check the current location noted above for possible later revisions of this document.

Technical Committee members should send comments on this specification to the Technical Committee’s email list. Others should send comments to the Technical Committee by using the “Send A Comment” button on the Technical Committee’s web page at http://www.oasis-open.org/committees/ubl/.

For information on whether any patents have been disclosed that may be essential to implementing this specification, and any offers of patent licensing terms, please refer to the Intellectual Property Rights section of the Technical Committee web page at http://www.oasis-open.org/committees/ubl/ipr.php.

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.1-UML] UBL 2.1 Unified Modeling Language (UML) Alternative Representation Version 1.0. 19 June 2013. OASIS Committee Note 01. http://docs.oasis-open.org/ubl/UBL-2.1-UML/v1.0/cn01/UBL-2.1-UML-v1.0-cn01.html.


Notices

Copyright © OASIS Open 2013. 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.

OASIS requests that any OASIS Party or any other party that believes it has patent claims that would necessarily be infringed by implementations of this OASIS Committee Specification or OASIS Standard notify OASIS TC Administrator and provide an indication of its willingness to grant patent licenses to such patent claims in a manner consistent with the IPR Mode of the OASIS Technical Committee that produced this specification.

OASIS invites any party to contact the OASIS TC Administrator if it is aware of a claim of ownership of any patent claims that would necessarily be infringed by implementations of this specification by a patent holder that is not willing to provide a license to such patent claims in a manner consistent with the IPR Mode of the OASIS Technical Committee that produced this specification. OASIS may include such claims on its website, but disclaims any obligation to do so.

OASIS 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. Information on OASIS’ procedures with respect to rights in any document or deliverable produced by an OASIS Technical Committee can be found on the OASIS website. Copies of claims of rights made available for publication and any assurances of licenses to be made available, or the result of an attempt made to obtain a general license or permission for the use of such proprietary rights by implementers or users of this OASIS Committee Specification or OASIS Standard, can be obtained from the OASIS TC Administrator. OASIS makes no representation that any information or list of intellectual property rights will at any time be complete, or that any claims in such list are, in fact, Essential Claims.

The name “OASIS” is a trademark of OASIS, the owner and developer of this specification, and should be used only to refer to the organization and its official outputs. OASIS welcomes reference to, and implementation and use of, specifications, while reserving the right to enforce its marks against misleading uses. Please see http://www.oasis-open.org/policies-guidelines/trademark.php for guidance.


Table of Contents

1 Introduction
1.1 Terminology
1.1.1 Terms and Definitions
1.1.2 Symbols and Abbreviations
1.2 References
2 UML Representation of UBL Document Models

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

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 describes the Universal Business Language version 2.1 common library and document models using the Unified Modeling Language (UML).

1.1 Terminology

1.1.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.1.2 Symbols and Abbreviations

IEC

International Electrotechnical Commission

ISO

International Organization for Standardization

UML

Unified Modeling Language [UML]

XML

Extensible Markup Language [XML]

XSD

W3C XML Schema Language [XSD1][XSD2]

2 UML Representation of UBL Document Models

UBL 2.1 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, with the exception of the UBL 2.1 digital signature extension, are intended to implement the same document instance constraints.

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

The UBL 2.1 UML provides a series of class diagrams of the UBL common library and document models using Enterprise Architect from Sparx Systems. The model provided uses a UML profile based on the CCTS [CCTS] used to define the business information entities from which the normative XSD syntax is derived.

Important note

The artefacts included in this package conform to UBL 2.1 Public Review Draft 3. When this Committee Note is completed the included artefacts will conform to the final UBL 2.1.

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

THIS RELEASE IS SUBJECT TO CHANGE. IT IS PROVIDED FOR TESTING PURPOSES ONLY AND SHOULD NOT BE USED FOR PRODUCTION SYSTEMS.

A.3 Package Structure

This OASIS Committee Note is published as a zip archive in the http://docs.oasis-open.org/ubl/UBL-2.1-UML/v1.0/cn01/ directory. Unzipping this archive creates a directory tree containing a master DocBook XML file (UBL-2.1-UML-v1.0-cn01.xml), a generated hypertext version of this file (UBL-2.1-UML-v1.0-cn01.html), a generated PDF version of this file (UBL-2.1-UML-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.1-UML-v1.0-cn01.xml file is the “original” of this specification, it may not be viewable in all currently available web browsers.

db

DocBook documentation support files

uml

UBL 2.1 UML diagrams

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 UML diagrams.

Appendix C Acknowledgements

The following persons and companies participated as members of the OASIS UBL Technical Committee during the four years of its development (2008–2012).

Inigo Barreira, iZenpe S.A.
Roger Bass, Individual
Oriol Bausa Peris, Individual
Kenneth Bengtsson, Alfa1lab
Georg Birgisson, Document Engineering Services Limited
Peter Borresen, Document Engineering Services Limited
Jon Bosak, Individual
Mikkel Brun, Tradeshift Network Ltd.
Arianna Brutti, ENEA UTT PMI
Andrea Caccia, AITI-Associazione Italiana Tesorieri de Impresa
Manuel Cano, Nexus IT
Sally Chan, The Boeing Company
William Chan, Individual
Roberto Cisternino, Individual
Anthony Coates, Document Engineering Services Limited
Gary Cornelius, CSW Group Ltd.
Mavis Cournane, Cognitran
Robin Cover, OASIS
Eduardo Criado Albuixech, Eurobits Technologies
Juan Cruellas, Departamento de Arquitectura de Computadores, Univ Politecnica de Cataluna
Piero De Sabbata, ENEA UTT PMI
Michael Dill, Individual
Asuman Dogac, Individual
Kees Duvekot, RFS Holland Holding B.V.
Pim van der Eijk, Sonnenglanz Consulting
David Fitzpatrick, Booz Allen Hamilton
Martin Forsberg, Swedish Association of Local Authorities & Regions
Bob Glushko, Document Engineering Services Limited
Arturo Gonzalez Mac Dowell, Eurobits Technologies
Stephen Green, Document Engineering Services Limited
Michael Grimley, US Department of Defense (DoD)
Eduardo Gutentag, Oracle
Betty Harvey, Individual
Anne Hendry, Individual
Hideki Hiura, Justsystems Corporation
G. Ken Holman, Crane Softwrights Ltd.
Naomasa Hosoda, NEC Corporation
Julian Inza, Eurobits Technologies
Akihiro Kawauchi, Individual
Kyung-In Kim, Korea Institute for Electronic Commerce (KIEC)
Sung Hyuk Kim, Individual
Stig Korsgaard, Danish Bankers Association
Ram Kumar, Individual
John Larmouth, Individual
Thomas Lee, University of Hong Kong
Thomas Love, efoil, Inc.
Luis Martin-Santos, Gaia Net Exchange S.L.
Tim McGrath, Document Engineering Services Limited
Brais Mendez Ferreiro, Sociedad de Explotacion de Redes Electronicas y Servicios, SA (SERES)
Garret Minakawa, Oracle
Tuncay Namli, Individual
Yasuyuki Nishioka, PSLX consortium
Dave Nurse, CSW Group Ltd.
Cagdas Ocalan, Middle East Technical University
Mark Palmer, NIST
Klaus Pedersen, Difi-Agency for Public Management and eGovernment
Sue Probert, Individual
Sven Rasmussen, Danish Agency for Digitisation, Ministry of Finance
Zarella Rendon, PTC
Yukinori Saito, ERP Research Corporation
Sacha Schlegel, Individual
Andrew Schoka, Individual
Mark Seaborne, PicoForms
Jose Silva, Individual
Ali Sinaci, Middle East Technical University
Kumar Sivaraman, Oracle
Enric Staromiejski, SOM Team
Paul Thorpe, OSS Nokalva
Karsten Tolle, Document Engineering Services Limited
Juerg Tschumperlin, New Zealand Ministry of Education
Fulya Tuncer, Middle East Technical University
Kenneth Vaughn, Individual
Vito Vavalli, AITI-Associazione Italiana Tesorieri de Impresa
Audun Vennesland, SINTEF
Catherine Williams, PISCES Ltd
Nigel Wooden, ACORD Corporation
Marcelo Yarzabal, Eurobits Technologies
Patrick Yee, University of Hong Kong
Arif Yildirim, Revenue Administration of Turkey
Peter Yim, Individual
Pine Zhang, UOML Alliance
UBL-2.1-UML-v1.0-cn01
Non-standards Track

Copyright © OASIS Open 2013. All rights reserved.
19 June 2013