Copyright © 2008 Crane Softwrights Ltd.
$Date: 2008/10/24 21:20:00 $(UTC)
Table of Contents
This is a conversion of the OASIS [OASIS] UBL [UBL 2.0] language-specific International Data Dictionary (IDD) spreadsheets into OASIS genericode [genericode] files and an HTML summary. This exercise produces three results:
helps to determine any consistency faults coded in the spreadsheets,
generates useful XML reference files for use by XML-aware applications, and
generates a useful HTML summary document of all UBL information entities in all languages.
An application may wish to, for example, read the genericode version of the IDD files and present user interface information with language-specific help information.
All content in this package is labeled "prd1-UBL-2.0-update-IDD
" as this was derived from the ZIP file announced at http://lists.oasis-open.org/archives/ubl/200810/msg00029.html
.
As new localization files are released, this resource file will be regenerated with the latest and posted with Crane Softwrights Ltd.'s UBL resources[Crane Resources].
The ZIP package includes the following directories:
doc/
- documentation
readme-CraneIDD2genericode.html
(this file)
one HTML file with the complete IDD for all document models (for better viewing, maximize the browser window to the size of your screen)
gc/
- genericode files
gc/aggregate/
- one genericode file per document model for all languages
gc/{language}/
- one genericode file per document model for each language
The latest publication of genericode[genericode 1.0] includes documentation and W3C Schema document models.
The genericode files in this package are designed to convey the IDD information to application developers, not necessarily directly to applications, in this form. As with code list validation when using genericode, the information in the genericode files is transformed into a format more suitable for run-time processing (in that example to a Schematron schema intermediate format and on to either XSLT or Python run-time format).
As such, genericode is meant to be an interchange format and not an internal application data representation. The information is organized in a keyed table. For the UBL IDD there are two unique keys in each genericode file: an ordinal row number and the dictionary entry name.
Applications are not expected to be using genericode expressions at run-time, though they are of course welcome to do so.
The aggregate genericode files and associated HTML report in this package contain business terms and definitions in all of the available languages. An application developer may wish to dispatch all or portions of the aggregate file into standalone run-time custom representations suitable for the application to access.
Here is a sample entry using the Postbox
row of the aggregate common library genericode file:
<gc:CodeList xmlns:gc="http://docs.oasis-open.org/codelist/ns/genericode/1.0/" xmlns:idd="urn:oasis:names:ubl:idd:gc"> <Identification> <ShortName>prd1-UBL-2.0-update-IDD</ShortName> <LongName xml:lang="en">Universal Business Language International Data Dictionary - CommonLibrary</LongName> <Version>20081024-2120z</Version> <CanonicalUri>urn:oasis:names:ubl:idd:gc:prd1-UBL-2.0-update-IDD-CommonLibrary</CanonicalUri> <CanonicalVersionUri>urn:oasis:names:ubl:idd:gc:prd1-UBL-2.0-update-IDD-CommonLibrary-20081024-2120z</CanonicalVersionUri> <Agency> <LongName xml:lang="en">OASIS Universal Business Language</LongName> <Identifier>UBL</Identifier> </Agency> </Identification> <ColumnSet> ... </ColumnSet> <SimpleCodeList> ... <Row> <Value ColumnRef="RowNumber"> <SimpleValue>5</SimpleValue> </Value> <Value ColumnRef="DictionaryEntryName"> <SimpleValue>Address. Postbox. Text</SimpleValue> </Value> <Value ColumnRef="UBLName"> <SimpleValue>Postbox</SimpleValue> </Value> <Value ColumnRef="UBLDefinition"> <SimpleValue>A post office box number.</SimpleValue> </Value> <Value ColumnRef="Cardinality"> <SimpleValue>0..1</SimpleValue> </Value> <Value ColumnRef="ComponentType"> <SimpleValue>BBIE</SimpleValue> </Value> <Value ColumnRef="BusinessTerms"> <ComplexValue> <idd:Value xml:lang="EN">PostBox, PO Box</idd:Value> <idd:Value xml:lang="JP">私書箱番号</idd:Value> <idd:Value xml:lang="ES">Apartado postal</idd:Value> <idd:Value xml:lang="IT">Casella Postale</idd:Value> </ComplexValue> </Value> <Value ColumnRef="Definition"> <ComplexValue> <idd:Value xml:lang="EN">A post office box number.</idd:Value> <idd:Value xml:lang="JP">私書箱番号。</idd:Value> <idd:Value xml:lang="ES">Número de apartado postal</idd:Value> <idd:Value xml:lang="IT">Un numero di casella postale.</idd:Value> </ComplexValue> </Value> </Row> ... </SimpleCodeList> </gc:CodeList>
Feedback on any aspect of this package is eagerly sought. Please use the contact information above.
[Crane Resources] Crane Softwrights Ltd. Free developer resources
[genericode] Tony Coates genericode, UBL Code List Representation Technical Committee
[genericode 1.0] http://docs.oasis-open.org/codelist/genericode/
[UBL 2.0] Jon Bosak, Tim McGrath, G. Ken Holman Universal Business Language (UBL) Version 2.0, OASIS UBL Technical Committee 2006