OASIS Universal Business Language TC
Roberto Cisternino (Italian)
Yukinori Saito (Japanese)
Oriol Bausà Peris (Spanish)
This specification is related to:
The IDD provides informative translations of the UBL 2.0 data dictionary.
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 "Latest Version" or "Latest Approved Version" 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 (http://www.oasis-open.org/committees/ubl/ipr.php)..
If there is a non-normative errata page for this specification, it is located at http://www.oasis-open.org/committees/ubl/.
Copyright © OASIS® 2008. 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 OR 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, to 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 names "OASIS" and “UBL” are trademarks 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/who/trademark.php for above guidance.
1 Introduction 5
1.1 Relationship of translations to the original 5
1.2 Normative references 5
2 Package structure 6
3 Known issues 7
3.1 Corrections as of PRD 01 7
4 Conformance 9
UBL, the Universal Business Language, defines standard XML representations of common business documents such as purchase orders, invoices, and shipping notices. UBL 1.0, released as an OASIS Standard in November 2004, normatively defines over 600 standard business terms (represented as XML element names) that serve as the basis for eight basic standard XML business document types. These English-language names and their corresponding definitions constitute the UBL 1.0 data dictionary – not a separate publication, but simply a label for the collection of all the element names and definitions contained in the UBL 1.0 data model spreadsheets and in the XML schemas generated from these data models.
As an informational aid for UBL users, UBL localization subcommittees subsequently translated all of the UBL 1.0 definitions into Chinese (traditional and simplified), Japanese, Korean, Spanish, and Italian. These translations were published in a single merged spreadsheet called the UBL 1.0 International Data Dictionary (IDD).
With input from a number of government agencies in Europe and Asia, UBL 2.0, released as an OASIS Standard in December 2006, greatly expanded both the UBL document set and the library of UBL information items upon which they are based, adding terms and document types to support a broad range of additional functions needed for government procurement. The resulting UBL 2.0 data dictionary contains more than 1900 standard element names and their English-language definitions. The UBL localization subcommittees are now in the process of translating this much larger collection.
As the translation effort is expected to take some time, the UBL Technical Committee is releasing the UBL 2.0 IDD in stages as the localization subcommittees complete their work in order to begin the public review that is an integral part of the OASIS specification process. This first release contains translations of all the UBL 2.0 data definitions into Japanese, Italian, and Spanish; subsequent releases will add further translations as they become available.
The English-language data definitions contained in UBL 2.0 (as updated by Errata 01; see “Known issues” below) are normative. In other words, it is these definitions that must be referred to in resolving disputes over meaning that may arise in the use of XML documents purporting to comply with the UBL 2.0 standard, regardless of the language community in which the documents are employed. The translated definitions, on the other hand, are informative; they exist as aids in understanding the English-language definitions, not as replacements for those definitions.
[RFC 2119] S. Bradner. Key words for use in RFCs to Indicate Requirement Levels. IETF RFC 2119, March 1997. http://www.ietf.org/rfc/rfc2119.txt
[UBL 2.0] Universal Business Language v2.0. http://docs.oasis-open.org/ubl/os-UBL-2.0/
[UBL 2.0 Update] UBL 2.0 Update Package (Errata 01). http://docs.oasis-open.org/ubl/os-UBL-2.0-update/
To essentialize content for users in specific language communities and facilitate revisions expected from public review, the current release does not attempt to merge the various translations it contains into a single spreadsheet as done in the UBL 1.0 IDD; instead, it retains the structure of the data models as published in UBL 2.0 itself. These are organized within each language directory under two subdirectories called common and maindoc, which are described in detail in Appendix D of the UBL 2.0 standard (http://docs.oasis-open.org/ubl/os-UBL-2.0/UBL-2.0.html#MODELS). As in the original release, the data model spreadsheets are provided in both ODF (.ods) and Microsoft Excel (.xls) formats. Assuming that the current package has been installed by unzipping the archive referenced at the beginning of this document, the directory structure is as follows:
../prd1-UBL-2.0-idd UBL 2.0 IDD, Public Review Draft 1
./prd1-UBL-2.0-idd-ES Spanish UBL 2.0 Data Dictionary
./prd1-UBL-2.0-idd-ES/common common data models
./prd1-UBL-2.0-idd-ES/maindoc document data models
./prd1-UBL-2.0-idd-IT Italian UBL 2.0 Data Dictionary
./prd1-UBL-2.0-idd-IT/common common data models
./prd1-UBL-2.0-idd-IT/maindoc document data models
./prd1-UBL-2.0-idd-JP Japanese UBL 2.0 Data Dictionary
./prd1-UBL-2.0-idd-JP/common common data models
./prd1-UBL-2.0-idd-JP/maindoc document data models
In a specification the size of UBL 2.0, perfection is a goal that can never be completely achieved but can only be approached asymptotically over the course of many revisions. Subsequent translations of such specifications bear the additional burden of faithfully reflecting the content of the source document, even when such content has by then been discovered to be incorrect.
Extensive corrections to the more than 1900 English-language definitions in the UBL 2.0 Standard were published in April 2008 as the UBL 2.0 Update Package (known formally as UBL 2.0 Errata 01), which can be found as a downloadable zip file at http://docs.oasis-open.org/ubl/os-UBL-2.0-update-delta.zip along with instructions for applying the update to the original 2.0 release. The version of UBL created by applying the update according to the instructions can be found at http://docs.oasis-open.org/ubl/os-UBL-2.0-update/. It is the revised definitions contained in the ./mod directory of this updated version (http://docs.oasis-open.org/ubl/os-UBL-2.0-update/mod/) and copied in the schemas generated from these models that are translated in the present release. It should be noted that none of the changes to the data models made in the update affect the mechanical operation of software implementing the original UBL 2.0 schemas; the corrections apply only to data definitions and metadata.
As might be expected, the translation process itself has discovered (and will no doubt continue to discover) further corrections that will need to be made to the already updated data models. To maintain the distinction between the normative originals and the informative translations, such corrections will not be made to the translations pending the inclusion of the corrections in some future revision of UBL itself but will rather be listed in this sectiion of the IDD. Contracts written to enable the use of UBL documents between trading partners should point to these corrections as amendments to the definitions specified in UBL 2.0 Update or should reference suitably corrected data dictionaries prepared by the trading partners themselves.
Pending as of PRD01 are two sets of comments from the UBL Japanese Localization Subcommittee, a copy of which can be found at http://lists.oasis-open.org/archives/ubl/200809/msg00000.html. Dispositions of these comments are recorded in the minutes of the Pacific UBL TC call of 9 September 2008 at http://lists.oasis-open.org/archives/ubl/200809/msg00008.html. The first set of comments is still under discussion (logged on the issues list for UBL 2.1), but it was agreed that the following three comments identify errors that will clearly need to be corrected in UBL 2.1 (the numbers here reference the message from the JPLSC cited above):
2. (1) Cardinality of Consignment (ASBIE) in Shipment (ABIE) in UBL Common Library
The ASBIE named Consignment in the Shipment ABIE in the UBL Common Library has a cardinality of 1 (i.e., it is required). It should instead be optional (i.e., 0..n), because the relationship of Shipments to Consignments can be one to one, many to one, one to many, or many to many. See http://lists.oasis-open.org/archives/ubl/200801/msg00016.html.
2. (2) The definition of PayerReference in RemittanceAdvice
The definition of PayerReference (BBIE) in RemittanceAdvice says "An internal reference to the Payer's order for payment." This should be "An internal reference to the Payer for payment."
2. (3) The definition of AccountingCost
In the Update Package, the definition of the BBIE AccountingCost in the Order document was changed from "The Buyer's accounting code applied to the Order as a whole, expressed as text." to "The Buyer's accounting cost centre applied to the Order as a whole, expressed as text." This change (modified as appropriate) was entered in the Common Library and several other documents, but failed to be made in the following:
This document is intended as an aid in using UBL and therefore contains no conformance requirements.