11

CAM Toolkit for NIEM IEPD Development

Phil Letowt – DHS/ICEDavid Webber – ICE Data Architect

22

XML, XSD, WSDL

XML, XSD, WSDL

XSD

XSD

Wantlist

Wantlist

IEPD Development Overview

CAM toolkitCAM toolkit

ConTesAConTesA

SSGTSSGT

IEPD Repository

IEPD Repository

Conformance Tool

Conformance Tool

NIEM dictionary

NIEM dictionary

Microsoft ExcelMicrosoft Excel

Microsoft WordMicrosoft Word

Exchange XSDExchange XSD

IEPD PackageIEPD PackageTop Down

Bottom Up

ICE EDM dictionaryICE EDM

dictionary

33

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

44

Top Down Approach - Steps Overview

Expander Tool

Expander Tool

NIEM dictionaryNIEM dictionary

Domain dictionaryDomain dictionary

Component Definitions

44

Component Definitions

SSGTSSGT

ExcelExcel

Search

Tools

Search

Tools

22

ExchangeDesigner

ExchangeDesigner

11

Enter Optional

Item Type

Enter Optional

Item Type

33

Completed Exchange

Completed Exchange

55

4 steps in the process;leverages existing NIEM search tools

55

Vehicle Collision Report Example

NIEM Core

NIEM Core

Your nodenames outline

StructureDetails Inserted

RulesInserted

ICE EDMICE EDM

Lookups

Dictionaries

11 22

Expander Tool

Expander Tool

COMPLETED EXCHANGECOMPLETED EXCHANGETOP LEVEL DESIGNTOP LEVEL DESIGN

66

Top Down – Desktop Editor

Describe Structure

Load or Enter Rules

DomainComponents Namespaces

New Structure Items

Build New Exchange from NIEM pieces

77

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 spreadsheet

- create wantlist.xml

- NIEM online SSGT uploading + subset schema generation

Generate business rules report

3. Generate XML instance(s)

22

11

33

44

88

Naming and Design Rules (NDR) Evaluation

Part of an example evaluation for Vehicle Collision template displayed in toolkit HTML viewer

99

Export Template to Exchange XSD

Completed Exchange Structure

Set Exchange Options

Complete set of NIEM exchange schemas generated

Export Template to Exchange XSD:

1010

Exchange Schema Generated

Each namespace file is import for those specific type definitions

Reviewing XSD results in a schema editor tool

Set of XSD files with filename and namespace suffix

1111

NIEM cross-reference spreadsheet

Formatted view in Microsoft Excel of import of cross-reference report details (from generated XML file)

1212

NIEM online SSGT and wantlist.xml

Options menu and Load Wantlist option with resulting load of subset details

1313

Business Rules Documentation

Part of the example rules for LEXS getDataItemRequest template displayed in toolkit HTML viewer

1414

XML example generation wizard

View of CAM toolkit with LEXS getDataItemRequest and dialogue for XML test example generator tool

1515

Bottom Up ApproachBottom Up Approach

Leveraging existing Schemasuch as LEXS exchanges

1616

Bottom up 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

1717

Bottom Up – Refine Model

Add / Refine Structure, Rules,Documentation

Structure

Rules

Documentation

Existing LEXS exchange

1818

Export Template to Exchange XSD

Completed Exchange Structure

Set Exchange Options

Complete set of NIEM exchange schemas generated

Export Template to Exchange XSD:

1919

Reference MaterialsReference Materials

References and Contacts

2020

• Phil Letowtphilip.letowt@dhs.gov

• Mini Kanwalkanwalm@saic-dc.com

• David Webberdavid.webber@ionep.com

• Ken Sallsallk@saic-dc.com

Points of Contact

2121

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

• 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