The OASIS Business Document Naming and Design Rules [OBDNDR] specification defines a set of rules used to confirm the contents of a CCTS [CCTS] model of a business document’s structure and convert that model into a sets of document validation artifacts. Some of the NDRs regard the values of some CCTS components compared to the values of other CCTS components. Some of the NDRs regard the expression of the components in the validation artefacts.

Crane’s tools for generating these validation artefacts presume that the CCTS model is expressed as a sparsely-populated table using the OASIS genericode specification[genericode]. For the convenience of users, the model component values can originate from an OASIS Open Document Format Spreadsheet that is maintained offline by an application and saved as an ODS file, or maintained online as a Google Spreadsheet and downloaded as an ODS file.

Beyond the concepts found in the NDR, Crane’s tools also support generating the schemas for a subset of a model based on a user’s specification of overriding cardinality values for each information item. Such a “subset schema” has two primary roles:

Two examples of CCTS-based XML vocabularies following the OASIS Business Document NDR and with published validation artefacts created by earlier versions of these tools are:

Two tool set packages contain four programs used in the data flow depicted in Figure 1, “Business Document NDR model revision process”:

Figure 1. Business Document NDR model revision process

The focus of the process is to convert the genericode expression of the model (labeled [1] in the diagram) into a set of XSD files (labeled [2]) and optionally a CVA file.

The Crane-ods2obdgc[ods2obdgc] package includes the one tool of the same name (labeled [3]). This program converts an instance of ODS into an instance of genericode suitable for expressing an OASIS Business Document model. The package includes a pro-forma ODS instance with an empty row of each component type with which one can create a model from scratch.

The following three tools are in the Crane-gc2obdndr[gc2obdndr] package:

Two ODS files are depicted in the diagram to illustrate how the genericode expressions of two different revisions of a model, one an older version of the other. The process of creating artefacts for either version is the same. The Crane-checkgc4obdndr program can produce a report of the differences between the two revisions.

The use in the diagram of the online Google spreadsheet is optional. An ODS file can be maintained offline or it can be created as a download from Google Drive or by some other application. As a genericode file is suitable for interchange, there are no applications that directly manipulate the content of a genericode file.

Critical to the process is the tool configuration file written as XML. It has many sections:

<?xml version="1.0" encoding="UTF-8"?>
<configuration xmlns:xsd="http://www.w3.org/2001/XMLSchema">
 <ndr>
  <name-abbreviations>
    <!--a list of abbreviations mapping a short string to a long string
        where the abbreviation is allowed in a component name-->
    <abbreviation short="CV2">Card Verification Value</abbreviation>
  </name-abbreviations>
  <den-abbreviations>
    <!--a list of abbreviations mapping a short string to a long string
        where the abbreviation is allowed in a dectionary entry name-->
    <abbreviation short="CV2">Card Verification Value</abbreviation>
  </den-abbreviations>
  <equivalences>
    <!--a list of equivalences between a primary noun and a rep. term-->
    <equivalence>
      <primary-noun>URI</primary-noun>
      <representation-term>Identifier</representation-term>
    </equivalence>
  </equivalences>
  <expected-maindoc-BIEs>
    <!--a list of required Document ABIE initial properties that may be
        aribrarily positioned or otherwise specifically positioned in an
        order based on the attribute-->
    <property-term type="BBIE" cardinality="0..1" order="1"
                                  >UBL Version Identifier</property-term>
    <property-term type="ASBIE" cardinality="0..n"
                                  >Signature</property-term>
  </expected-maindoc-BIEs>
  <types>
    <!--the list of CCTS primary and secondary representation terms from
        CCTS table 8-3: Permissible Representation Terms-->
    <type>Amount</type>
  </types>
 </ndr>
 <schema version="2.1">
  <comment>
    The content of a metadata comment at the head of every file that is
    generated; the available string substitutions are:
       %% - a single percent sign
       %f - the module's configuration subdirectories and file name
       %n - the output ABIE name
       %t - the local time stamp for the file
       %z - the UTC (Zulu) time stamp for the file
</comment>
  <copyright position="end">
    The content of a copyright comment that can be positioned either
    at the start or the end of the generated file based on the mandatory
    position= attribute being "start" or "end".
</copyright>
  <type-documentation>
    <ccts:Component xmlns:ccts="urn:un:unece:uncefact:documentation:2">
       <!--the documentation to fill out for each component; the text value
           of the element is the compressed title of the CCTS spreadsheet
           column--> 
       <ccts:ComponentType>ComponentType</ccts:ComponentType>
    </ccts:Component>
  </type-documentation>
  <!--the directory structure (using <dir>) of a single file (using <file>)
      or a set of document ABIE files (using <files>) to be realized in the
      generated results:
      name= - the name of the documented directory or file
      runtime-name= - the name of the runtime directory or file
      type= - CVA - context/value association file
            - DABIE - Document ABIE file or files
            - CABIE - common Library ABIE file
            - CBBIE - common BBIE file
            - AABIE - alternate Document ABIE file or files
            - XABIE - extension ABIE file or files
            - SABIE - supplemental Library ABIE files
            - SBBIE - supplemental Library BBIE files
            - QDT - qualified data type file
            - UDT - unqualified data type file
            - EXT - extension metadata file
      skeleton-uri= - the pro-forma CVA file with qualification
                      data types
      prefix= - the namespace prefix to declare in the fragments for
                constructs in the given file
      namespace= - the namespace URI to declare in the fragments for
                   constructs in the given file 
      syntax= - indication of a non-XML syntax (e.g. "JSON")
      
      Specialized children of the <file> or <files> element
      
      type="{any}"
       <imports> = the list of <xsd:import> statements to add to the result
       
      type="XABIE"
       <elements> = the element declarations to add after all of the
                    BBIE and ASBIE child elements of the extension
                    ABIE have been declared
                    
      type="EXT":
       <elements> = the extension element declaration at the start of
                    every Document ABIE or alternate Document ABIE
                    
      type="EXT", syntax="JSON":
       <declarations> = the extension declaration to be added at the start of
                        every Document ABIE or alternate Document ABIE
  -->
  <dir name="{base directory name}">
    <dir name="{subdirectory name}">     
    <!--file declarations-->
    </dir>
  </dir>
 </schema>
</configuration>

The UBL 2.1 main configuration file is as follows:

<?xml version="1.0" encoding="UTF-8"?>
<!DOCTYPE configuration
[
<!ENTITY versionDisplay "2.1 OS">
<!ENTITY versionDirectory   "os-UBL-2.1">
<!ENTITY versionDate        "04 November 2013">
]>
<configuration xmlns:xsd="http://www.w3.org/2001/XMLSchema">
  <!--
    This is the configuration of the base schema fragments for UBL 2.1
  -->
 <ndr>
  <name-abbreviations>
    <abbreviation short="CV2">Card Verification Value</abbreviation>
    <abbreviation short="ID">Identifier</abbreviation>
    <abbreviation short="URI">Uniform Resource Identifier</abbreviation>
    <abbreviation short="UNDG">United Nations Development Group</abbreviation>
    <abbreviation short="UBL">Universal Business Language</abbreviation>
    <abbreviation short="UUID">Universally Unique Identifier</abbreviation>
    <abbreviation short="XPath">XML Path Language</abbreviation>
  </name-abbreviations>
  <den-abbreviations>
    <abbreviation short="CV2">Card Verification Value</abbreviation>
    <abbreviation short="URI">Uniform Resource Identifier</abbreviation>
    <abbreviation short="UNDG">United Nations Development Group</abbreviation>
    <abbreviation short="UBL">Universal Business Language</abbreviation>
    <abbreviation short="UUID">Universally Unique Identifier</abbreviation>
    <abbreviation short="XPath">XML Path Language</abbreviation>
  </den-abbreviations>
  <equivalences>
    <equivalence>
      <primary-noun>URI</primary-noun>
      <representation-term>Identifier</representation-term>
    </equivalence>
    <equivalence>
      <primary-noun>UUID</primary-noun>
      <representation-term>Identifier</representation-term>
    </equivalence>
  </equivalences>
  <expected-maindoc-BIEs>
    <property-term type="BBIE" cardinality="0..1" order="1"
                                  >UBL Version Identifier</property-term>
    <property-term type="BBIE" cardinality="0..1" order="2"
                                  >Customization Identifier</property-term>
    <property-term type="BBIE" cardinality="0..1" order="3"
                                  >Profile Identifier</property-term>
    <property-term type="BBIE" cardinality="0..1" order="4"
                                  >Profile Execution Identifier</property-term>
    <property-term type="ASBIE" cardinality="0..n"
                                  >Signature</property-term>
  </expected-maindoc-BIEs>
  <types>
    <type>Amount</type>
    <type>Binary Object</type>
    <type>Code</type>
    <type>Date Time</type>
    <type>Date</type>
    <type>Graphic</type>
    <type>Identifier</type>
    <type>Indicator</type>
    <type>Measure</type>
    <type>Name</type>
    <type>Numeric</type>
    <type>Percent</type>
    <type>Picture</type>
    <type>Quantity</type>
    <type>Rate</type>
    <type>Sound</type>
    <type>Text</type>
    <type>Time</type>
    <type>Value</type>
    <type>Video</type>
  </types>
 </ndr>
 <schema version="2.1">
  <comment>
  Library:           OASIS Universal Business Language (UBL) &versionDisplay;
                     http://docs.oasis-open.org/ubl/&versionDirectory;/
  Release Date:      &versionDate;
  Module:            %f
  Generated on:      %z
  Copyright (c) OASIS Open 2016. All Rights Reserved.
</comment>
    <copyright position="end">
  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's 
  procedures with respect to rights in OASIS specifications can be 
  found at 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 
  implementors or users of this specification, can be obtained from 
  the OASIS Executive Director.

  OASIS invites any interested party to bring to its attention any 
  copyrights, patents or patent applications, or other proprietary 
  rights which may cover technology that may be required to 
  implement this specification. Please address the information to the 
  OASIS Executive Director.
  
  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 
  paragraph are included on all such copies and derivative works. 
  However, this document itself may not be modified in any way, 
  such as by removing the copyright notice or references to OASIS, 
  except as needed for the purpose of developing OASIS 
  specifications, in which case the procedures for copyrights defined 
  in the OASIS Intellectual Property Rights document 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 RIGHTS OR ANY IMPLIED 
  WARRANTIES OF MERCHANTABILITY OR FITNESS FOR A 
  PARTICULAR PURPOSE.    
</copyright>
  <type-documentation>
    <ccts:Component xmlns:ccts="urn:un:unece:uncefact:documentation:2">
       <ccts:ComponentType>ComponentType</ccts:ComponentType>
       <ccts:DictionaryEntryName>DictionaryEntryName</ccts:DictionaryEntryName>
       <ccts:Version>Version</ccts:Version>
       <ccts:Definition>Definition</ccts:Definition>
       <ccts:Cardinality>Cardinality</ccts:Cardinality>
       <ccts:ObjectClassQualifier>ObjectClassQualifier</ccts:ObjectClassQualifier>
       <ccts:ObjectClass>ObjectClass</ccts:ObjectClass>
       <ccts:PropertyTermQualifier>PropertyTermQualifier</ccts:PropertyTermQualifier>
       <ccts:PropertyTerm>PropertyTerm</ccts:PropertyTerm>
       <ccts:AssociatedObjectClass>AssociatedObjectClass</ccts:AssociatedObjectClass>
       <ccts:RepresentationTerm>RepresentationTerm</ccts:RepresentationTerm>
       <ccts:DataTypeQualifier>DataTypeQualifier</ccts:DataTypeQualifier>
       <ccts:DataType>DataType</ccts:DataType>
       <ccts:AlternativeBusinessTerms
                            >AlternativeBusinessTerms</ccts:AlternativeBusinessTerms>
       <ccts:Examples>Examples</ccts:Examples>
    </ccts:Component>
  </type-documentation>
  <dir name="cva">
    <file type="CVA" name="UBL-DefaultDTQ-2.1.cva"
          skeleton-uri="UBL-2.1-CVA-Skeleton.cva"/>
  </dir>
  <dir name="xsd" runtime-name="xsdrt">
    <dir name="common">
      <file type="CABIE" name="UBL-CommonAggregateComponents-2.1.xsd"
            prefix="cac"
namespace="urn:oasis:names:specification:ubl:schema:xsd:CommonAggregateComponents-2"/>
      <file type="CBBIE" name="UBL-CommonBasicComponents-2.1.xsd"
            prefix="cbc"
namespace="urn:oasis:names:specification:ubl:schema:xsd:CommonBasicComponents-2"/>
      <file type="QDT" name="UBL-QualifiedDataTypes-2.1.xsd"
            prefix="qdt"
namespace="urn:oasis:names:specification:ubl:schema:xsd:QualifiedDataTypes-2"/>
      <file type="UDT" name="UBL-UnqualifiedDataTypes-2.1.xsd"
            prefix="udt"
namespace="urn:oasis:names:specification:ubl:schema:xsd:UnqualifiedDataTypes-2"/>
      <file type="EXT" name="UBL-CommonExtensionComponents-2.1.xsd"
            prefix="ext"
namespace="urn:oasis:names:specification:ubl:schema:xsd:CommonExtensionComponents-2">
        <elements>
         <xsd:element ref="ext:UBLExtensions" minOccurs="0" maxOccurs="1">
            <xsd:annotation>
               <xsd:documentation>A container for all extensions present in the
 document.</xsd:documentation>
            </xsd:annotation>
         </xsd:element>
        </elements>
      </file>
    </dir>
    <dir name="maindoc">
      <files type="DABIE" name="UBL-%n-2.1.xsd"
             namespace="urn:oasis:names:specification:ubl:schema:xsd:%n-2">
        <element-documentation>This element MUST be conveyed as the root element in
 any instance document based on this Schema expression</element-documentation>
      </files>
    </dir>
  </dir>
   <dir name="json-schema">
    <dir name="common">
      <file type="CABIE" name="UBL-CommonAggregateComponents-2.1.json"
            syntax="JSON"
namespace="urn:oasis:names:specification:ubl:schema:xsd:CommonAggregateComponents-2"/>
      <file type="CBBIE" name="UBL-CommonBasicComponents-2.1.json"
            syntax="JSON"
namespace="urn:oasis:names:specification:ubl:schema:xsd:CommonBasicComponents-2"/>
      <file type="QDT" name="UBL-QualifiedDataTypes-2.1.json"
            syntax="JSON"
namespace="urn:oasis:names:specification:ubl:schema:xsd:QualifiedDataTypes-2"/>
      <file type="UDT" name="UBL-UnqualifiedDataTypes-2.1.json"
            syntax="JSON"
namespace="urn:oasis:names:specification:ubl:schema:xsd:UnqualifiedDataTypes-2"/>
      <file type="EXT" name="UBL-CommonExtensionComponents-2.1.json"
            syntax="JSON"
namespace="urn:oasis:names:specification:ubl:schema:xsd:CommonExtensionComponents-2">
        <declaration>
        "UBLExtensions": {
          "title": "UBLExtensions",
          "description": "An optional set of extensions to the committee model",
          "items": { 
            "$ref":
 "../common/UBL-CommonExtensionComponents-2.1.json#/definitions/UBLExtensions" },
          "maxItems": 1,
          "minItems": 1,
          "additionalProperties": false,
          "type": "array"
          },

</declaration>
      </file>
    </dir>
     <dir name="maindoc">
       <files type="DABIE" name="UBL-%n-2.1.json"
              syntax="JSON"
              namespace="urn:oasis:names:specification:ubl:schema:xsd:%n-2"/>
    </dir>
   </dir>
 </schema>
</configuration>

The UBL 2.2 Signature Extension configuration file is as follows:

<?xml version="1.0" encoding="UTF-8"?>
<!DOCTYPE configuration
[
<!ENTITY versionDisplay "2.1 OS">
<!ENTITY versionDirectory   "os-UBL-2.1">
<!ENTITY versionDate        "04 November 2013">
]>
<configuration xmlns:xsd="http://www.w3.org/2001/XMLSchema">
  <ndr>
  <name-abbreviations>
    <abbreviation short="CV2">Card Verification Value</abbreviation>
    <abbreviation short="ID">Identifier</abbreviation>
    <abbreviation short="URI">Uniform Resource Identifier</abbreviation>
    <abbreviation short="UNDG">United Nations Development Group</abbreviation>
    <abbreviation short="UBL">Universal Business Language</abbreviation>
    <abbreviation short="UUID">Universally Unique Identifier</abbreviation>
    <abbreviation short="XPath">XML Path Language</abbreviation>
  </name-abbreviations>
  <den-abbreviations>
    <abbreviation short="CV2">Card Verification Value</abbreviation>
    <abbreviation short="URI">Uniform Resource Identifier</abbreviation>
    <abbreviation short="UNDG">United Nations Development Group</abbreviation>
    <abbreviation short="UBL">Universal Business Language</abbreviation>
    <abbreviation short="UUID">Universally Unique Identifier</abbreviation>
    <abbreviation short="XPath">XML Path Language</abbreviation>
  </den-abbreviations>
  <equivalences>
    <equivalence>
      <primary-noun>URI</primary-noun>
      <representation-term>Identifier</representation-term>
    </equivalence>
    <equivalence>
      <primary-noun>UUID</primary-noun>
      <representation-term>Identifier</representation-term>
    </equivalence>
  </equivalences>
  <fields-allowing-excess-space>
    <field-name>Definition</field-name>
    <field-name>Examples</field-name>
    <field-name>EditorsNotes</field-name>
  </fields-allowing-excess-space>
  <types>
    <type>Amount</type>
    <type>Binary Object</type>
    <type>Code</type>
    <type>Date Time</type>
    <type>Date</type>
    <type>Graphic</type>t
    <type>Identifier</type>
    <type>Indicator</type>
    <type>Measure</type>
    <type>Name</type>
    <type>Numeric</type>
    <type>Percent</type>
    <type>Picture</type>
    <type>Quantity</type>
    <type>Rate</type>
    <type>Sound</type>
    <type>Text</type>
    <type>Time</type>
    <type>Value</type>
    <type>Video</type>
  </types>
  </ndr>
  <schema version="2.1">
<comment>
  Library:           OASIS Universal Business Language (UBL) &versionDisplay;
                     http://docs.oasis-open.org/ubl/&versionDirectory;/
  Release Date:      &versionDate;
  Module:            %f
  Generated on:      %z
  Copyright (c) OASIS Open 2013. All Rights Reserved.
</comment>
    <copyright position="end">
  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's 
  procedures with respect to rights in OASIS specifications can be 
  found at 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 
  implementors or users of this specification, can be obtained from 
  the OASIS Executive Director.

  OASIS invites any interested party to bring to its attention any 
  copyrights, patents or patent applications, or other proprietary 
  rights which may cover technology that may be required to 
  implement this specification. Please address the information to the 
  OASIS Executive Director.
  
  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 
  paragraph are included on all such copies and derivative works. 
  However, this document itself may not be modified in any way, 
  such as by removing the copyright notice or references to OASIS, 
  except as needed for the purpose of developing OASIS 
  specifications, in which case the procedures for copyrights defined 
  in the OASIS Intellectual Property Rights document 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 RIGHTS OR ANY IMPLIED 
  WARRANTIES OF MERCHANTABILITY OR FITNESS FOR A 
  PARTICULAR PURPOSE.    
</copyright>
    <type-documentation>
      <ccts:Component xmlns:ccts="urn:un:unece:uncefact:documentation:2">
         <ccts:ComponentType>ComponentType</ccts:ComponentType>
         <ccts:DictionaryEntryName>DictionaryEntryName</ccts:DictionaryEntryName>
         <ccts:Version>Version</ccts:Version>
         <ccts:Definition>Definition</ccts:Definition>
         <ccts:Cardinality>Cardinality</ccts:Cardinality>
         <ccts:ObjectClassQualifier>ObjectClassQualifier</ccts:ObjectClassQualifier>
         <ccts:ObjectClass>ObjectClass</ccts:ObjectClass>
         <ccts:PropertyTermQualifier>PropertyTermQualifier</ccts:PropertyTermQualifier>
         <ccts:PropertyTerm>PropertyTerm</ccts:PropertyTerm>
         <ccts:AssociatedObjectClass>AssociatedObjectClass</ccts:AssociatedObjectClass>
         <ccts:RepresentationTerm>RepresentationTerm</ccts:RepresentationTerm>
         <ccts:DataTypeQualifier>DataTypeQualifier</ccts:DataTypeQualifier>
         <ccts:DataType>DataType</ccts:DataType>
         <ccts:AlternativeBusinessTerms>AlternativeBusinessTerms</ccts:AlternativeBusinessTerms>
         <ccts:Examples>Examples</ccts:Examples>
      </ccts:Component>
    </type-documentation>
  <dir name="xsd" runtime-name="xsdrt">
      <dir name="common">
        <file type="XABIE" name="UBL-CommonSignatureComponents-2.1.xsd"
              abie="UBLDocumentSignatures"
namespace="urn:oasis:names:specification:ubl:schema:xsd:CommonSignatureComponents-2"/>
        <file type="SABIE" name="UBL-SignatureAggregateComponents-2.1.xsd"
              prefix="sac"
namespace="urn:oasis:names:specification:ubl:schema:xsd:SignatureAggregateComponents-2">
          <imports>

   <!-- ===== Incorporate W3C signature specification-->
   <xsd:import namespace="http://www.w3.org/2000/09/xmldsig#" 
               schemaLocation="UBL-xmldsig-core-schema-2.1.xsd"/>

   <!-- ===== Incorporate ETSI signature specifications-->
   <xsd:import namespace="http://uri.etsi.org/01903/v1.3.2#" 
               schemaLocation="UBL-XAdESv132-2.1.xsd"/>
   <xsd:import namespace="http://uri.etsi.org/01903/v1.4.1#"
               schemaLocation="UBL-XAdESv141-2.1.xsd"/>
          </imports>
          <elements xmlns:ds="http://www.w3.org/2000/09/xmldsig#"
                    abie="SignatureInformation">
         <xsd:element ref="ds:Signature" minOccurs="0" maxOccurs="1">
           <xsd:annotation>
             <xsd:documentation>This is a single digital signature as defined by the W3C specification.</xsd:documentation>
           </xsd:annotation>
         </xsd:element>
          </elements>
        </file>
        <file type="SBBIE" name="UBL-SignatureBasicComponents-2.1.xsd"
              prefix="sbc"
namespace="urn:oasis:names:specification:ubl:schema:xsd:SignatureBasicComponents-2"/>
      </dir>
    </dir>
  </schema>
</configuration>

The val/ directory contains a copy of the UBL validation tools, and six test instances: two being a UBL sample invoice document with a (thematically irrelevant) timesheet extension and four being a custom document exploiting the UBL common library definition of a party. In each pair of documents, one of the documents has no constraint violations and validates without error, while the other has misspelled element names in order to trigger a validation error to prove the schemas are in play.

In each of these example instances, note the careful use of namespaces and their associated prefixes. Remember, of course, the prefixes chosen are inconsequential and need not be the same as the prefixes used in the schemas.

The test invoice documents InvoiceExt.xml and InvoiceExtBad.xml begin with a timesheet extension that use both common and foreign constructs:

<Invoice xmlns="urn:oasis:names:specification:ubl:schema:xsd:Invoice-2"
 xmlns:cac="urn:oasis:names:specification:ubl:schema:xsd:CommonAggregateComponents-2"
 xmlns:cbc="urn:oasis:names:specification:ubl:schema:xsd:CommonBasicComponents-2"
 xmlns:ext="urn:oasis:names:specification:ubl:schema:xsd:CommonExtensionComponents-2"
 xmlns:mxd="urn:X-MyCompany:xsd:MyTimesheetExtension"
 xmlns:mxa="urn:X-MyCompany:xsd:MyTimesheetExtension:AggregateComponents"
 xmlns:mxb="urn:X-MyCompany:xsd:MyTimesheetExtension:BasicComponents">
  <ext:UBLExtensions>
    <ext:UBLExtension>
      <!-- standardized extension metadata inserted here if desired -->
      <!-- followed by the extension content with a foreign apex construct -->
      <ext:ExtensionContent>
        <mxd:Timesheet>
          <cbc:StartDate>2011-10-01</cbc:StartDate>
          <cbc:EndDate>2011-10-31</cbc:EndDate>
          <mxa:TimesheetParty>
            <mxa:TimesheetEntry>
              <cbc:Date>2011-10-12</cbc:Date>
              <mxb:HoursNumeric>4</mxb:HoursNumeric>
              <mxa:Task>
                <cbc:Description>Teleconference</cbc:Description>
                <mxb:HoursNumeric>1</mxb:HoursNumeric>
              </mxa:Task>
              <mxa:Task>
                <cbc:Description>Development</cbc:Description>
                <mxb:HoursNumeric>3</mxb:HoursNumeric>
              </mxa:Task>
            </mxa:TimesheetEntry>
            <cac:Party>
              <cac:PartyIdentification>
                <cbc:ID>Ken</cbc:ID>
              </cac:PartyIdentification>
            </cac:Party>
          </mxa:TimesheetParty>
        </mxd:Timesheet>
      </ext:ExtensionContent>
    </ext:UBLExtension>
  </ext:UBLExtensions>
  <cbc:UBLVersionID>2.0</cbc:UBLVersionID>
  <!-- remaining invoice content continues here -->

The custom documents MyRARequest.xml and MyRARequestBad.xml are short and contain both common and foreign constructs:

<ReturnAuthorizationRequest
  xmlns="urn:X-MyCompany:xsd:MyReturnAuthorizationRequest"
  xmlns:rqa="urn:X-MyCompany:xsd:MyRARequestResponse:AggregateComponents"
  xmlns:rqb="urn:X-MyCompany:xsd:MyRARequestResponse:BasicComponents"
  xmlns:cac="urn:oasis:names:specification:ubl:schema:xsd:CommonAggregateComponents-2"
  xmlns:cbc="urn:oasis:names:specification:ubl:schema:xsd:CommonBasicComponents-2">
  <rqb:RequestDate>2011-11-15</rqb:RequestDate>
  <rqa:RequestingParty>
    <cac:Contact>
      <cbc:ElectronicMail>joeBloggs@example.com</cbc:ElectronicMail>
    </cac:Contact>
  </rqa:RequestingParty>
  <rqa:ReturnRequested>
    <rqb:RequestedQuantity>3</rqb:RequestedQuantity>
    <cac:OrderLineReference>
      <cbc:LineID>1</cbc:LineID>
      <cac:OrderReference>
        <cbc:ID>20111110-0112</cbc:ID>
      </cac:OrderReference>
    </cac:OrderLineReference>
  </rqa:ReturnRequested>
</ReturnAuthorizationRequest>

<ReturnAuthorizationRequest
  xmlns="urn:X-MyCompany:xsd:MyReturnAuthorizationRequest"
  xmlns:rqa="urn:X-MyCompany:xsd:MyRARequestResponse:AggregateComponents"
  xmlns:rqb="urn:X-MyCompany:xsd:MyRARequestResponse:BasicComponents"
  xmlns:cac="urn:oasis:names:specification:ubl:schema:xsd:CommonAggregateComponents-2"
  xmlns:cbc="urn:oasis:names:specification:ubl:schema:xsd:CommonBasicComponents-2">
  <rqb:RequestDate>2011-11-15</rqb:RequestDate>
  <rqa:RequestingParty>
    <cac:Contact>
      <cbc:ElectronicMail>joeBloggs@example.com</cbc:ElectronicMail>
    </cac:Contact>
  </rqa:RequestingParty>
  <rqa:ReturnRequested>
    <rqb:RequestedQuantityx>3</rqb:RequestedQuantityx>
    <cac:OrderLineReference>
      <cbc:LineID>1</cbc:LineID>
      <cac:OrderReference>
        <cbc:ID>20111110-0112</cbc:ID>
      </cac:OrderReference>
    </cac:OrderLineReference>
  </rqa:ReturnRequested>
</ReturnAuthorizationRequest>

The custom documents MyRAResponse.xml and MyRAResponseBad.xml are short and contain both common and foreign constructs:

<ReturnAuthorizationResponse
  xmlns="urn:X-MyCompany:xsd:MyReturnAuthorizationResponse"
  xmlns:rsa="urn:X-MyCompany:xsd:MyRARequestResponse:AggregateComponents"
  xmlns:rsb="urn:X-MyCompany:xsd:MyRARequestResponse:BasicComponents"
  xmlns:cac="urn:oasis:names:specification:ubl:schema:xsd:CommonAggregateComponents-2"
  xmlns:cbc="urn:oasis:names:specification:ubl:schema:xsd:CommonBasicComponents-2">
  <cbc:ResponseDate>2011-11-15</cbc:ResponseDate>
  <rsb:ReturnGrantedIndicator>true</rsb:ReturnGrantedIndicator>
  <rsa:AuthorizingParty>
    <cac:PartyIdentification>
      <cbc:ID>EMP0987</cbc:ID>
    </cac:PartyIdentification>
  </rsa:AuthorizingParty>
  <rsa:RequestDocumentReference>
    <cbc:ID>17134</cbc:ID>
  </rsa:RequestDocumentReference>
  <rsa:ReturnGranted>
    <rsb:GrantedQuantity>2</rsb:GrantedQuantity>
    <rsa:ReturnRequested>
      <rsb:RequestedQuantity>3</rsb:RequestedQuantity>
      <cac:OrderLineReference>
        <cbc:LineID>1</cbc:LineID>
        <cac:OrderReference>
          <cbc:ID>20111110-0112</cbc:ID>
        </cac:OrderReference>
      </cac:OrderLineReference>
    </rsa:ReturnRequested>
  </rsa:ReturnGranted>
</ReturnAuthorizationResponse>

<ReturnAuthorizationResponse
  xmlns="urn:X-MyCompany:xsd:MyReturnAuthorizationResponse"
  xmlns:rsa="urn:X-MyCompany:xsd:MyRARequestResponse:AggregateComponents"
  xmlns:rsb="urn:X-MyCompany:xsd:MyRARequestResponse:BasicComponents"
  xmlns:cac="urn:oasis:names:specification:ubl:schema:xsd:CommonAggregateComponents-2"
  xmlns:cbc="urn:oasis:names:specification:ubl:schema:xsd:CommonBasicComponents-2">
  <cbc:ResponseDate>2011-11-15</cbc:ResponseDate>
  <rsb:ReturnGrantedIndicator>true</rsb:ReturnGrantedIndicator>
  <rsa:AuthorizingParty>
    <cac:PartyIdentification>
      <cbc:ID>EMP0987</cbc:ID>
    </cac:PartyIdentification>
  </rsa:AuthorizingParty>
  <rsa:RequestDocumentReference>
    <cbc:ID>17134</cbc:ID>
  </rsa:RequestDocumentReference>
  <rsa:ReturnGranted>
    <rsb:GrantedQuantityx>2</rsb:GrantedQuantityx>
    <rsa:ReturnRequested>
      <rsb:RequestedQuantity>3</rsb:RequestedQuantity>
      <cac:OrderLineReference>
        <cbc:LineID>1</cbc:LineID>
        <cac:OrderReference>
          <cbc:ID>20111110-0112</cbc:ID>
        </cac:OrderReference>
      </cac:OrderLineReference>
    </rsa:ReturnRequested>
  </rsa:ReturnGranted>
</ReturnAuthorizationResponse>

This environment will create an OASIS context/value association file [CVA] for every configuration file entry of type “CVA”. Typically there will be only zero or one such file in the configuration, as all such files will perform the same analysis on the input genericode files.

When present, the CVA configuration file entry specifies the URI of a skeleton CVA file used as a proforma output document. This skeleton file is schema-valid using the OASIS CVA XSD schemas, however, the empty address= attributes will be unacceptable to downstream processing. Thus, the skeleton can only be used as a pro-forma to create the production CVA. The skeleton is annotated with indications of which BBIEs of the model are to have their XPath address included in the context, determined by their data type in the <c:DataType xmlns:c="urn:X-Crane-gc2obdndr"> element. This environment recognizes these annotations and replaces the address= attributes with the appropriate XSLT match pattern of XPath addresses, preserving the annotation as documentation for the reader.

An example from UBL 2.1 found in ubl/UBL-2.1-CVA-Skeleton.cva is for the data type “Currency_ Code. Type”. The input skeleton CVA file contains the element with the empty address= attribute:

...xmlns:c="urn:X-Crane-gc2obdndr"...
<Context values="Currency-2.0 Currency-2.1"
         metadata="cctsV2.01-code"
         address="">
  <Annotation>
    <AppInfo>
      <c:DataType>Currency_ Code. Type</c:DataType>
    </AppInfo>
  </Annotation>
</Context>

The output populated CVA file contains the corresponding element with a populated address= attribute:

<Context values="Currency-2.0 Currency-2.1" metadata="cctsV2.01-code"
         address="cbc:CurrencyCode | cbc:DocumentCurrencyCode | 
                  cbc:PaymentAlternativeCurrencyCode | 
                  cbc:PaymentCurrencyCode | cbc:PricingCurrencyCode | 
                  cbc:RequestedInvoiceCurrencyCode | 
                  cbc:SourceCurrencyCode | cbc:TargetCurrencyCode | 
                  cbc:TaxCurrencyCode">
   <Annotation>
      <AppInfo>
         <c:DataType>Currency_ Code. Type</c:DataType>
      </AppInfo>
  </Annotation>
</Context>

The creation of an XSLT stylesheet from the combination of a CVA file and its referenced genericode files can be implemented using the Crane-cva2sch package.