Lightning-Fast IEPD Development Techniques

1. Lightning-Fast IEPD Development Techniques Presenter David RR Webber Information Architect Oracle Public Sector

2. The following is not intended to outline our general product direction. It is intended for information purposes only, and may not be incorporated into any contract. It is not a commitment to deliver any material, code, or functionality, and should not be relied upon in making purchasing decisions. The development, release, and timing of any features or functionality described for Oracle’s products remains at the sole discretion of Oracle.

3. Introduction • Effective NIEM IEPD development requires a complete process understanding and partnership between program management and application implementers. • This session provides a road map for executives and developers alike, based on the actual development experience of federal and state IEPDs and processes. • For executives, the session covers the latest techniques for leveraging domain dictionary assets and modeling tools to enable enterprise wide coordination. • For developers, the session illustrates lightning-fast IEPD development techniques and live prototyping using the latest version of the open source CAM toolkit for IEPD development. • Attendees will gain an understanding of how to maximize existing enterprise assets and processes to optimize the IEPD development process to ensure involvement and participation for all stakeholders, with successful outcomes as the goal.

4. Agenda • Part 1 • IEPD Process Mechanics • Aligning with SDLC (Software Development Life-Cycle) • Integrating NIEM into the Enterprise • Part 2 • CAM toolkit overview • Component Dictionaries • Patterns for building XML Exchanges • CAM IEPD Demonstration • Q & A Workshop – Testing & Delivery

5. IEPD Process Mechanics • Designing an XML exchange requires: • Understanding of the application data model • Business needs of the information exchange • Engineering efficient data exchanges with XML • To complete an IEPD needs: • Understanding of the NIEM Naming and Design Rules (NDR) • Building layout structures of XML exchange documents • Set of business rules for content and use patterns • Mapping to NIEM schema for component reuse • Working test case examples

6. Aligning to SDLC • Vital that NIEM IEPD development be integral part of SDLC – otherwise there will be duplicative work, retrofitting and refactoring • Initial IEPD reviews must be early in the process • Ideally the IEPD artifacts should be derived from the actual production XML exchange assets • Development team should work in tandem with architects and business analysts – not in isolation • Too often we hear “well we already have it in production so we can’t change it now”

7. Integrating NIEM into the Enterprise • Guidelines when to utilize NIEM domain dictionaries • Building EIEM – Enterprise Information Exchange Model • Canonical Components dictionary – NIEM consistent • Generate exchange artifacts for developers from EIEM • Aligning coding practices with XML to NIEM NDR • Developers and Data Architects synchronize components library and logical and physical models to EIEM constantly

8. Why do we need EIEM dictionaries? • Allows domains to manage their components libraries • Provides consistency for project development teams • Sets of NIEM consistent XML exchange components • Aligned to enterprise data stores • Optimized for reuse and interoperability • Save time and effort across the enterprise • Perennial question for developers – when should I use NIEM components, and when our own local ones? • Are there components already available for that purpose? • Provide formal mechanisms and procedures to share components and collaborate across SDLC process • Provide external parties consistent data views

9. How to create EIEM dictionaries • Top down - directly from information models • Enterprise modelling tools • SQL database physical table definitions • Bottom up • Harvesting from existing data assets • Harvesting from XML exchange structures and schema • Using neutral abstract standards based representations

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

11. 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 component items aspects: structure relationships; content rules; definitions

12. Example DHS/ICE EIEM Production Rules ERwin Refactoring, Compress, Renaming Tool NIEM NDR Evaluations ICE Enterprise Data Model (EDM) 1 3 2 OASIS CAM template Model Components XSD schema Apply Export Import Ele 5 Excel Spreadsheet Def 4 Code Lists Code Lists DDL Completed CAM template ERwin model Analyst Review ERwin Client • BENEFITS: • Will reduce ICE development time and effort • Pre-built NIEM consistent XML components • XML consistent with ICE enterprise SQL data • Removes scope for definition errors • Maximizes reuse potential across ICE • Open public standards based approach • Open technology infrastructure 7 XML + XSD 6 Canonical Dictionary of ICE exchange components Generate Standard Components Dictionary XML Write ebXML CCTS compatible (ABIE, BBIE, ASBIE)

13. CAM Renaming Tool • Expands abbreviations (has built-in lists with context) • Corrects common typos and spelling errors (200+) • Adjusts names to camel case with no separators (_) • Retains acronyms • Adds name suffix according to NIEM representation terms and type of content, e.g. date, number, code, etc • Optionally refactor rules by their type for interoperability; make nillable optional; relax DB length restrictions • Can optionally insert namespace prefix • Can be configured by editing the lists in: word-utils.xsl

14. Part 2 CAM Toolkit Overview CAM Templates Patterns for building XML Exchanges XML Exchange Life-Cycle CAMV validation engine / code lists / lookups CAM IEPD Demonstration

15. CAM Toolkit Overview • Open source, open public standards based, cross-platform deployment written using Java, SWT and XSLT • Project is sponsored by Oracle • NIEM-based features: • Evaluation tool for NDR and interoperability • Compare to dictionary, generates cross-reference, re-use score, and SSGT “want list” • Profiles for generating NIEM schema bundles • NIEM and LEXS dictionaries • Models export to ArgoUML, XMI or Mind maps

16. CAM Template CAM Templates Structure Rules WYSIWYG Documentation http://www.oasis-open.org/committees/cam

17. XML Schema Industry Domain schemas Code list xsd *Code list xsd xsd subset Exchange xsd LEGEND: * Optional CAM Template *Extension xsd *Constraint xsd *Restriction xsd Namespace CAM and W3C Schema Wizards Structure Exchange Schema XSLT tools process entire XSD collection XSD Collection Rules INGEST Documentation EXPORT

18. Component Definitions Component Definitions Visual Designer with Dictionary Collection Domain dictionary Industry dictionary 1 Exchange Designer 2 Search Tools Collection Drag n’ Drop Tool 3 Insert Dictionary Components 5 4 Completed Exchange Template

19. Configurable Dictionary Collections Namespace / Dictionary / Location Compiled Dictionaries CAM viewer compatible Dictionary Control File XML Referenced Compiler tool Referenced Dictionary Summary Format Excel spreadsheet compatible Loads collection into CAM viewer

20. Patterns for building XML exchanges • Adapting existing exchange XML schema • Tailoring document model to business needs • Insert new components, publish new IEPD • Restructuring and refactoring exchange structure • Flattening XML schema bundle for middleware tooling • Building new exchange schema • Using EIEM components • Blending EIEM with NIEM components • Custom community exchanges – e.g. OASIS

21. XML exchange life cycle Component Dictionary Drag and Drop Visual Editor Template Updates Design XML Samples Monitor Author Test CAM Template XSD Schema Deploy Production Log Results XMI / UML Models Documentation Compiled Templates

22. CAMV Validation Engine • Standalone XML validator using XPath rules • External code list and SQL table lookup support • Callable via Spring framework or Java API • Configurable error levels – error, warning, info • Context aware and declarative rules approach • Integrated with CAM editor menus for instant testing Workshop session

23. CAM Tutorial Website • NIEM IEPD online tutorial video • http://tutorial.cameditor.org

24. CAM IEPD Demonstration 30 Minutes • Import an existing XML exchange • Add new dictionary components via Drag and Drop • Apply the NIEM NDR evaluation – assess XML exchange quality • Compare to NIEM dictionary • produce reuse scores, cross-reference spreadsheet, wantlist (SSGT compatible) • Generate new NIEM compatible XSD schema collection • Adapt exchange use pattern to suit business needs, add data hints • Generate XML examples; validate them with CAMV engine • Document the Exchange; Generate Models 1 2 3 4 5 6 7 8

25. CAM Functions Demonstrated

26. What are we working on? • Improvements • Enhancing XML example generation with synthetic data • Aligning WSDL generation with SOA best practices • More business documentation reporting options • New features • SQL database lookup from CAMV and CAM editor • Dictionary integration with Domain Update Tool • Evaluation tools for dictionaries and components • Integration artifacts generation for SOA services

27. Q & A Download the CAM editor toolkit from: http://www.cameditor.org