190 likes | 327 Views
Roadmap to an IEPD. What do developers need to do?. Agenda. IEPD Deliverables NIEM IEPD – Base Components Needed Top Down or Bottom Up? Tools and XML Technology How do these tools all play together? Dictionaries – NIEM / Domain Reference Materials Illustrative Examples
E N D
Roadmap to an IEPD What do developers need to do?
Agenda • IEPD Deliverables • NIEM IEPD – Base Components Needed • Top Down or Bottom Up? • Tools and XML Technology • How do these tools all play together? • Dictionaries – NIEM / Domain • Reference Materials • Illustrative Examples • Resources and Contacts
XML Schema IEPD Base Components 1 Exchange Schema XSD (aligns to information model, NIEM core plus domain dictionary and ICE NDR principles) Documentation (Project business details (MS Word), NIEM cross-reference Spreadsheet) 2 Required items XML artifacts (wantlist.xml, subset schema. Optional - extension, restriction and reference schemas ) 3 Examples & Test Cases (Realistic test XML instance(s) for exchange interoperability testing ) 4
Technical Goals • Schemas for data exchange • To produce “exchange schemas” which offer a high degree of clarity, interoperability and reusability while being agnostic to the actual deployment software tools. • Documentation for understanding business context and usage • Supporting XML Artifacts • Examples and test cases for verification • Cross-reference to NIEM dictionary to ensure consistency, interoperability and reuse within and across domains • Alignment to domain data model components dictionary – interoperability across domain applications • Consistency: conforms to domain naming and design rules principles
Top Down or Bottom Up? When requirements change – Regenerate Automatically!
Tools and XML Technologies How do these tools all play together?
XML Schema *Code list xsd Code list xsd NIEM domain schemas NIEM Exchange Schema 1 Exchange XSD 3 Exchange xml *Extension xsd 2 Wantlist xml *Constraint xsd xsd subset *Restriction xsd *Reference xsd LEGEND: * Optional Namespace
XML Schema *Code list xsd Code list xsd NIEM domain schemas xsd subset Exchange xsd LEGEND: * Optional CAM Template *Extension xsd *Constraint xsd *Restriction xsd Namespace Approach in a Nutshell Structure XSD Collection XSLT tools process entire XSD collection Rules INGEST Re-factor to CAM abstraction format Documentation CAM = Content Assembly Mechanism
Structure Rules CAM Template Documentation IEPD development Toolkit for IEPD base components generation • Run template evaluation report • Compare to NIEM dictionary - create wantlist.xml - create spreadsheet • Generate business rules report • Generate XML instance(s) 1 2 PROCESS Suite of menu options and tools in CAM toolkit editor (run custom xslt scripts on CAM template xml) 3 4
Leveraging SSGT • Generating IEPD base components • Exchange schema ingesting • Principles and Rules check evaluation report • Cross-reference to NIEM dictionary • Wantlist.xml generation • NIEM online SSGT uploading + subset schema generation • Excel spreadsheet of cross-reference • Business Rules documentation • Example XML instance 1 2 3 4
Reference Materials Illustrative Examples References and Contacts
NDR evaluation example Part of an example report for LEXS getDataItemRequest template displayed in toolkit HTML viewer
NIEM cross-reference spreadsheet Formatted view in Microsoft Excel of import of cross-reference report details (from generated XML file)
NIEM online SSGT and wantlist.xml Options menu and Load Wantlist option with resulting load of subset details
Business Rules Documentation Part of the example rules for LEXS getDataItemRequest template displayed in toolkit HTML viewer
XML example generation wizard View of CAM toolkit with LEXS getDataItemRequest and dialogue for XML test example generator tool
Points of Contact • Phil Letowt philip.letowt@dhs.gov • Mini Kanwal kanwalm@saic-dc.com • David Webber david.webber@ionep.com • Ken Sall sallk@saic-dc.com
Links and References • XML Schema Part 1: Structures and XML Schema Part 2: Datatypes (and Part 0: Primer) – We are using XML Schema version 1.0. • http://www.w3.org/XML/Schema#dev • NIEM Naming and Design Rules (NDR) 1.3 • http://www.niem.gov/pdf/NIEM-NDR-1-3.pdf • NIEM Practical Implementer’s Course (online) • http://www.niem.gov/elearning.php • NIEM Course Modules (17 free PDFs) • http://www.niem.gov/course.php • Techniques for Building and Extending NIEM XML Components • http://www.niem.gov/Techniques_for_Building_and_Extending_NIEM.pdf • NIEM 2.0 Conformant LEXS 3.1: Logical Entity eXchange Specifications • http://www.it.ojp.gov/default.aspx?area=implementationAssistance&page=1017&standard=486 • IEPD Preparation Guide – DRAFT (To be renamed CAM Toolkit User Guide for IEPD Development) • http://powerport.ice.dhs.gov/tapweb/documents/IEPD_Prep_Guide.pdf • CAM Toolkit download • https://sourceforge.net/projects/camprocessor