Skip to content

This repository holds a simple IEPD template that can be forked to a new repository that a user can leverage as the starting point for his/her own IEPD (based on the template). The template conforms to the new NIEM Model Package Description (MPD) 3.0 specification.

master
Go to file
Code

Latest commit

 

Git stats

Files

Permalink
Failed to load latest commit information.
Type
Name
Latest commit message
Commit time
 
 
 
 
 
 
 
 

README.md

Template IEPD

Build Status

This is a template IEPD for NIEM 4.0. It is designed to be a starting point for IEPD creators.

IEPDs built from this template should follow the NIEM-MPD 3.0.1 specification

The NIEM-MPD specification defines the contents and structure of IEPDs including metadata, XML Schema documents, and documentation.

Example IEPDs and supporting artifacts are available for further reference.

This template IEPD contains

  1. NIEM schema subset

    • NIEM subset schemas contain user-selected components from a NIEM release.
    • Use the NIEM Schema Subset Generation Tool (SSGT) to create a subset for an IEPD based on local requirements.
    • The NIEM subset should also include the wantlist.xml file generated by the SSGT so that the subset may be easily reloaded and updated for a future version of the IEPD.
  2. NIEM extension schema

    • IEPD extension schemas define the components that are needed for an exchange that are not found in NIEM.
    • A NIEM 4.x extension schema must contain a conformance target identifier in the schema declaration as follows: ct:conformanceTargets="http://reference.niem.gov/niem/specification/naming-and-design-rules/4.0/#ExtensionSchemaDocument"
  3. Catalog file

    • A MPD catalog defines metadata for an IEPD. It includes basic information about the IEPD itself, including point of contact information, and information about the artifacts in the package.
    • See Appendix B of the MPD Specification for an example.
    • See mpd-catalog-3.0.xsd for the XML Schema that defines this file.
  4. README

    • A ReadMe file is documentation that should describe an IEPD, including such information as its purpose, scope, business value, exchange information, typical senders and receivers, and the artifacts in the IEPD.
  5. Change Log

    • A change log describes the changes applied to an IEPD since its previous version.
    • For the initial version of an IEPD, the change log may simply contain the release date.
  6. Conformance Assertion

    • A conformance assertion should include information such as if the IEPD is NIEM conformant, list any known issues or exceptions, and describe what tools or processes were used to determine conformance.
    • Required checks to assert NIEM conformance:
      • Check that IEPD extension schemas (XML only) are conformant to the automated NIEM Naming and Design Rules (NDR) using the Conformance Testing Assistant (ConTesA).
        • ConTesA will produce a conformance report that can be included with the IEPD. The results can be referenced by the conformance assertion.
        • Note that all IEPD extension schemas must have a conformance target identifier, as specified above, in order for ConTesA to work.
      • Check that the IEPD package itself is conformant to the MPD Specification. This is a manual process, but Appendix E in the MPD specification provides a basic checklist of best practices.
    • See Appendix D of the MPD Specification for an example of a conformance assertion.

About

This repository holds a simple IEPD template that can be forked to a new repository that a user can leverage as the starting point for his/her own IEPD (based on the template). The template conforms to the new NIEM Model Package Description (MPD) 3.0 specification.

Resources

You can’t perform that action at this time.