Roadmap to an IEPD
description
Transcript of Roadmap to an IEPD
11
Roadmap to an IEPD
What do developers need to do?
22
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
33
IEPD Base Components
XML Schema
2
1
3
4
Documentation(Project business details (MS Word), NIEM cross-reference Spreadsheet)
XML artifacts (wantlist.xml, subset schema. Optional - extension, restriction and reference schemas )
Examples & Test Cases(Realistic test XML instance(s) for exchange interoperability testing )
Required items
Exchange Schema XSD (aligns to information model, NIEM core plus domain dictionaryand ICE NDR principles)
44
• 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
Technical Goals
55
Top Down or Bottom Up?
Component Tasks Timings Constraints
Collect exchange needs
Perform XSD schema development with NIEM alignment
Documentation of each element
Document NIEM element alignment (want list)
Create test cases and examples
Perform interoperability testing
Create IEPD document
Model information needs
XSD syntax writing
HTML report formats
Excel spreadsheetWantlist.xml
Sets of XML instances
Build test environments
Word documentation
Days
Hours
Minutes
Minutes
Hours
Hours
Days
Assisted analysis
Reduce need to know detailed schema syntax.
Automatic generation
Automatic generation
Automatic with content hintingTest harnesses consistent
Manual preparation
When requirements change – Regenerate Automatically!
66
Status Today
RoadmapItem
Capability Status Schedule Comments
1
2
3
4
5
6
7
8
Definitions Repository – NIEM dictionary, domain dictionary, import of ERwin EDM XSD
CAM toolkit – bottom up designer and pick list
Top down designer from dictionary components
Generate IEPD artifacts
Principles and NDR evaluation tool
Localized exchange schema generation
Realistic test case generation and xml validator
Batch unit test harness
Integration to test harness via web services
Business process integration
1st release
Available
In progress
Available
1st release
Available
Available
Planned
Planned
Planned
Q3/2009
Q4/2009
Q1/2010
Q1/2010
Base capabilities developed
Suite of tools available
Visual structure editor
Enhancements planned
Enhancements planned
Generator writes XSD automatically
Extend and develop current manual tools
As project priorities determine actual needs
As project priorities determine actual needs
77
Tools and XML Technologies
How do these tools all play together?
88
NIEM Exchange Schema
Exchange xmlExchange xml
*Code list xsd
Namespace* Optional
XML Schema
xsd subsetxsd subset*Constraint xsd*Constraint xsd
*Extension xsd*Extension xsd
*Restriction xsd*Restriction xsd
*Reference xsd*Reference xsdNIEM domain
schemas
Code list xsd
Wantlist xmlWantlist xml
LEGEND:
Exchange XSDExchange XSD
22
11
33
99
Approach in a Nutshell
INGESTINGEST
Structure
Rules
Documentation
XSLT toolsprocess
entire XSDcollection
XSLT toolsprocess
entire XSDcollection
CAM = Content Assembly Mechanism
XSD Collection
Re-factor to CAM abstraction format
CAM Template
*Code list xsd
Namespace* OptionalXML Schema
xsd subsetxsd subset *Constraint xsd*Constraint xsd
*Extension xsd*Extension xsd
*Restriction xsd*Restriction xsd
NIEM domainschemas
Code list xsd
LEGEND:
Exchange xsd
Exchange xsd
1010
IEPD development
PROCESSPROCESS
Toolkit for IEPD base
components generation
Toolkit for IEPD base
components generation
Suite of menu options and tools in CAM toolkit editor(run custom xslt scripts on CAM template xml)
Structure
Rules
Documentation
CAM Template
1. Run template evaluation report
2. Compare to NIEM dictionary
- create wantlist.xml
- create spreadsheet
3. Generate business rules report
4. Generate XML instance(s)
22
11
33
44
1111
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
11
22
33
44
1212
Reference Materials
Illustrative ExamplesReferences and Contacts
1313
NDR evaluation example
Part of an example report for LEXS getDataItemRequest template displayed in toolkit HTML viewer
1414
NIEM cross-reference spreadsheet
Formatted view in Microsoft Excel of import of cross-reference report details (from generated XML file)
1515
NIEM online SSGT and wantlist.xml
Options menu and Load Wantlist option with resulting load of subset details
1616
Business Rules Documentation
Part of the example rules for LEXS getDataItemRequest template displayed in toolkit HTML viewer
1717
XML example generation wizard
View of CAM toolkit with LEXS getDataItemRequest and dialogue for XML test example generator tool
1818
• Phil [email protected]
• Mini [email protected]
• David [email protected]
• Ken [email protected]
Points of Contact
1919
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