Universal Business Language Naming and Design Rules[GSX] General XML Schema Rules UBL Schema, except in the case of extension, where the 'UBL Extensions' element is used, MUST conform to the following physical layout as applicable: <!-- ======= XML Declaration======== --> <?xml version="1.0" encoding="UTF-8"?> <!-- ======= Schema Header ======= --> Document Name: < Document name as indicated in Section 3.6 > Generated On: < Date schema was generated > <!-- ===== xsd:schema Element With Namespaces Declarations ===== --> xsd:schema element to include version attribute and namespace declarations in the following order: xmlns:xsd Target namespace Default namespace CommonAggregateComponents CommonBasicComponents CoreComponentTypes Unqualified Datatypes Qualified Datatypes Identifier Schemes Code Lists Attribute Declarations – elementFormDefault="qualified" attributeFormDefault="unqualified" Version Attribute <!-- ===== Imports ===== --> CommonAggregateComponents schema module CommonBasicComponents schema module Unqualified Types schema module Qualified Types schema module <!-- ===== Root Element ===== --> Root Element Declaration Root Element Type Definition <!-- ===== Element Declarations ===== --> alphabetized order <!-- ===== Type Definitions ===== --> All type definitions segregated by basic and aggregates as follows <!-- ===== Aggregate Business Information Entity Type Definitions ===== --> alphabetized order of ccts:AggregateBusinessInformationEntity xsd:TypeDefinitions <!-- =====Basic Business Information Entity Type Definitions ===== --> alphabetized order of ccts:BasicBusinessInformationEntities <!-- ===== Copyright Notice ===== --> Required OASIS full copyright notice. The xsd:any element MUST NOT be used except within the 'ExtensionContentType' type definition, and with xsd:processContents= "skip" for non-UBL namespaces. UBL MUST provide two normative schemas for each transaction. One schema shall be fully annotated. One schema shall be a run-time schema devoid of documentation. [ELD]Element Declaration rules The root element MUST be the only global element declared in document schemas. All element declarations MUST be global The 'UBL Extensions' element MUST be declared as the first child of the document element with xsd:minOccurs="0". The 'UBLProfileID' element MUST be declared immediately following the 'UBL Extensions' element with xsd:minOccurs="0".". The 'UBLSubsetID' element MUST be declared immediately following the 'UBLProfileID' element with xsd:minOccurs="0". [NMC]Naming Constraints Rules Each dictionary entry name MUST define one and only one fully qualified path (FQP) for an element or attribute. [MDC]Modeling Constraints Rules UBL Libraries and Schemas MUST only use ebXML Core Component approved ccts:CoreComponentTypes, except in the case of extension, where the 'UBL ExtensionS' element is used. Mixed content MUST NOT be used except where contained in an xsd:documentation element. <xsd:element name="Party" type="PartyType"/> <xsd:complexType name="PartyType"> <xsd:annotation> <!—Documentation goes here --> </xsd:annotation> <xsd:sequence> <xsd:element ref="cbc:MarkCareIndicator" minOccurs="0" maxOccurs="1"> ... </xsd:element> <xsd:element ref="cbc:MarkAttentionIndicator" minOccurs="0" maxOccurs="1"> ... </xsd:element> <xsd:element ref="PartyIdentification" minOccurs="0" maxOccurs="unbounded"> ... </xsd:element> <xsd:element ref="PartyName" minOccurs="0" maxOccurs="1"> ... </xsd:element> <xsd:element ref="Address" minOccurs="0" maxOccurs="1"> ... </xsd:element> ... </xsd:sequence> </xsd:complexType> <xsd:element name="Address" type="AddressType"/> <xsd:complexType name="AddressType"> ... <xsd:sequence> <xsd:element ref="cbc:CityName" minOccurs="0" maxOccurs="1"> ... </xsd:element> <xsd:element ref="cbc:PostalZone" minOccurs="0" maxOccurs="1"> ... </xsd:element> ... </xsd:sequence> </xsd:complexType> [NMS] Namespace Rule Every UBL-defined –or -used schema module, except internal schema modules, MUST have a namespace declared using the xsd:targetNamespace attribute. Every UBL-defined-or -used major version schema set MUST have its own unique namespace. UBL namespaces MUST only contain UBL developed schema modules. The namespace names for UBL Schemas holding committee draft status MUST be of the form: The namespace names for UBL Schemas holding OASIS Standard status MUST be of the form:urn:oasis:names:specification:ubl:schema:<subtype>:<document-id> UBL published namespaces MUST never be changed. The ubl:CommonAggregateComponents schema module MUST reside in its own namespace. The ubl:CommonAggregateComponents schema module namespace MUST be represented by the namespace prefix “cac” when referenced in other schemas. The ubl:CommonBasicComponents schema module MUST reside in its own namespace. The UBL:CommonBasicComponents schema module namespace MUST be represented by the namespace prefix “cbc” when referenced in other schemas. The ccts:UnqualifiedDatatypes schema module namespace MUST be represented by the token “udt” when referenced in other schemas. The ubl:QualifiedDatatypes schema module MUST reside in its own namespace. The ubl:QualifiedDatatypes schema module namespace MUST be represented by the namespace prefix “qdt” when referenced in other schemas. The CommonExtensionComponent schema module namespace MUST be represented by the namespace prefix 'ext' when referenced in other schemas. [VER] Versioning Rules Every UBL Schema and schema module major version committee draft MUST have an RFC 3121 document-id of the form Every UBL Schema and schema module major version committee draft MUST capture its version number in the xsd:version attribute of the xsd:schema element in the form Every UBL Schema and schema module major version OASIS Standard MUST have an RFC 3121 document-id of the form Every UBL Schema and schema module major version OASIS Standard MUST capture its version number in the xsd:version attribute of the xsd:schema element in the form Every minor version release of a UBL schema or schema module draft MUST have an RFC 3121 document-id of the form Every minor version release of a UBL schema or schema module draft MUST capture its version information in the xsd:version attribute in the form Every minor version release of a UBL schema or schema module OASIS Standard MUST have an RFC 3121 document-id of the form Every minor version release of a UBL schema or schema module OASIS Standard MUST capture its version information in the xsd:version attribute in the form For UBL Minor version changes the namespace name MUST not change, Every UBL Schema and schema module major version number MUST be a sequentially assigned, incremental number greater than zero. Every UBL Schema and schema module minor version number MUST be a sequentially assigned, incremental non-negative integer. Every UBL document schema MUST include a required element named "UBLVersionID" as the first child of its root element. This element MUST have a default value that matches the value of the xsd:version attribute of its containing schema. A UBL minor version document schema MUST import its immediately preceding version document schema. UBL Schema and schema module minor version changes MUST be limited to the use of xsd:extension or xsd:restriction to alter existing types or add new constructs. UBL Schema and schema module minor version changes MUST not break semantic compatibility with prior versions. [SSM] Schema Structure Modularity Rules UBL Schema expressions MAY be split into multiple schema modules. A document schema in one UBL namespace that is dependent upon type definitions or element declarations defined in another namespace MUST only import the document schema from that namespace. A document schema in one UBL namespace that is dependant upon type definitions or element declarations defined in another namespace MUST NOT import internal schema modules from that namespace. Imported schema modules MUST be fully conformant with UBL naming and design rules. UBL schema modules MUST either be treated as external schema modules or as internal schema modules of the document schema. All UBL internal schema modules MUST be in the same namespace as their corresponding document schema. Each UBL internal schema module MUST be named {ParentSchemaModuleName}{InternalSchemaModuleFunction}{schema module} A UBL schema module MAY be created for reusable components. The UBL extensions schema module MUST be identified as CommonExtensionComponents in the document name within the schema header. A schema module defining all UBL Common Aggregate Components MUST be created. The UBL Common Aggregate Components schema module MUST be identified as CommonAggregateComponents in the document name within the schema header. A schema module defining all UBLCommon Basic Components MUST be created. The UBL Common Basic Components schema module MUST be identified as CommonBasicComponents in the document name within the schema header. A schema module defining all UBL Qualified Datatypes MUST be created. The UBL Qualified Datatypes schema module MUST import the ccts:UnQualifiedDatatypes schema module. The UBL Qualified Datatypes schema module MUST be identified as QualifiedDatatypes in the document name in the schema header. [DOC] Documentation Rules The xsd:documentation element for every Datatype MUST contain a structured set of annotations in the following sequence and pattern (as defined in CCTS Section 7): A Datatype definition MAY contain one or more Content Component Restrictions to provide additional information on the relationship between the Datatype and its corresponding Core Component Type. If used the Content Component Restrictions must contain a structured set of annotations in the following patterns: A Datatype definition MAY contain one or more Supplementary Component Restrictions to provide additional information on the relationship between the Datatype and its corresponding Core Component Type. If used the Supplementary Component Restrictions must contain a structured set of annotations in the following patterns: The xsd:documentation element for every Basic Business Information Entity MUST contain a structured set of annotations in the following patterns: The xsd:documentation element for every Aggregate Business Information Entity MUST contain a structured set of annotations in the following sequence and pattern: The xsd:documentation element for every Association Business Information Entity element declaration MUST contain a structured set of annotations in the following sequence and pattern: The xsd:documentation element for every Supplementary Component attribute declarationMUST contain a structured set of annotations in the following sequence and pattern: The xsd:documentation element for every Supplementary Component attribute declaration containing restrictions MUST include the following additional information appended to the information required by DOC8: [GNR] General Naming Rules UBL XML element and type names MUST be in the English language, using the primary English spellings provided in the Oxford English Dictionary. UBL XML element and type names MUST be consistently derived from CCTS conformant dictionary entry names. UBL XML element and type names constructed from ccts:DictionaryEntryNames MUST NOT include periods, spaces, other separators, or characters not allowed by W3C XML 1.0 for XML names. UBL XML element, and simple and complex type names MUST NOT use acronyms, abbreviations, or other word truncations, except those in the list of exceptions published in Appendix B. Acronyms and abbreviations MUST only be added to the UBL approved acronym and abbreviation list after careful consideration for maximum understanding and reuse. The acronyms and abbreviations listed in Appendix B MUST always be used in place of the word or phrase they represent. UBL XML element, and type names MUST be in singular form unless the concept itself is plural. Acronyms and abbreviations at the beginning of an attribute name MUST appear in all lower case. All other acronym and abbreviation usage in an attribute declaration MUST appear in upper case. Acronyms and abbreviations MUST appear in all upper case for all element declarations and type definitions. The UpperCamelCase (UCC) convention MUST be used for naming elements and types.Example: [CTN] ComplexType Naming Rules A UBL xsd:complexType name based on an ccts:AggregateBusinessInformationEntity MUST be the ccts:DictionaryEntryName with the separators removed and with the “Details” suffix replaced with “Type”. A UBL xsd:complexType name based on a ccts:BasicBusinessInformationEntityProperty MUST be the ccts:DictionaryEntryName shared property term and its qualifiers and representation term of the ccts:BasicBusinessInformationEntity, with the separators removed and with the “Type” suffix appended after the representation term. <!--===== Basic Business Information Entity Type Definitions ===== --> <xsd:complexType name="ChargeIndicatorType"> ... </xsd:comlextType> A UBL xsd:complexType name based on a ccts:BasicBusinessInformationEntityProperty and with a . ccts:BasicBusinessInformationEntityRepresentationTerm of 'Text' MUST have the word "Text" removed from the end of its name. A UBL xsd:complexType name based on a ccts:BasicBusinessInformationEntityProperty and with a . ccts:BasicBusinessInformationEntityRepresentationTerm of 'Identifier' MUST have the word "Identifier" replaced by the word "ID" at the end of its name. A UBL xsd:complexType name based on a ccts:BasicBusinessInformationEntityProperty MUST remove all duplication of words that occur as a result of duplicate property terms and representation terms. [ELN] Element Naming Rules A UBL global element name based on a ccts:ABIE MUST be the same as the name of the corresponding xsd:complexType to which it is bound, with the word “Type” removed. <xsd:element name="Party" type="PartyType"/> <xsd:complexType name="PartyType"> <xsd:annotation> —!--Documentation goes here--> </xsd:annotation> <xsd:sequence> <xsd:element ref="cbc:MarkCareIndicator" minOccurs="0" maxOccurs="1"> ... </xsd:element> <xsd:element ref="cbc:MarkAttentionIndicator" minOccurs="0" maxOccurs="1"> ... </xsd:element> <xsd:element ref="PartyIdentification" minOccurs="0" maxOccurs="unbounded"> ... </xsd:element> <xsd:element ref="PartyName" minOccurs="0" maxOccurs="1"> ... </xsd:element> <xsd:element ref="Address" minOccurs="0" maxOccurs="1"> ... </xsd:element> ... </xsd:sequence> A UBL global element name based on a ccts:BBIEProperty MUST be the same as the name of the corresponding xsd:complexType to which it is bound, with the word “Type” removed. <!--===== Basic Business Information Entity Type Definitions =====--> <xsd:complexType name="ChargeIndicatorType"> ... </xsd:comlextType> ... <!--===== Basic Business Information Entity Property Element Declarations =====--> <xsd:element name="ChargeIndicator" type="ChargeIndicatorType"/> A UBL global element name based on a ccts:ASBIE MUST be the ccts:ASBIE dictionary entry name property term and its qualifiers; and the object class term and qualifiers of its associated ccts:ABIE. All ccts:DictionaryEntryName separators MUST be removed.. [GTD] All types MUST be named. <xsd:complexType name="QuantityType">... </xsd:complexType> The xsd:anyType MUST NOT be used. [CTD] ComplexType Definition Rules For every class and property identified in the UBL model, a named xsd:complexType MUST be defined. <xsd:complexType name="BuildingNameType"> </xsd:complexType> For every ccts:BBIEProperty identified in the UBL model a named xsd:complexType must be defined. Every ccts:ABIE xsd:complexType definition content model MUST use the xsd:sequence element containing references to the appropriate global element declarations. <xsd:complexType name=”AddressType”> ... <xsd:sequence> <xsd:element ref=”cbc:CityName” minOccurs=”0” maxOccurs=”1”> ... </xsd:element> <xsd:element ref=”cbc:PostalZone” minOccurs=”0” maxOccurs=”1”> ... </xsd:element>... </xsd:sequence> </xsd:complexType> Every ccts:BBIEProperty xsd:complexType definition content model MUST use the xsd:simpleContent element. Every ccts:BBIEProperty xsd:complexType content model xsd:simpleContent element MUST consist of an xsd:extension element. Every ccts:BBIEProperty xsd:complexType content model xsd:base attribute value MUST be the UN/CEFACT Unqualified Datatype or UBL Qualified Datatype as appropriate. <xsd:complexType name="StreetNameType”> <xsd:simpleContent> <xsd:extension base=”udt:NameType”/> </xsd:simpleContent> </xsd:complexType> For every Qualified Datatype used in the UBL model, a named xsd:complexType or xsd:simpleType MUST be defined. A ccts:QualifiedDataType MUST be based on an unqualified data type and add some semantic and/or technical restriction to the unqualified data type. The name of a ccts:QualifiedDataType MUST be the name of its base ccts:UnqualifiedDataType with separators and spaces removed and with its qualifier term added. Every qualified datatype based on an unqualified datatype xsd:complexType whose supplementary components map directly to the properties of an XSD built-in data type Every qualified datatype based on an unqualified datatype xsd:complexType whose supplementary components do not map directly to the properties of an XSD built-in data type Every qualified datatype based on an unqualified datatype xsd:simpleType UBL has adopted UN/CEFACT's Core Component Type schema module.