1. 1 Quick Guide to CAM Dictionaries Building and using Canonical XML dictionaries for CAM (CAM – Content Assembly Mechanism Specification) Author: David RR Webber Chair OASIS CAM TC April, 2010 http://www.oasis-open.org/committees/cam

2. 2 January, 2010 – CAM Draft Specification Development Related Materials Agenda Why Dictionaries? Making interoperability baked into the XML infrastructure Linguistic and semantic alignment; neutral representations International and national initiatives Dictionary concepts What does the dictionary contain conceptually? Understanding the dictionary XML / use with spreadsheets Mapping across domains Generating Dictionaries Harvesting from existing sources | Using modelling tools | Manually Catalog of existing dictionaries Available dictionaries and domains More Dictionary tools

3. 3 January, 2010 – CAM Draft Specification Development Related Materials Why Dictionaries? Making interoperability baked into the XML infrastructure Linguistic and semantic alignment; neutral representations International and National initiatives

4. 4 January, 2010 – CAM Draft Specification Development Related Materials Baking in Interoperability Using consistent component definitions dramatically improves interoperability and reuse Having formal design methods makes development faster, easier, predictable and repeatable Aligning local practice to industry domain dictionary can reduce complexity and reinforce best practices Dictionary definitions can be automatically evaluated for common mistakes and this reduces the opportunity for errors during design phase Generating software artifacts from neutral dictionary definitions ensures reliable information exchange results across user communities and their particular systems, platforms and tools

5. 5 January, 2010 – CAM Draft Specification Development Related Materials Neutral Content Model Representation Neutral representations allow business stakeholders to participate in dictionary development without technology barriers Concise neutral formats can be viewed as simple spreadsheets as they have no special syntax dependencies Based on open public standard specifications, semantic concepts and leading knowledge domain techniques Neutral representation prevents lock-in by vendor, syntax, tooling or platforms Maximizes flexibility and future proofing of dictionary definitions

6. 6 January, 2010 – CAM Draft Specification Development Related Materials Linguistic and Semantic Alignment Formal community domain naming and design rules provide consistency of definitions Consistency of definitions minimizes duplication and overlapping of dictionary components Dictionaries allow collaboration on component development to improve the overall results Formal component content detail drives alignment Design best practices ensure logical self-contained components that can be selected contextually Avoids explosion of complexity and excessive over definition (e.g. “kitchen-sink” schema)

7. 7 January, 2010 – CAM Draft Specification Development Related Materials International and National Initiatives Sampling of prior dictionary related work ISO 11179 UN/CEFACT CCTS / ebXML OASIS Registry / Repository specifications USA national initiatives NIEM UK / EU examples e-GIF RIDE (Health interoperability) Industry work HL7 and NIST – Healthcare term registry Geospatial use of ebXML registry

8. 8 January, 2010 – CAM Draft Specification Development Related Materials Introduction to dictionary concepts What does the dictionary contain conceptually? How does the XML organize the information? How does this relate to Excel spreadsheets? Mapping to dictionary and between domains

9. 9 January, 2010 – CAM Draft Specification Development Related Materials Conceptual Information Model Child (BBIE) Item Child (BBIE) Item Parent (ABIE) Item Parent (ABIE) Item Follows Naming and Design Rule (NDR) principles and rules Canonical Components Dictionary XML Canonical Components Dictionary XML ebXML CCTS terms (ABIE, BBIE, ASBIE) Parent = Aggregate Business Information Entity Child = Basic Business Information Entity Attribute = Association Business Information Entity Parent (ABIE) Item Parent (ABIE) Item Parent (ABIE) Item Parent (ABIE) Item Parent (ABIE) Item Parent (ABIE) Item..... Child (BBIE) Item Child (BBIE) Item Child (BBIE) Item Child (BBIE) Item Child (BBIE) Item Child (BBIE) Item Attribute (ASBIE) Attribute (ASBIE) Attribute (ASBIE) Attribute (ASBIE) * CCTS – Core Components Technical Specification Attribute (ASBIE) Attribute (ASBIE) Attribute (ASBIE) Attribute (ASBIE) Each compound component Each atomic component Optional attributes of component

10. 10 January, 2010 – CAM Draft Specification Development Related Materials Example – Person Name Person Name (ABIE) Verified Details? (ASBIE) First Name (BBIE) Middle Name (BBIE) Last Name (BBIE) Previous Name? (ASBIE) Language Code (BBIE) Language Code may exist independently of Person Name Verified Details and Previous Name are flags that denote additional information about the entity they are associated with There are three components aspects represented: structure relationships; content rules; definitions

11. 11 January, 2010 – CAM Draft Specification Development Related Materials Conceptual Information View CAM toolkit processing Uses tools in desktop CAM toolkit editor CAM Template DOMAIN DATA COMPONENTS Structure Rules Definitions Items Item Properties Name Unique ID Component Type Cardinality Content Type Content Mask Children Group Structure Context Where from Definition Rules Language, Label, Notes * Required items in Blue DICTIONARY COMPONENTS

12. 12 January, 2010 – CAM Draft Specification Development Related Materials XML View of Dictionary Content Items Name Unique ID Component Type Cardinality Content Type Content Mask * See slide notes for explanation

13. 13 January, 2010 – CAM Draft Specification Development Related Materials Excel Spreadsheet View An item per row properties as columns

14. 14 January, 2010 – CAM Draft Specification Development Related Materials Mapping to Dictionaries You can compare a template of components to a dictionary check within a domain for alignment to dictionary check between domains for interoperability incrementally adding new components to dictionary Matches on physical names Reports matching items and details Reports statistics and percentages of matching Generates crosswalk xml file Compatible with Microsoft Excel Report can be used to do spell checking

15. 15 January, 2010 – CAM Draft Specification Development Related Materials Example cross-reference spreadsheet Formatted view in Microsoft Excel of import of cross- reference report details (from generated XML file) Matched details; item and alignment

16. 16 Generating Dictionaries Harvesting from existing sources Using modelling tools Manually from scratch Renaming tool

17. 17 Harvesting from Existing Sources Schema of exchange structures Physical database models

18. 18 Using Modelling Tools Existing logical data models Creating new data models

19. 19 Building Domain Dictionaries EDM Ele Def DDL 1 1 Export Components in XSD syntax Collection of objects from model Option 1 – From Enterprise Data Model Import XSD and refactor for use with OASIS CAM 2 2 Option 2 – Derive from existing exchange XSD schema Import each XSD and merge into CAM dictionary Exchange XSD schema CAM template OASIS CAM template Model Components XSD schema CAM template OASIS CAM template NDR Evaluation, Refactor, Renaming Tool NDR Evaluation, Refactor, Renaming Tool Apply Naming and Design Rule (NDR) checks and edits 4 4 NDR Evaluation, Refactor, Renaming Tool NDR Evaluation, Refactor, Renaming Tool 4 4 Generate Standard Components Dictionary XML Generate Standard Components Dictionary XML Merge & Generate Dictionary XML Merge & Generate Dictionary XML 5 5 5 5 Dictionary of exchange components XML Import Dictionary of exchange components 3 3 3 3 Automated Manual LEGEND Analyst Review ebXML CCTS compatible (ABIE, BBIE, ASBIE)

20. 20 From modelling tools Ingest Refactor Compress Add namespace Rename (progress) + re-open, save to CAM Evaluate Advanced – editing word-utils / preferences

21. 21 Creating from Scratch Outlining components in XML Editing spreadsheet

22. 22 Dictionaries Catalog Available dictionaries and domains

23. 23 Dictionary Tools Building Exchanges from Components Renaming tool

24. 24 Using Dictionaries & Blueprints Dictionaries provide reference sets of components to be used in exchanges; three possible sources: Dictionaries imported from existing industry schema Domain dictionary built from an Enterprise Data Model schema Reverse engineered out from existing exchange schema Blueprint Is the outline of the structure components to be used in an exchange schema Can import components from one or more domain dictionary collections Sketches out the desired information exchange with re-use of existing exchange component structures, plus any local additions / extensions / exclusions Expander tool reads the blueprint, references the dictionary, and constructs the complete exchange schema

25. 25 January, 2010 – CAM Draft Specification Development Related Materials Dictionary Development Tools Expander Tool Expander Tool Industry dictionary Domain dictionary Component Definitions 4 4 Web tool Excel Searc h Tools Searc h Tools 2 2 Blueprint Designer Blueprint Designer 1 1 Insert Dictionary Parent Components Insert Dictionary Parent Components 3 3 Completed Exchange Template Completed Exchange Template 5 5

26. 26 January, 2010 – CAM Draft Specification Development Related Materials Review Top Down development Reference dictionary components Create exchange blueprint Run Expander tool Refine desired structure in visual editor NDR Principles and Rules Best practices for interoperability and schema techniques Dictionary driven reuse Enterprise Data Model and industry components Ensures consistency of definition and use Automated exchange package generation Schemas, XML, documentation, mapping crosswalk Test generated example XML with rules validation

27. 27 Accelerated Process Overview Business Modelling Charter Work- Group Project Inception dictionaries Exchange Content Modelling Blueprints Dictionary Expand and Evaluate Results Web based Desktop Excel Search tools Review / Tailor Exchange Structures Generate Package Artifacts and Test them Generate Package Artifacts and Test them Package Exchange Complete d Exchange Structures NDR Evalu - ation Dictionary Generation Completed Exchange artifacts Test Cases Validation Engine XML examples XSD schemas Subset Schema Crosswalk Mapping Spreadsheet Rules Report Rendering Stylesheet Import XSD Naming / NDR / spell check Generate Dictionary Import EDM Test examples and rules Model Exchange Expand, Review, Refine CAM Enabled

28. 28 January, 2010 – CAM Draft Specification Development Related Materials Blueprint Approach Overview Def Ele Industry dictionaries formatted as XML Exchange generator tools (CAM) Automated Manual LEGEND Components Definition (XML) Local domain dictionary formatted as XML Build 5 5 2 2 Exchange Blueprint Designer User Interface Expand Structure Exchange Structure Pick Components Structure Outline Blueprint Target applications EDM Ele Def DDL Exchange Package Exchange Package Exchange Components Exchange Components 1 1 3 3 6 6 7 7 Enterprise Data Model Import and refactor for use with CAM Dictionary Repository 4 4

29. 29 January, 2010 – CAM Draft Specification Development Related Materials Generate Documentation and Schema Documentation: Create HTML report of exchange schema details and associated content and business rules Report layout and content designed to be reviewed by business analysts Schema: Generate XSD schema for exchange Customizable exchange folder layout management by namespace for extension, subset and exchange schema components Writes XSD schema in syntax that is clear, simple and compatible with deployment tooling environments

30. 30 January, 2010 – CAM Draft Specification Development Related Materials Summary Dictionary driven exchanges Blueprint enabled reuse Automated exchange package generation Alignment to NDR Principles and Rules Testing and validation support

31. 31 January, 2010 – CAM Draft Specification Development Related Materials Domain Exchange Development Steps Adopt formal Naming and Design Rules (NDR) UN/CEFACT – NDR OASIS UBL – Universal Business Language OASIS EML – Election Markup Language NIEM – National Information Exchange Model approach (http://www.niem.gov)http://www.niem.gov OASIS EM - Emergency Management joint initiative with NIEM Develop data models of core components for use in exchanges Build Dictionary of Core Components Provide Principles and Rules guidance to schema team Use namespaces, Yes / No? Camel case naming convention? Schema constructs and restrictions on use? Information Exchange Package Documentation (IEPD) Describes formal exchange that conforms to NDR and principles and rules Provides schema, example XML, supporting artifacts Re-uses core components Defines domain specific components

32. 32 January, 2010 – CAM Draft Specification Development Related Materials Example Governance Structure

33. 33 January, 2010 – CAM Draft Specification Development Related Materials OASIS Content Assembly Mechanism (CAM) & Integration Technologies Guide OASIS CAM Templates Ontology Classification Discovery Domain Dictionaries NDR W3C XSD Schema - WHAT? V Provides lexicon of information content V Describes structure constructs V Arranges groups of information V Simple content typing V Software tooling interfaces - HOW? WHY? V Provides actual use patterns (templates) V Supports context handling and rules V Rendering outputs and documentation for verification V Enables integration testing / certification V Versioning - WHO? V - Alignment of meaning and terms V - Consistent domain definitions V Modelling methods and practice V Business information content building blocks - WHERE? V Shared resources of semantic definitions V Code lists V Dynamic rendering V Distributed versioning control V Role and access security management - WHEN? V Alerts V Process control V Workflow V Automated interfacing V Business Intelligence Machine Based Reasoning Shared Semantics Registry - WHERE? V Domain classification systems V Ontology and reasoning definitions V Associations and linkages V Search and drilldown V Modelling tools

34. 34 Reference Materials References and Links

35. 35 January, 2010 – CAM Draft Specification Development Related Materials Links and Resources DOWNLOADS - CAM Toolkit download https://sourceforge.net/projects/camprocessor SUPPORTING MATERIALS - NIEM Naming and Design Rules (NDR) 1.3 http://www.niem.gov/pdf/NIEM-NDR-1-3.pdf RESOURCES – UN/CEFACT Core Components Technical Specification http://www.unece.org/cefact/ebxml/CCTS_V2- 01_Final.pdf http://www.unece.org/cefact/ebxml/CCTS_V2- 01_Final.pdf Additional support slides (following)

36. 36 January, 2010 – CAM Draft Specification Development Related Materials Blueprint Driven Approach Static Conventional Models, Artefacts, Code WSDL,XSD,UML,XML Analysis Design Coding Test Maintenance SW DEVELOPERS Specification Agile Dynamic Components TEMPLATES Adoption, integration Installation Implementation /Use Needs Requirements Procurement BUSINESS USERS Data models Excel spreadsheet Blueprint Templates XML visualization XML artifacts XSD schema Dynamic Software code Compilers Deployment servers XSD schema XML artifacts

37. 37 January, 2010 – CAM Draft Specification Development Related Materials Template Wizard runtime configuration Library Object templates/Components design time Facets Questions / Data Technology Targeting Syntax specific production rules Exchange Interface / Blueprints Visual editor + review / test / completion steps 1 1 3 3 4 4 XML 2 2 Domain Dictionary Details Stored XML Solution Specific Syntax 5 5