Arrest Warrant Template Business requirements for IEPD

Document Sample
Arrest Warrant Template Business requirements for IEPD Powered By Docstoc
					Business requirements for IEPD template and specification

Reuse of IEPD within and across domains
  registration of IEPDs
  search, discovery, retrieval of IEPDs
  adapt or build new IEPDs from existing IEPDs
Facilitate the automation of IEPD creation, processing, and registration
  assist in building NIEM conformant IEPD artifacts per NDR
  IEPD contains artifacts that can easily be imported for processing by tools
Enhance the consistency and readability of IEPDs community wide
  human readable and for display purposes
  machine readable; parsable for automation of processing
Facilitate the interoperability and portability of IEPDs (see artifacts tab)
  complete, self-contained, self-documenting
  metadata is part of the IEPD itself
  open specifications in standard format(s)
  independent of specific tools, applications, or systems
IEPD captures business context associated with information exchanges
  metadata (see metadata tab) and metrics (see metrics tab)
  purpose, when to use, business requirements
  how to use, use case model, special procedures
  how developed, tools and methods used to build
  who developed, who is using it, MOUs between participating agencies
Facilitate IEPD life-cycle management
  identify and report impact to IEPDs as model changes
  notify stakeholders when new IEPDs or related are available
  identify and report cross-IEPD impacts (differences between IEPD versions) and validation
Identify and capture requirements for new content or modification to existing content
  replaces Component Mapping Tool (CMT) for established domains
  CMT becomes an artifact in an IEPD (see artifacts tab)
Support for capture and/or derivation of metrics
  what specific metrics? (see metrics tab)
  what metadata necessary for metrics? (see metadata tab)
  example: who is using an IEPD? How often?
IEPD certification and documentation guidelines
  Certification determined by IEPD development stage and available documentation
  Proposed levels:
      1 - entry level; under development; minimum documentation (see artifacts tab)
      2 - complete; being tested; in limited use; draft documentation
      3 - in production; fully documented; endorsed for use in official exchanges
  What specific IEPD documentation is required / optional for each Level?
  Required documentation will likely vary with IEPD life cycle and business context
  Might be necessary to develop a matrix to identify required documentation against life cycle
The IEPD Template does NOT support planned IEPD efforts (outside scope)
  does not preclude the registration or announcement of planned efforts at a registry
  only on-going developments with minimal artifacts, documentation, and metadata are in scope
Artifacts and metadata should be optional and overinclusive
  intent of the IEPD Template is to be optional and overinclusive (within reason)
  include all meaningful artifacts and metadata, but only a minimal set should be mandatory
  artifacts are NOT limited to those listed in artifacts tab; e.g. more documentation is always welcome
IEPD Artifacts

Master documentation:

   business requirements
   MOUs among participating agencies
   endorsement letters
   methodology used to build IEPD
   tool sets used to build IEPDs
   testing and conformance
   strategic implementation plan
   strategic governance plan
Domain model

Use case model

Business rules

Mapping (to NIEM components)

Extended components

Change log

Exchange Specifications (normative XML)
Subset schema
Exchange schema
Constraint schema
Extension schema
Sample XML instance
Sample style sheet

IEPD Specifications

             master documentation; package that may include purpose, business requirements, what, when, why,
             how to, etc.; some of these items may be explicit additions to metadata;
             itemized descriptions; may also contain business rules
             Memorandums of Understanding (agreements without lawyers)
             documentation from professional or governmental organizations that confirm support
             may contain URLs or references to methodology and/or documentation
             may contain URLs or references to tools and/or documentation
             description and results of validation and conformance testing performed on this IEPD

             defines who has control among partners and when
             domain model in standard usable format (xmi, vsd, zargo) and standard graphic (jpg, pdf, etc.);
             most likely a Unified Modeling Language (UML) model
             use case diagram; most likely UML

             general business rules;
             may be plain or structured English; may be written into master documentation;
             may be written in Schematron or other formal business rule language;
             mapping of domain components to NIEM components;
             tagged with constraints (i.e. cardinality, etc.)
             components created because they were not in NIEM;
             may be part of mapping spreadsheet;
             include structure and definitions of new components;
             record of cumulative changes from previous IEPD versions
             initial IEPD simply records its creation date

rmative XML)
           subset of the full NIEM schema; zipped directory of schemas (to distiguish from other schemas)
           subset requirements generated and used by Schema Subset Generator Tool (SSGT)
           base (xml root) document; AKA document schema, reference schema, root schema.
           constraints for separate constraint validation path; zipped directory of schemas (to distinguish)
           spec for extended components; separate local namespace; components not contained in NIEM
           example instance; may be multiple; may reference optional style sheet
           example stylesheet for display of instance; may be multiple

             list of artifacts in this IEPD; machine readable; portable format; browser displayable
             all metadata registered with this IEPD
     File Types         Req'd or
    (examples)           Option

      txt, doc             R       need guidelines for content of master
      txt, doc             O
      txt, doc             O
      txt, doc             O       refer to IEPD Endorsment in metadata tab
      txt, doc             O
      txt, doc             O
      txt, doc             O       may also provide products from testing
      txt, doc             O
      txt, doc             O
vsd, xmi, zargo, jpg,      O
      pdf, etc.
vsd, xmi, zargo, jpg,      O
      pdf, etc.
        xml                O       some might be written in Schematron and
                                   validated against the XML instances

      xls, csv             O       covered by the Component Mapping Tool
                                   (CMT) (preferred submission)
    xml, xls, csv          O       covered by the Component Mapping Tool
                                   (CMT) (preferred submission)

    xml, txt, doc          R       as xml this might help automatically id
                                   differences from previous versions

        xsd                R
        xml                R
        xsd                R
        xsd                O
        xsd                O
        xml                O
        xsl                O

     xml, xhtml            R       if xml, then possible style sheet too
     xml, xhtml            R       if xml, then possible style sheet too
Metadata for an IEPD

IEPD Summary
IEPD Description
IEPD Web Site
IEPD Security

Change log data (must be consistent with change log artifact)
IEPD Creation Date
IEPD Version
IEPD Last Revision Date

IEPD Next Revision Date

IEPD Certification

IEPD Status
IEPD Schedule
IEPD Endorsements
IEPD Sponsors

Navigation and Discovery
IEPD Lineage
IEPD Relationships
IEPD Keywords

Business Context
IEPD LoB (domain)
IEPD Purpose
IEPD Architecture Type
IEPD Communications Environment
IEPD Exchange Partner Categories
IEPD Exchange Partners
IEPD Process
IEPD Triggering Event
IEPD Conditions
IEPD Solicitation / Funding Source

Authoritative Source
Authoritative Source Organization Name
Authoritative Source Organization Web Site
Authoritative Source Address1
Authoritative Source Address2
Authoritative Source City
Authoritative Source State
Authoritative Source Zip
Authoritative Source Country
Authoritative Source Category
Authoritative Source POC Name
Authoritative Source POC Email
Authoritative Source POC Address1
Authoritative Source POC Address2
Authoritative Source POC City
Authoritative Source POC State
Authoritative Source POC Zip
Authoritative Source POC Country
Authoritative Source POC Phone
Authoritative Source POC Fax

            Universal Identifier (each IEPD version will have a distinct URI; NIEM will provide a suggested scheme for URIs,
            Title of this IEPD (e.g., Amber Alert, Prosecutor Arrest Warrant etc.)
            Brief summary of this IEPD for short display purposes (maximum of 160 characters including spaces)
            Narrative description of this IEPD; may contain as much detail as you think useful to those with a potential interest
            URL of Web site where this IEPD and related artifacts (e.g., XML schema, documentation, mapping
            Security label to indicate treatment/distribution of this IEPD, e.g. FOUO, classified, SBU, public, etc. (default is public, unless ot

istent with change log artifact)
             Project start date; YYYY-MM that planning or work on this IEPD started (do NOT confused with date you
             Version of this IEPD
             NIEM version used for this IEPD
             Year and month (YYYY-MM) this IEPD information was last revised (do NOT confuse with the date the IEPD itself
             was last revised generating a new IEPD version)
             Year and month (YYYY-MM) this IEPD information is expected to be revised

            State of development:
              1 -- entry level; under development; minimum documentation (see artifacts tab)
              2 -- complete; being tested; in limited use; draft documentation
              3 -- in production; fully documented; endorsed for use in official exchanges
            Description or additional information related to current state of this IEPD
            Information about the development schedule for this IEPD;e.g., “Development started YYYY-MM; draft planned
            Names or acronymns of professional or government organizations that support this IEPD as an official business
            Name of organization(s) that sponsored, contributed, or participated in the development of the IEPD

            IEPDs that this IEPD was derived or built from/with (identified by URI) (This is not normal version control)
            URIs of other IEPDs and their relationship to this IEPD; should not duplicate other attributes such as Lineage,
            Search terms that would not otherwise be in other metadata attributes (e.g. Georgia's Levi's Call for an Amber

            Primary line(s) of business (LoB) that this IEPD covers
            A short description of the business reason for using this IEPD; may include brief statement of scope
            Category of transaction this IEPD is used for: query/response, message, publish/subscribe, document, etc.
            Description of the primary communications environment(s) for which this IEPD was designed, for example
            Types of organizations that would use this IEPD
            Names of the organizations that are using this IEPD
            Business process(es) during which this IEPD is exchanged
            Event(s) that cause this IEPD to be exchanged
            Condition(s) under which this IEPD is exchanged
            * How this IEPD came about; reference the RFI, BAA, RFP, Grant, funding source, etc. (* This item is

            Organization name of the authoritative source
            URL of the Web site of the authoritative source
Category of authority to create IEPD (statuatory) vs to conduct the business the IEPD involves (policy) or both or
Person designated as the POC for the authoritative source and who can provide information, affect change, etc.
Req'd or








Metadata considered and rejected

Author Name
Author Organization Name
Author Phone
Author Email
Author Address
Contact Name
Contact Organization Name
Contact Phone
Contact Email
Contact Address
Organization Name
Organization Phone
Organization Email
Organization Address
Organization URL

IEPD Category

Exchange frequency

Method-of-Information-Collection Level
Reliability Level
Use Assignment Level

Authoritative Source Name
Authoritative Source E-mail Address
Authoritative Source Phone
Authoritative Source Fax

What is needed to build this IEPD?
Component LoBs/Domains
Component Versions
Candidate Components for NIEM
IEPD External Standards
IEPD Code Lists

IEPD Reference Indicator

IEPD Status

Registry dependent metadata; not a requirement for inclusion within an IEPD

Not well defined
Could be useful if another taxonomy is used; otherwise now an open-ended attribute; could be a sub-function of
only an estimate that will change; so not very meaningful to attach to IEPD
Instance oriented (not for IEPD schemas)
metadata about the instance (not the IEPD)
metadata about the instance (not the IEPD) (of source)
metadata about the instance (not the IEPD) (of information from source)
metadata about the instance (not the IEPD) (values: general, investigative, analytical, statistical, conjecture, etc.)
Duplicates the Authoritative Source POC
The name of the authoritative source who can provide information and affect change
The email address of the authoritative source
The phone number of the authoritative source
The fax number for authoritative source
Can harvest these from the artifacts

to identify candidates for addition to future releases
External standards referenced and used by this IEPD
Code lists and associated versions used by this IEPD
Replaced with IEPD Endorsements (so that a "reference IEPD" includes the organizations that support it)
True if this IEPD is a Reference IEPD; false otherwise
No metadata for a "planned" IEPD; replaced by IEPD Certification
Current status of this IEPD; values:
  Planned         - IEPD is planned for development, but development has not yet begun.
  Development - IEPD is currently being developed but a draft has not yet been completed for review.
  Draft          - A draft of the IEPD has been created and is under review.
  Completed       - IEPD has been drafted, reviewed, and baselined, but is not yet implemented.
  Implemented - IEPD is being used in a production environment.
Possible metrics                                                        Indicates

There are probably hundreds of metrics that could be collected or
derived from metadata. These are just some of the possibilities. Must
identify the most important metrics (that support business
requirements), and then ensure that the metadata either collects the
metric directly or enables its derivation.
How many different components are used in this IEPD?                    scope of model use
How many different components used from each of U, C, domains?          scope of reuse
How many different local extension components in this IEPD?             candidates for new components
What kinds of common artifacts are being provided?                      IEPD template content commonalities
How many different agencies use this IEPD?                              scope of use; how standard
How many IEPDs used in a given domain                                   scope of use; how standard
How often is this IEPD exchanged?                                       usage
How many times has this IEPD been updated?                              stability
How often has this IEPD been changed within the last year?              stability
How many different groups are submitting?                               who is doing the work

Primary reasons for collection
Search, retrieval, discovery of IEPDs and artifacts
Registration of IEPDs and artifacts
IEPD process and quality control
Support business requirements (see requirements tab)
Derived or explicit?

Shared By:
Description: Arrest Warrant Template document sample