7 General XML Schema Definition Language Conventions
8.3 Business Information Entity XML Schema Files
8.3.4 Element Declarations and References1924
8.3.4.3 ASBIE Element Declarations1968
For ASBIEs whose ccts:AggregationKind value is composite, a local element 1969
for the associated ABIE will be declared in the content model of the associating ABIE 1970
xsd:complexType. 1971
[R 9025]
For every ASBIE whose ccts:AggregationKind value = composite, a local element for the associated ABIE MUST be declared in the associating ABIE xsd:complexType content model.
1
For each ASBIE whose ccts:AggregationKind value is shared, a global 1972
element is declared. See section5.5 Reusability Schema.
1973
[R 9241] For every ASBIE whose ccts:AggregationKind value =
shared, a global element MUST be declared. 1 The name of the ASBIE local or global element will reflect the name of the ASBIE, 1974
devoid of the associating ABIE object class term and object class qualifier term(s).
1975
[R A08A]
Each ASBIE element name MUST be the ASBIE property term and qualifier term(s), and the object class term and qualifier term(s) of the associated ABIE.
1
The ASBIE local or global element will be of the xsd:complexType of the 1976
associated ABIE.
1977
[R B27C] Each ASBIE element declaration MUST use the
xsd:complexType that represents its associated ABIE. 1 Example 8-13 shows an ABIE type definition with a local element declaration for a 1978
BBIE Invoice. Identification. Identifier, a local element declaration for 1979
two AggregationKind value = compsite ASBIEs Invoice. Seller. Party 1980
and “Invoice. Buyer. Party, and a global element reference for the 1981
AggregationKind value = shared ASBIE of Invoice. Trade. LineItem.
1982
Example 8-13: ASBIE element declaration and reference within an ABIE type definition 1983
<xsd:element name=”InvoiceTradeLineItem” type=”InvoiceTradeLineItemType”/>
1984
<xsd:complexType name="InvoiceType">
1985
<xsd:sequence>
1986
<xsd:element name="ID" type="IDType"/>
1987
<xsd:element name="SellerParty" type="ordman:SellerPartyType"/>
1988
<xsd:element name="BuyerParty" type="ordman:BuyerPartyType"/>
1989
<xsd:element ref="ordman:InvoiceTradeLineItem"
1990
maxOccurs="unbounded"/>
1991
</xsd:sequence>
1992 1993
8.3.5 Annotation 1994
8.3.5.1 ABIE 1995
8.3.5.1.1 ABIE Complex Type 1996
8.3.5.1.1.1 Annotation Documentation 1997
Every ABIE xsd:complexType definition must include structured annotation 1998
documentation.
1999
[R ACB9]
For every ABIE xsd:complexType definition a structured set of xsd:annotation xsd:documentation elements MUST contain:
UniqueID (mandatory): The unique identifier that identifies an ABIE instance in a unique and unambiguous way.
VersionID (mandatory): An unique identifier that identifies the version of an ABIE.
DictionaryEntryName (mandatory): The Dictionary Entry Name (DEN) of the ABIE.
Definition (mandatory): The semantic meaning of the ABIE.
ObjectClassQualifierName (optional, repeating): Is a word or ordered words which help define and differeniate the associated ABIE from its CC. The order in which the qualifiers are expressed indicate the order to be used, where the first one is to be the first order qualifier.
ObjectClassTermName (mandatory): Is a semantically meaningful name of the object class of the ABIE.
BusinessTermName (optional, repeating): A synonym term in which the ABIE is commonly known.
1
Example 8-14 shows the annotation documentation of an ABIE complexType 2000
definition.
2001
Example 8-14: ABIE complex type definition annotation 2002
<xsd:complexType name="AccountType" >
2003
<xsd:annotation>
2004
<xsd:documentation xml:lang="en-US">
2005
<ccts:UniqueID>UNBE000000</ccts:UniqueID>
2006
<ccts:VersionID>0.00</ccts:VersionID>
2007
<ccts:DictionaryEntryName>Account</ccts:DictionaryEntryName>
2008
<ccts:Definition>Comminicates the Account information.</ccts:Definition>
2009
<ccts:ObjectClassTermName>Account</ccts:ObjectClassTermName>
2010
</xsd:documentation>
2011
<xsd:appInfo>
2012
As shown in Appendix F
2013
</xsd:appInfo>
2014
</xsd:annotation>
2015
</xsd:complexType>
2016 2017
8.3.5.1.1.2 Annotation Application Information 2018
Every ABIE xsd:complexType definition will have a structured set of 2019
xsd:annotation xsd:appInfo information that reflects its context and any 2020
defined usage rules.
2021
[R B0BA]
For every ABIE xsd:complexType definition a structured set of xsd:annotation xsd:appInfo elements MUST be present that fully declare its context.
1
[R BCE9]
For every ABIE usage rule, the ABIE xsd:complexType definition MUST contain a structured set of xsd:annotation xsd:appInfo elements in the following pattern:
ccts:UniqueID ccts:Constraint ccts:ConstraintType ccts:ConditionType.
1
8.3.5.1.2 ABIE Element 2022
8.3.5.1.2.1 Annotation Documentation 2023
Every ABIE element declaration must include structured annotation documentation.
2024
[R 88B6]
For every ABIE xsd:element declaration definition, a structured set of xsd:annotation xsd:documentation elements MUST contain:
UniqueID (mandatory): The unique identifier that identifies an ABIE instance in a unique and unambiguous way.
VersionID (mandatory): An unique identifier that identifies the version of an ABIE.
DictionaryEntryName (mandatory): The Dictionary Entry Name (DEN) of the ABIE.
Definition (mandatory): The semantic meaning of the ABIE.
ObjectClassQualifierName (optional, repeating): Is a word or ordered words which help define and differeniate the associated ABIE from its CC. The order in which the qualifiers are expressed indicate the order to be used, where the first one is to be the first order qualifier.
ObjectClassTermName (mandatory): Is a semantically meaningful name of the object class of the ABIE.
BusinessTermName (optional, repeating): A synonym term in which the ABIE is commonly known.
1
2025
8.3.5.1.2.2 Annotation Application Information 2026
The global element declaration for ABIEs is used exclusively for referencing by 2027
ASMAs. Since multiple ASMAs can reference a single global ABIE element 2028
declaration in different contexts with different usage rules, the context and usage 2029
rules for global ABIE element declarations can not be explicitly stated in the BIE XML 2030
Schema File. However, the context and usage rules are stated when the global ABIE 2031
element is referenced using xsd:ref as part of the content model of the MA.
2032
8.3.5.2 BBIE Element