Universal Business Language (UBL)
Naming and Design Rules 2.0
Public Review Draft, 8 September 2006
Document
identifier:
prd-UBL-NDR-2.0
Location:
http://docs.oasis-open.org/ubl/prd-UBL-NDR-2.0
Technical Committee:
OASIS Universal Business Language Technical Committee
Chairs:
Jon Bosak, Sun Microsystems
Tim McGrath
Editors:
Mavis Cournane, Cognitran Limited <mavis.Cournane@cognitran.com>
Mike Grimley, US Navy <MJGrimley@acm.org>
Abstract:
This specification documents the naming and design rules and guidelines for the construction of XML components for the UBL vocabulary.
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. This document is updated periodically on no particular schedule.
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 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 (www.oasis-open.org/committees/ubl/ipr.php).
The non-normative errata page for this specification is located at www.oasis-open.org/committees/ubl.
Copyright © 2006 The Organization for the Advancement of Structured Information Standards [OASIS]
Table of Contents
1 Introduction.................................................................................................................. 5
1.1 Audiences.............................................................................................................. 5
1.2 Scope.................................................................................................................... 5
1.3 Terminology and Notation........................................................................................ 6
1.4 Guiding Principles................................................................................................... 7
1.4.1 Adherence to General UBL Guiding Principles..................................................... 7
1.4.2 Design for Extensibility...................................................................................... 8
1.4.3 Relationship to Tools......................................................................................... 8
1.4.4 Choice of Schema Language.............................................................................. 9
2 Relationship to ebXML Core Components........................................................................ 10
2.1 Mapping Business Information Entities
to XSD........................................................... 12
3 General XML Constructs................................................................................................ 15
3.1 Overall Schema Structure........................................................................................ 15
3.1.1 Element declarations within document schemas.................................................. 16
3.2 Naming and Modeling Constraints............................................................................ 17
3.2.1 Naming Constraints........................................................................................... 17
3.2.2 Modeling Constraints......................................................................................... 17
3.3 Reusability Scheme................................................................................................ 18
3.4 Extension Scheme.................................................................................................. 19
3.5 Namespace Scheme............................................................................................... 20
3.5.1 Declaring Namespaces...................................................................................... 20
3.5.2 Namespace Uniform Resource Identifiers............................................................ 20
3.5.3 Schema Location.............................................................................................. 21
3.5.4 Persistence...................................................................................................... 21
3.6 Versioning Scheme................................................................................................. 21
3.7 Modularity Strategy................................................................................................. 24
3.7.1 UBL Modularity Model....................................................................................... 24
3.7.2 Internal and External Schema Modules............................................................... 28
3.7.3 Internal Schema Modules.................................................................................. 28
3.7.4 External Schema Modules................................................................................. 28
3.8 Annotation and Documentation Requirements............................................................ 32
3.8.1 Schema Annotation........................................................................................... 32
3.8.2 Embedded documentation................................................................................. 32
4 Naming Rules............................................................................................................... 36
4.1 General Naming Rules............................................................................................. 36
4.2 Type Naming Rules.................................................................................................