NIEM Blue Team PresentationApril 20, 2010

Phil Letowt, Mini Kanwal, Ken Sall, David Webber

ICE OCIO / Task ASAS

ICE Information Exchange Reuse

with NIEM IEPD support

ICE OCIO TA Focus

1. Derive reuse value from Enterprise Data Model (EDM) in defining information exchanges with XML

2. Accelerate development of information exchanges in consistent, repeatable and reliable ways with supporting tooling

3. Leverage NIEM approach to enhance reuse and interoperability

4. Advance secure reliable information sharing and use across ICE

5. Reduce “on ramp” learning curve for ICE software developers

6. Align to enterprise development processes (SLM + NIEM IEPD)

7. Align to existing information exchange infrastructure assets to minimize technology issues, reduce maintenance costs

8. Provide open infrastructure based on XML that can integrate with other ICE technology assets

synthetic test data generation; integration to testing and regression test environments; open source tools for software development

Leveraging ICE EDM for XML

ICE Enterprise Data Model (EDM)

OASIS CAM

template

OASIS CAM

template

Model Components

XSD

schema

Model Components

XSD

schema

ERwin Refactoring,

Compress,

Renaming Tool

NIEM NDR Evaluations

ERwin Refactoring,

Compress,

Renaming Tool

NIEM NDR Evaluations

Generate

Standard

Components Dictionary

XML

Generate

Standard

Components Dictionary

XML

55

Canonical

Dictionary

of ICE exchange

components

XMLXML

33

Analyst Review

ebXML CCTS compatible

(ABIE, BBIE, ASBIE)

22

Export

EleEle

DefDef

DDLDDL

Import

Production Rules

44

11

Completed CAM

template

Completed CAM

template

Apply

Write

Excel Spreadsheet

66

77BENEFITS:

Reduces ICE development time and effort

Pre-built NIEM compatible 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

Code

Lists

Code

Lists

Code

Lists

Code

Lists

ERwin

Client

ERwin

Model

LEXS dictionaryLEXS dictionary

Insert

Dictionary

Parent

Components

Insert

Dictionary

Parent

Components

XMLXML

Accelerating Exchange Development

Expander

Tool

Expander

Tool

NIEM dictionaryNIEM dictionary

ICE domain dictionaryICE domain dictionary

Component Definitions

44

Component Definitions

Web toolsWeb tools

ExcelExcel

Search

Tools

Search

Tools

22

Blueprint

Designer

Blueprint

Designer

11

33

Completed Exchange

Template

Completed Exchange

Template

55

Canonical Dictionary of

ICE exchange components

Exchange Designer

BENEFITS:

Blueprints reduce learning curve

Library of blueprints enhances reuse

Eliminate need for hand writing of schema

Allow designers to focus on requirements

Includes business users in the review process

Consistent results avoiding common pitfalls

ERwin

Client

Discovery Tools

CAM Visual Editor Tool

Complete Process Overview

Business

ModellingCharter

Work-

Group

Project InceptionProject Inception

dictionariesdictionaries

Exchange Content ModellingExchange Content Modelling

Blueprints Dictionary

Dictionary

Expand and Evaluate ResultsExpand and Evaluate Results

Web

basedDesktop

Excel

Search tools

Review / Tailor Exchange

Structures

Review / Tailor Exchange

Structures

Generate Package Artifacts

and

Test them

Generate Package Artifacts

and

Test them

Package ExchangePackage Exchange

Completed

Exchange

Structures

NDR

Evalu-

ation

Dictionary Generation

Completed Exchange artifacts

Test Cases

Validation Engine

XML

examples

XSD

schemas

Subset

SchemaCrosswalk

Mapping

Spreadsheet

Rules

Report

Rendering

Stylesheet

Import XSD

Naming / NDR /

spell checkGenerate

Dictionary

Import EDM

Test examples and rules

Model Exchange

Expand, Review, Refine

11

22

33

44

55

66

77

BENEFITS:

Aligns to SLM

Automates NIEM IEPD deliverables

Integrates into software development

environments

Consistent predictable results

Tools for ICE IEPD Delivery

CAM Template

ICE EXCHANGE TEMPLATE

Structure

Rules

Documentation Suite of menu options and tools in

desktop CAM toolkit editor

(each run custom xslt scripts on the

exchange

CAM template xml)

Toolkit for IEPD

exchange artifacts

generation

Toolkit for IEPD

exchange artifacts

generation

1. Run template Evaluation Report

2. Compare to NIEM/ICE dictionary

- create mapping spreadsheet

- create reuse statistics report

- create NIEM SSGT “wantlist”

Generate exchange XSD schema

3. Generate business use report

4. Generate XML test instance(s)

22

11

33

44

55

ICE IEPD DELIVERABLES

Why ICE-Specific IEPD Documents?

Define a uniform approach to ICE IEPD development with clearly articulated expectations in terms of rules, artifacts, and evaluation criteria, as well as a review and governance process.

Combined with the (optional) use of the CAM Toolkit, lower the barrier for entry to IEPD development.

BENEFITS:

Simplifies NIEM roll-out and adoption across ICE

Aligns NIEM cores values and ICE requirements

Provides supporting documentation and user guides

Reduces learning curve and on-ramp

Teaches consistent predictable repeatable results

ICE-Specific IEPD Documents [1 of 3]

CAM Toolkit User Guide for IEPD Development Free, open source software custom developed to facilitate ICE IEPD

development. Use is optional but recommended since it can generate many of the

required IEPD artifacts. “Bottom Up” and new “Top Down” development approach.

Principles and Rules for ICE Exchange Schema Development A key input to the ICE IEPD evaluation process. For ICE IEPDs, these rules take precedence over the NIEM Naming

and Design Rules. About 33 rules in 10 categories

ICE-Specific IEPD Documents [3 of 3]

ICE IEPD Package Template ZIP file with IEPD artifact folder hierarchy and templates. Catalog.html, Metadata, ICE-specific README Main (Master) Document or SLM Interface Control Agreement Sample XML Instance, Cross-Reference Spreadsheet, etc.

ICE IEPD Review and Governance Process (IIRGP) Indicates how ICE IEPDs will be evaluated and perfected. Offers active assistance of the ICE OCIO Data Architecture team. Delineates process steps; explains roles and responsibilities. Includes list of recommended references and resources for IEPD

development.

BENEFITS:

Provides Quick Start Kit for implementation teams

Focuses on core deliverables for ICE

Allows early feedback and peer review to enhance results quality

Provides lessons learned and process improvement

ICE-Specific IEPD Documents [3 of 3]

ICE IEPD Evaluation Template Form that the OCIO Data Architecture team uses to review and

evaluate ICE IEPD submissions with specific criteria for documentation and XML Schemas.

Also contains IEPD Artifacts Assessment Worksheet.

BENEFITS:

Management reporting

Clear directive to teams

Formalizes process

Focuses on priorities

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 – Additional support slides (following)