A Comparison of ebXML’s Naming Convention and the UDEF

1. A Comparison of ebXML’s Naming Convention and the UDEF

2. Topics • ebXML Core Components Overview • ebXML Naming Convention • Universal Data Element Framework (UDEF) Overview • UDEF Naming Convention • Proposed Approach for Merging UDEF into ebXML Naming Convention

3. Common Common Common Common ebXML Core Components Domain Retail Finance Health Transport Core

4. ebXML Discovery and Analysis Approach Domain 1 Domain 2 ... Domain N Discovery Processes / Components Discuss Harmonisation & Analysis All Processes /Components Agree Issues Domain Processes /Components Core Processes /Components Used or Extended Core Processes /Components Domain Specific Processes /Components Registry & Repository

5. Example Activity Diagram Buyer Seller Carrier start Send purchase Receive purchase order order ORDER N Fully Y Accept Order End Fulfil Reject Order Order Rejected Cancel Order Cancel Order End Y Propose Propose End Amendment Amendment Receive Amendment Activity diagram Prepare New Order Y New Order End End

6. Product Purchase Order amendment Pending Delivery Notice Receiver Seller Purchase Order Rejection Purchase Order Cancel Pending Delivery Notice Order Line Trade Agreement Price Buyer ID ID ID ID ID ID Product ID Quantity Line sequence number P.O. ID Delivery date P.O. date Buyer Receiver ID Date Description ID Date Description ID Example Class Diagram 0.* * * * * 1 1 1 1 * * 1 * * * * * * 1 1 1 1 * * 1 0.1 1 1 0.1 0.1 Class diagram

7. Example Use Case Diagram - Finance Initiate Payment Ordering Party Ordered Bank Initiate an Internal Transfer Initiate a Direct Interbank Payment Interbank System Determine that Benificiary Acct Beneficiary Bank can Receive Payment Credit Beneficiary Account Beneficiary Use Case diagram Advise Succesful Payment

8. Example Data Model in Finance (SWIFT)

9. Example ebXML Core Component Type Core Component Type (CCT) carries the actual value (e.g. 20011114) Consists of 1 Value Component gives extra definition to the value (e.g. Date) 1..n Supplementary Component • Code Type value component • code content • code list identifier • code list agency identifier • code list version identifier • code name • language code supplementary components

10. a singular concept that has a unique business semantic definition (e.g. street name) ebXML Basic Core Component Core Component Type (CCT) Consists of 1 Value Component 1..n Supplementary Component Used in Basic Core Component without business semantics with known business semantics

11. ebXML Aggregate Core Component Core Component Type (CCT) Consists of 1 Value Component 1..n Supplementary Component Used in Basic Core Component Aggregated in contains two or more Basic Core Components that together form a single business concept (e.g. postal address) without business semantics Aggregate Core Component with known business semantics

12. - Street.Building.Identifier • - Street.Name • - Town.Name • - State.Identifier • - Post-Code.Identifier • - Country.Code • - ........ Embedded Components Example Aggregate Core Component • Postal Address XML DTD specifies mandatory and optional embedded components

13. Interpreting DTDs Bravo contains a sequence of child elements which includes zero or one occurrence of Golf (?), zero or more occurrences of Hotel (*), and one or more occurrence of India (+). XML DTD source code: Note that Golf, Hotel, and India are each datatyped (string, date, and boolean respectively). The datatype is declared in each element’s “e-dtype” attribute. This method of datatyping was developed by Extensibility and is not part of the W3C XML 1.0 Recommendation. The newer W3C XML Schema language does support datatyping. The significance of this is that an XML Schema parser can check for datatyping errors whereas a DTD parser can not and datatype error checking is left to the using application. <!ELEMENT Bravo (Golf? , Hotel* , India+)> <!ELEMENT Golf (#PCDATA)> <!ATTLIST Golf e-dtype NMTOKEN #FIXED 'string' > <!ELEMENT Hotel (#PCDATA)> <!ATTLIST Hotel e-dtype NMTOKEN #FIXED 'date' > <!ELEMENT India (#PCDATA)> <!ATTLIST India e-dtype NMTOKEN #FIXED 'boolean' >

14. Interpreting DTDs - Continued The angle bracket indicates a choice, i.e., Juliet Must contain either Kilo, Lima, or Mike. Juliet also includes zero or more occurrences of either November, Oscar, or Papa. Kilo must include either Quebec, Romeo, or Sierra. November may include either Quebec, Romeo, or Sierra. 0:1 0:M

15. Example Address DTD – from EIA-836

16. The Business Information Entity (BIE) • Business Process • Product Classification • Industry Classification • Geopolitical • Official Constraints • Business Actor Role • Supporting Role • System Capabilities Core Components Context Categories Specific Business Context Constraints Relationships Identifying BIEs for Aerospace is the goal Business Information Entity Syntax Neutral Syntax Rules Syntax Bound X12 XML DTD XML Schema STEP

17. ebXML Representation Terms Representation Terms are tightly connected to Core Component Types Amount - always monetary Code - a character string used to replace a definitive value Date - a day within a particular calendar year (a type of date time) Date Time - a particular point in the progression of time Graphic - a diagram, graph, mathematical curve or similar representation Identifier - a character string used to identify and distinguish uniquely Indicator - a list of two and only possible values (synonym for Boolean) Measure - a numeric value determined by measuring an object (UoM) Name - a word or phrase that distinctively designates a person, place, etc. (a type of text) Percent - a rate expressed in hundredths between two values with same UoM (a type of numeric) Picture - a visual representation of a person, object, or scene Quantity - a number of non-monetary units - associated with objects (a type of numeric) Rate - a quantity or amount measured with respect to another quantity or amount (a type of numeric) Text - a character string generally in the form of words of a language Time – the time within a (not specified) day (a type of date time) Value – numeric information that is assigned or determined by calculation, counting, or sequencing (a type of numeric)

18. ebXML Context Categories Context Categories allow users to uniquely identify and distinguish between different business contexts. They use standard classifications (unless otherwise stated) to provide values for the category. Business Process – UN/CEFACT provides a catalog of core business processes Product Classification – Universal Standard Products and Services Classification (UNSPSC) – example provided in next slide Industry Classification – for example, UNSPSC top two levels define industry Geopolitical – general taxonomy follows (global, continent, economic region, country, region) - example country=United States, region=California Official Constraints – regulatory and legislative (such as customs) Business Actor Role – examples, buyer and seller Supporting Role – example, code for agency that specifies code values System Capabilities – no known standard classification of all types of IT systems and standards

19. ebXML Naming Convention Procedures • Develop Semantic Definition that is globally applicable, generic, simple and clear. • Follow Naming Rules to assign representation type, property term and object class - but a set of object classes are not specified. • Concatenate the Terms to create a Naming Convention compliant name – where it is recognized that the name may seem artificial. • Check Quality of Definition by placing the name plus “is” in front of the definition. • List Common Synonyms or Business Terms used with the domain • Assign a Temporary UID in the form of a six digit alphanumeric string

20. UNSPSC Example for Product Commodity Code XYZ supplier 11/02/99 Invoice #12345 34XB12 Laser printer lbls 1x2-/8 19.76 24509 Ink cartridge 99.99 725XN Data copier paper 22.99 CP340P Compaq Presario 1879.00 Sales tax 166.79 Total Invoice 2188.53 XYZ supplier1234-5436-3465 11/02/99 Invoice #12345 55.12.16.05.00 Laser printer lbls 1x2-/8 19.76 44.10.31.05.00 5009 Ink cartridge 99.99 14.11.15.06.00 Data copier paper 22.99 43.17.18.03.00 Compaq Presario 1879.00 93.16.16.05.00 Sales Tax 166.79 Total Invoice 2188.53 The SKU while meaningful to the supplier, has no analytical value for the buyer. Substituting the SKU for a standard commodity code (UNSPSC) provides the buyer with meaningful data which can be used to analyze and control expenditure.

21. UDEF Background CALS ISG - Developed UDEF Industry Ron Schuldt (Chair) - Lockheed Martin Barbara Barman (Vice Chair) - Raytheon Rob Bryant - DynCorp Ruey Chen - David Taylor Research Center Bob Hodges - Texas Instruments Neal McNamara - Analysis & Technology Inc. Bud Orlando - TRW Madelyn van der Bokke - ASEC George Walther - Lockheed Martin Government Norma Kornwebel - PM JCALS Dinah Beres - NAWC Steve Waterbury - NASA EIA - Applied UDEF Industry Ron Schuldt (Chair) - Lockheed Martin Rick Lang - Texas Instruments Pam Stanfield - Lockheed Martin Gary O’Hara - Hughes Space and Comm Tony DiPerna - Ericsson Communications Ken McTee - Texas Instruments Cindy Hauer - Mevatec Corp Fred Bahrs - CMstat Corporation Doug Drury - ITT Federal Services Lee LeClair - Texas Instruments Government Deborah Cornelius - US Army Missile Cmd C. H. VanLandingham - NOAA Nat’l Wea Svc

22. UDEF Context Categories = Object Classes Entity Enterprise B Enterprise A Place Laws/Rules Program Product Product Process Document Environment Human Asset Condition Resources

23. UDEF Naming Convention – Based on ISO 11179 Data Element Name Object Class List Entity Document Enterprise Place Program Product Process Person Asset Law/Rule Environment Condition Property List Amount Angle Area Code Coordinate Date Dimension Identifier Mass Name Quantity Rate Temperature Text Time Volume Weight Object Class Term 0...n qualifiers + 1 or more reqd Object Class Property Term 0..n qualifiers + 1 reqd Property + Example Data Element Names Document Abstract Text EnterpriseName Product Price Amount Product Scheduled Delivery Date Engineering Design Process Cost Amount

24. “Enterprise” Object Taxonomy Example ENTERPRISE (3) Remitter Receiver Supplier Exempt Academic Small Large w x y z aa ab ac Owned Owned Payment Inspection Tax a a a a a a Privately Publicly Privately Publicly a b a b

25. “Identifier” Property Taxonomy Example IDENTIFIER (8) Enterprise-unique Sequential 56 Division 47 Period Project-unique Access Logon 50 48 55 Authority 49 53 Globally-unique 51 54 Year Monitor Account Pager 1 1 52 Mail 4 Control Telephone 1 Julian 1 Machine Technical 3 1 2 1 Electronic Home Change 1 System-generated Office 2 Fax 1 1 1 1 Current Project-specific 1 1

26. “Name” Property Taxonomy Example NAME (10) Stage City Family Given File Division System Subsystem Department 9 10 11 12 13 14 15 16 17 Electronic 1

27. UDEF Naming Convention – Example Mappings CM Data Elements Universal ID document-publication-date document-data-rights-expiration-date document-sheet-total-quantity document-sheet-size-code software-product-version-identifier part-product-identifier reference-document-revision-identifier enterprise-division-address-text program-name product-quantity enterprise-address-text 2_5.6 2_1.2.6.6 2_1.8.11 2_1.6.4 p.9_8.8 g.9_8 aj.2_9.8 3_2.12.14 10_10 9_11 3_12.14

28. UDEF Naming Convention – Example Mappings X12 & EDIFACT Data Elements Universal ID country code invoice number- assigned by issuer purchase order type code postal code location qualifier location identifier contract effective date expiry date of import license item number - product item number - service price e.7_4 bd.2_1.35.8 d.t.2_33.4 7_1.10.4 7_20.33.4 7_8.4 e.2_13.6 a.be.2_6.6 9_8 f.9_8 9_2.1

29. UDEF ID = ebXML UID Vendor A EIA-836 X12 (EDI) g.9_8 Part Product Identifier Product/Service ID Part No g.9_9 Part Product Name Product/Service Name y.3_9 Supplier Entity (Supplier) Name Contract Document Identifier Buyer’s Contract Number Contract No e.2_8 Component Product Quantity f.g.9_11 2_33.4 Document Type Code Report Type Code Doc Type Goal - UDEF IDs Become the ebXML UIDs <PartProductIdentifier UID=“g.9_8”>123-456-789</PartProductIdentifier> <ProductServiceID UID=“g.9_8”>123-456-789</ProductServiceID> <PartNo UID=“g.9_8”>123-456-789</PartNo> Benefit – UIDs eliminate the baggage associated with changing names

30. ebXML and UDEF Naming Convention Procedures • Semantic Definition becomes optional in most cases since the UDEF compliant name conveys meaning unambiguously. • Follow Naming Rules to assign representation type, property term and object class – using a specified a set of object classes that correspond to and expand upon the ebXML context categories. • The UDEF naming convention rules follow the rules of proper English taught in grade school when diagramming sentences – specifically, each modifier word precedes the word being modified • Concatenate the Terms to create a Naming Convention compliant name – where it is recognized that the name may seem artificially long. • Check Quality of Definition by placing the name plus “is” in front of the definition. • List Common Synonyms or Business Terms used within the context of a given industry. • Derive an Intelligent UID based on the UDEF taxonomy that carries an inherited indexing scheme.

31. Proposed Approach for Merging ebXML and UDEF • If AIA EEWG concurs, adjust UDEF Property Words to be 100% consistent with ebXML Representation words – R. Schuldt • Distribute updated UDEF baseline (current baseline dated April 2000) to all members of the Metadata Harmonization Project – R. Schuldt • Each team member reviews the updated UDEF and the naming convention rules and tests it with sample data elements • Review/discuss results at January meeting.