MEG0040 Publication Package
11/04/2008
Purpose
1. Introduction
Describes and outlines the requirements around the content to be include in the standard publication. Version 3.0 publications will include a more robust set of artifacts designed to support the individual published messages.
1.1 Audience
The Workgoups tasked with preparing the standard packages and the MISMO staff charged with organizing and publishing the contents.
1.2 Terminology
The key words “MUST”, “MUST NOT”, “REQUIRED”, “SHALL”, “SHALL NOT”, “SHOULD”, “SHOULD NOT”, “RECOMMENDED”, “MAY”, and “OPTIONAL” in this document are to be interpreted as described in RFC 2119
. See «add reference to MISMO glossary for terminology used in this MEG».
1.3 Document Status
The information supplied in this document reflects the MISMO interoperability principles at the time of writing. It is a living document, which will be updated as required to reflect the evolving nature of XML technologies and service requirements identified by MISO constituency. Comments on this document should be sent to the MISMO designated contact identified in the document preface. MISMO does not accept any liability for the accuracy, adequacy or completeness of the information contained in these Guidelines.
2. Rationale for this MEG
Provide guidance on the XML format required for the MISMO data standards.
Content
Guidelines
| Ref |
Guideline |
| 40.1 |
In coordination with the schedule releases as described in MEG0006, MISMO WILL publish individual packages for each released MISMO message. |
| 40.2 |
For each scheduled release, MISMO WILL publish a package for the entire reference model. The contents of the package will be uniform accross all releases unless the MISMO Architecture Committee deems it necessary for the contents to deviate or change. |
| 40.2.1 |
The entire reference model package WILL include both a documented and non-documented (production) W3C schema that represents the entire reference model structure. The documented schema will include the definitions for the terms representing both containers and data points within the model in addition to notes captured in the AppInfo section of the XML documentation node. The non-documented schema will not include any MISMO-based documentation. |
| 40.2.2 |
The entire reference model package WILL include a full Logical Data Dictionary (LDD). The LDD will be presented in Excel and HTML. MEG0016 defines the contents of the LDD. |
| 40.2.3 |
The entire reference model package SHOULD include a generic Implementation Guide (I-Guide). |
| 40.3 |
For each scheduled release, MISMO WILL publish a package for each message that is being released. The contents of the package will be uniform accross all releases unless the MISMO Architecture Committee deems it necessary for the contents to deviate or change. |
| 40.3.1 |
The individual message packages WILL include both a documented and non-documented (production) W3C schema that represents only the specific message being released. The documented schema will include the definitions for the terms representing both containers and data points within the model in addition to notes captured in the AppInfo section of the XML documentation node. The non-documented schema will not include any MISMO-based documentation. |
| 40.3.2 |
The individual message packages WILL include both a full LDD and a message specific Logical Data dictionary. The LDDs will be presented in Excel and HTML. MEG0016 defines the contents of the LDD. |
| 40.3.3 |
The individual message packages WILL include a message-specific Implementation Guide (I-Guide) in PDF format. The guide will detail exactly which fields (terms) are actaully appropriate for the message for each container published in the message. |
| 40.3.4 |
The individual message packages WILL include a message-specific Implementation Guide (I-Guide). |
| 40.3.5 |
The individual message packages SHOULD include an MXCompliance Testing Guide. |
Additional Information
Content
Guidelines
| Ref |
Guideline |
| 40.1 |
In coordination with the schedule releases as described in MEG0006, MISMO WILL publish individual packages for each released MISMO message. |
| 40.2 |
For each scheduled release, MISMO WILL publish a package for the entire reference model. The contents of the package will be uniform accross all releases unless the MISMO Architecture Committee deems it necessary for the contents to deviate or change. |
| 40.2.1 |
The entire reference model package WILL include both a documented and non-documented (production) W3C schema that represents the entire reference model structure. The documented schema will include the definitions for the terms representing both containers and data points within the model in addition to notes captured in the AppInfo section of the XML documentation node. The non-documented schema will not include any MISMO-based documentation. |
| 40.2.2 |
The entire reference model package WILL include a full Logical Data Dictionary (LDD). The LDD will be presented in Excel and HTML. MEG0016 defines the contents of the LDD. |
| 40.2.3 |
The entire reference model package SHOULD include a generic Implementation Guide (I-Guide). |
| 40.3 |
For each scheduled release, MISMO WILL publish a package for each message that is being released. The contents of the package will be uniform accross all releases unless the MISMO Architecture Committee deems it necessary for the contents to deviate or change. |
| 40.3.1 |
The individual message packages WILL include both a documented and non-documented (production) W3C schema that represents only the specific message being released. The documented schema will include the definitions for the terms representing both containers and data points within the model in addition to notes captured in the AppInfo section of the XML documentation node. The non-documented schema will not include any MISMO-based documentation. |
| 40.3.2 |
The individual message packages WILL include both a full LDD and a message specific Logical Data dictionary. The LDDs will be presented in Excel and HTML. MEG0016 defines the contents of the LDD. |
| 40.3.3 |
The individual message packages WILL include a message-specific Implementation Guide (I-Guide) in PDF format. The guide will detail exactly which fields (terms) are actaully appropriate for the message for each container published in the message. |
| 40.3.4 |
The individual message packages WILL include a message-specific Implementation Guide (I-Guide). |
| 40.3.5 |
The individual message packages SHOULD include an MXCompliance Testing Guide. |
Metadata
Version .01
11/04/2008
| Release History |
| Date |
Release |
Comments |
| 11/3/08 |
.01 |
Initial Version |
| Changes Since Last Version |
| Note |
| Contacts |
| Name |
Organization |
Contact Details |
| MISMO Staff |
MISMO |
info@mismo.org |
| Metadata |
| Element |
Description |
| Title |
MEG0040 Publication Package |
| Identifier |
MEG0040 |
| Category |
Foundation |
| Publisher |
MISMO |
| Rights |
Copyright of MISMO. All rights reserved. |
| Date Created |
11/03/2008 10:33:00 AM |
| Date Modifiend |
11/04/2008 11:10:00 AM |
References
Comments
None.
Disclaimer
Circulation Material in this guideline may be reproduced free of charge without requiring specific permission provided that the source is acknowledged, the document title given and the material is used in context.
Copyright All material in these MISMO Engineering Guidelines are the copyright of the MISMO. All rights are reserved.