7 General XML Schema Definition Language Conventions
8.4 Business Data Type XML Schema Files
8.4.6 BDT Annotations2487
8.4.6.1 Annotation Documentation 2488
8.4.6.1.1 BDT Types 2489
Every BDT element declaration and type definition must include structured 2490
annotation documentation.
2491
[R BFE5]
Every BDT XML Schema type definition MUST contain a structured set of xsd:annotation xsd:documentation elements that contain:
UniqueID (mandatory): The unique identifier that identifies the BDT in a unique and unambiguous way.
VersionID (mandatory): An unique identifier that identifies the version of the BDT.
DictionaryEntryName (mandatory): The Data Dictionary Entry Name (DEN) of the BDT.
Definition (mandatory): The semantic meaning of the BDT.
BusinessTermName (optional, repeating): A synonym term in which the BDT is commonly known.
DataTypeTermName (mandatory): The name of the DataType. The possible values for the DataType are defined in the Data Type Catalogue.
DataTypeQualifierTerm Name (optional, repeating): Is a word or words which help define and differentiate a Data Type. It further enhances the semantic meaning of the DataType. 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.
1
Example 8-27 shows the annotation documentation structure declaration for BDT.
2492 2493
Example 8-27: BDT annotation documentation definition 2494
<xsd:group name="BDTDocumentation">
2495
<xsd:sequence>
2496
<xsd:element name="UniqueID" type="EntityUniqueIDType_76U810"/>
2497
<xsd:element name="VersionID" type="VersionIDType_0192SK"/>
2498
<xsd:element name="DictionaryEntryName" type="NameType_4392S1"/>
2499
<xsd:element name="Definition" type="TextType_SDF657"/>
2500
<xsd:element name="BusinessTermName" type="NameType_43921S”
2501
minOccurs="0" maxOccurs="unbounded"/>
2502
<<xsd:element name="DataTypeTermName" type="NameType_43921S"/>
2503
Example 8-28 shows an example annotation documentation of a BDT.
2508
Example 8-28: BDT type definition annotation element 2509
... see type definition ...
2510
<xsd:annotation>
2511
<xsd:documentation xml:lang="en">
2512
<ccts:UniqueID>BDT000027</ccts:UniqueID>
2513
<ccts:VersionID>1.0</ccts:VersionID>
2514
<ccts:DictionaryEntryName>Loss_ Quantity. Type</ccts:DictionaryEntryName>
2515
<ccts:Definition>A loss quantity is a counted number of non-monetary
2516
units, possibly including fractions that represents the difference between te book
2517
quantity and the actual quantity</ccts:Definition>
2518
... see type definition ...
2523
8.4.6.1.1.1 BDT Type Content Component Business Value Domain 2524
Every BDT type declaration must include structured annotation documentation within 2525
the Content Component xsd:simpleContent element.
2526
[R 8095]
Every BDT xsd:simpleContent element MUST contain a structured set of ContentComponentValueDomain xsd:annotation
xsd:documentation elements that contain:
Definition (mandatory): The semantic meaning of the BDT.
DefaultIndicator (mandatory): Indicates if the primitive, scheme or list is the default BVD for the data type.
PrimitiveTypeName (optional): The primitive type of the BDT Content Component. One of PrimitiveTypeName, or
SchemeOrListID must be present.
SchemeOrListID (optional): The unique identifier assigned to the scheme or list that uniquely identifies it. One of PrimitiveTypeName or SchemeOrListID must be present.
SchemeOrListVersionID (optional): The version of the scheme or list. Must be present if SchemeOrListID is present.
SchemeOrListAgencyID (optional): The unique identifier assigned to the Agency that owns or is responsible for the
1
Scheme or Code List being referenced. Must be present if SchemeOrListID is present.
SchemeOrListModificationAllowedIndicator (optional):
Indicates whether the Identifier Scheme or Code List can be modified.
DefaultValue (optional): The default value for the BDT Content Component.
Example 8-29 shows the annotation documentation structure declaration for each 2527
BDT Content Component.
2528
Example 8-29: BDT Content Component BVD annotation documentation definition 2529
<xsd:group name="ContentComponentValueDomain">
2530
<xsd:sequence>
2531
<xsd:element name="Definition" type="TextType_SDF657"/>
2532
<xsd:element name="DefaultIndicator" type="IndicatorType_V5C6X7"/>
25332534
<xsd:element name=”PrimitiveTypeName” type=” NameType_43921S”
2535
minOccurs=”0”
2536
<xsd:element name="SchemeOrListID" type="IDType_LKI4DX"
2537
minOccurs="0"/>
2538
<xsd:element name="SchemeOrListVersionID" type="IDType_LKI4DX"
2539
minOccurs="0"/>
2540
<xsd:element name="SchemeOrListAgencyID" type="IDType_LKI4DX"
2541
<xsd:element name="DefaultValue" type="TextType_6589AZ"
2545
Example 8-30 shows an example annotation documentation of a BDT Content 2549
Component.
2550
Example 8-30: BDT Content Component annotation element 2551
... see type definition ...
2552
<xsd:annotation>
2553
<xsd:documentation>
2554
<ccts:ContentComponentValueDomain>
2555
<ccts:Definition>A number of monetary units</ccts:Definition>
2556
<ccts:DefaultIndicator>True</ccts:DefaultIndicator>
2557
<ccts:PrimitiveTypeName>Decimal</ccts:PrimitiveTypeName>
2558
</ccts:ContentComponentValueDomain>
2559
</xsd:documentation>
2560
</xsd:annotation>
2561
... see type definition ...
2562
8.4.6.1.2 BDT Type Supplementary Components 2563
Every BDT Supplementary Component attribute declaration must include structured 2564
annotation documentation.
2565
[R 9C95]
Every BDT Supplementary Component xsd:attribute
declaration MUST contain a structured set of xsd:annotation xsd:documentation elements that contain:
Cardinality (mandatory): Indicates the cardinality of the SC within the containing BDT.
DictionaryEntryName (mandatory): The Data Dictionary Entry Name (DEN) of the BDT SC.
Definition (mandatory): The semantic meaning of the BDT SC.
PropertyTermName (mandatory): Represents a distinguishing characteristic of the SC and shall occur naturally in the definition.
RepresentationTermName (mandatory): An element of the component name that describes the form in which the SC is represented.
DataTypeTermName (mandatory): The name of the
DataType Term. The possible values for the DataType Term are defined in the Data Type Catalogue.
DataTypeQualifierTermName (mandatory): A word or words which help define and differentiate a Data Type. It further enhances the semantic meaning of the DataType. 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.
1
Example 8-31 shows the annotation documentation definition for each BDT SC.
2566
Example 8-31: BDT SC annotation documentation definition 2567
<xsd:group name="BDTSCDocumentation">
2568
<xsd:sequence>
2569
<xsd:element name="Cardinality" type="OrdinalType_1241SS"/>
2570
<xsd:element name="DictionaryEntryName" type="NameType_43921S"/>
2571
<xsd:element name="Definition" type="TextType_SDF657"/>
2572
<xsd:element name="PropertyTermName" type="NameType_43921S"/>
2573
<xsd:element name="RepresentationTermName"
2574
type="NameType_43921S"/>
2575
<xsd:element name="DataTypeName" type="NameType_43921S"/>
2576
<xsd:element name="DataTypeQualifierTermName"
2577
type="NameType_43921S"/>
2578
</xsd:sequence>
2579
</xsd:group>
2580
8.4.6.1.2.1 BDT Type Supplementary Component Business Value Domain 2581
Every BDT Supplementary Component attribute declaration must also include within 2582
the structured annotation documentation a structure for the Supplementary 2583
Component BVD.
2584
[R 91C3]
Every Supplementary Component xsd:attribute declaration MUST contain within the structured set of xsd:annotation xsd:documentation elements a containing
SupplementaryComponentValueDomain element that contains:
DefaultIndicator (mandatory): Indicates if the primitive, scheme or list is the default BVD for the data type.
PrimitiveTypeName (optional): The primitive type of the BDT Supplementary Component. One of PrimitiveTypeName or SchemeOrListID must be present.
SchemeOrListID (optional): The unique identifier assigned to the scheme or list that uniquely identifies it. One of PrimitiveTypeName or SchemeOrListID must be present.
SchemeOrListVersionID (optional): The version of the scheme or list. Must be present if SchemeOrListID is present.
SchemeOrListAgencyID (optional): The unique identifier assigned to the Agency that owns or is responsible for the Scheme or Code List being referenced. Must be present if SchemeOrListID is present.
SchemeOrListModificationAllowedIndicator (optional):
Indicates whether the Identifier Scheme or Code List can be modified.
DefaultValue (optional): Is the default value.
1
Example 8-32 shows the annotation documentation definition for each BDT SC BVD 2585
and an example BDT SC annotation documentation.
2586
Example 8-32: BDT SC annotation documentation definition 2587
<xsd:complexType name="SupplementaryComponentValueDomainType">
2588
<xsd:sequence>
2589
<xsd:element name="DefaultIndicator" type="IndicatorType_V5C6X7"/>
2590
<xsd:element name="PrimitiveTypeName" type="NameType_43921S" "
2591
minOccurs="0"/>
2592
<xsd:element name="SchemeOrListID" type="IDType_LKI4DX" minOccurs="0"/>
2593
<xsd:element name="SchemeOrListVersionID" type="IDType_LKI4DZ"
2594
minOccurs="0"/>
2595
<xsd:element name="SchemeOrListAgencyID" type="IDType_LKI4DX "
2596
minOccurs="0"/>
2597
<xsd:element name="SchemeOrListModificationAllowedIndicator"
2598
type="IndicatorType_V5C6X7" minOccurs="0"/>
2599
<xsd:element name="DefaultValue" type="TextType_6589AZ" minOccurs="0"/>
2600
</xsd:sequence>
2601
</xsd:complexType>
2602
Example 8-33 shows an example BDT SC annotation documentation.
2603 2604
Example 8-33: BDT SC annotation documentation 2605
<xsd:attribute name="currencyCode"
2606
type="clm542173A20090305:ISO3AlphaCurrencyCodeContentType" use="optional">
2607
<xsd:annotation>
2608
<xsd:documentation xml:lang="en">
2609
<ccts:Cardinality>0..1</ccts:Cardinality>
2610
<ccts:DictionaryEntryName>Amount. Currency.
2611
Code</ccts:DictionaryEntryName>
2612
<ccts:Definition>The currency of the amount</ccts:Definition>
2613
<ccts:PropertyTermName>Currency</ccts:PropertyTermName>
2614
<ccts:RepresentationTermName>Code</ccts:RepresentationTermName>
2615
<ccts:DataTypeTermName>Amount</ccts:DataTypeTermName>
2616
<ccts:SupplementaryComponentValueDomain>
2617
<ccts:DefaultIndicator>True</ccts:DefaultIndicator>
2618
<ccts:SchemeOrListID>42173A</ccts:SchemeOrListID>
2619
<ccts:SchemeOrListVersionID>2009-03-05
2620
</ccts:SchemeOrListVersionID>
2621
<ccts:SchemeOrListAgencyID>5</ccts:SchemeOrListAgencyID>
2622
<ccts:SchemeOrListModificationAllowedIndicator>True
2623
</ccts:SchemeOrListModificationAllowedIndicator>
2624
</ccts:SupplementaryComponentValueDomain>
2625
</xsd:documentation>
2626
</xsd:annotation>
2627
</xsd:attribute>
2628
8.4.6.2 Annotation Application Information (AppInfo) 2629
The annotation xsd:appInfo is expressed for all BDT artefacts defined in BDT 2630
XML Schema Files. The UsageRules and the context is communicated as defined in 2631
section7.5.2, Application Information (AppInfo). All UsageRules and contexts in 2632
which the BDT is applicable is expressed in the xsd:appInfo.
2633