Skip to content

Latest commit

 

History

History
58 lines (35 loc) · 6.64 KB

README.md

File metadata and controls

58 lines (35 loc) · 6.64 KB
Raw

Template IEPD

This repo provides templates for different versions of NIEM IEPDs. This can be used as a starting point for IEPD developers.

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

Version View Download Use with Specification Comments
3.0 GitHub zip NIEM 3.0‑3.2 MPD v3.0.1 Initial version of the template.
4.0 GitHub zip NIEM 4.0-4.2 MPD v3.0.1 Minor changes. The MPD spec was not updated for NIEM 4.0. The MPD catalog and the NIEM subset were updated to use the NIEM 4.0 release.
5.0 GitHub zip NIEM 5.0-5.2 IEPD v5.0 The MPD specification was updated to focus specifically on IEPDs. IEPD catalog updated and additional content added. Created two kinds of messages (a query and a respond) in the template to demonstrate how an IEPD can represent multiple related exchanges in one package.

Template contents

  • NIEM subset schemas (info)

    • 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.

  • NIEM extension schema(s) (info)

    • IEPD extension schemas define the components that are needed for an exchange that are not found in NIEM.
    • NIEM schemas must declare a conformance target indicating which version and rule set of the NIEM Naming and Design Rules (NDR) are applicable. This informs conformance tools which set of NDR Schematron rules should be used for validation. See conformance targets for more.

  • MPD/IEPD Catalog file (info)

    • A MPD/IEPD catalog defines metadata for an IEPD. It includes basic information about the IEPD itself, including point of contact information, information about each message defined by the IEPD, and information about the artifacts in the package.

  • README (info)

    • 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.

  • Change Log (info)

    • 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.

  • Conformance Assertion (info)

    • 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.
    • Check that IEPD extension schemas (XML only) are conformant to the automated NIEM Naming and Design Rules (NDR) using the Conformance Testing Assistant (ConTesA). A report can be downloaded from the tool and included in the IEPD.
      • Note that ConTesA only checks NIEM conformance of XML schemas, not the entire IEPD itself.
      • Note that all IEPD extension schemas must have a conformance target identifier, as specified above, in order for ConTesA to work. Without it, ConTesA will not know which specific NDR rule set to use and no rules will be run.
    • Check that the full MPD / IEPD package is conformant to the MPD / IEPD Specification. This is a manual process, but Appendix E of the MPD Specification v3.0 or IEPD Specification v5.0 provide a basic checklist of best practices. A bigger IEPD checklist is also available to use for manual conformance reviews.

Other IEPD resources