Architecture Workgroup

MEG0006 Versioning and Release Schedule

Version: 0.09
Last Updated: 12/17/2008
Status: Approved by RGC

Purpose

P1. Purpose

P1.1 Introduction

The purpose of this document is to provide guidance regarding the versioning and release schedule for the MISMO Version 3.0 standards.

P1.2 Audience

MISMO Process Area Workgroups (WGs), Core Data/Structures WG, Architecture WG and the Residential Governance Committee.
Consumers, or implementers, of the standards.

P1.3 Terminology

The key words “MUST”, “MUST NOT”, “REQUIRED”, “SHOULD”, “SHOULD NOT”, “RECOMMENDED”, “MAY”, and “OPTIONAL” in this document are to be interpreted as described in RFC 2119

. See MEG0001 and MEG0009.

P1.4 Assumptions

This document reflects the MISMO Architecture Development principles at the time of writing. It is a living document that is updated as required to reflect the evolving nature of XML technologies and requirements identified by the MISMO constituency. For document change management information go to the Metadata tab. To provide feedback on this MEG, go to the Comments tab and click on New Entry.

P1.5 Rationale

Provide guidance on the release and versioning of the MISMO standards.

Content

C1. Content

C1.1 Guidelines

Ref	Guideline
6.1	MISMO SHOULD publish the reference model three times per year approximately 30 days after the Trimester Meeting.
6.1.1	MISMO SHOULD establish a yearly calendar of cut off dates for inclusion of all modifications and additions into the reference model version release.
6.1.2	All proposed modifications and additions to the reference model MUST be submitted by a Workgroup prior to the cut off date for inclusion into the next version release. Any proposed modifications and additions received after the cutoff date SHOULD be included in the following version release.
6.2	Each approved version release of the reference model SHALL receive a unique MISMO Reference Model Identifier value that represents the model version. See details below.
6.3	Each new version release of the reference model SHOULD be compatible with the previous release, unless there is an imperative reason for breaking backward compatibility.
6.3.1	A compatible release MUST follow the Extension method described in this MEG (see example schema and XML instance files below).
6.3.2	When a release breaks backward compatibility, it MUST also clean up (sweep) the containers which are no longer compatible with the previous release.
6.3.3	The cleanup process SHOULD involve removing all items from the MISMO namespace out of the EXTENSION containers and placing them within their parent. The name, type and semantics of the items MUST be preserved. All “extra” EXTENSION containers will be removed.
6.4	A Workgroup MAY create a Workgroup example schema that is a subset of the MISMO Reference Model to provide implementation guidance.

C2. Additional Information

C2.1 Model Versioning Convention

The MISMOReferenceModelIdentifier is formed from four particles:

A.CG.CS.B, defined as follows:

A	Architecture	All V3 MISMOReferenceModelIdentifiers have A=3
CG	Compatible Group	All releases with the same A.CG are compatible.Theory of Compatibility. “3.0” will be the first compatible group
CS	Compatible Sequence	The members of a compatible Group are assigned sequential values.
B	Model Build Identifier	Optional

Examples:

Version Number	Description
3.0.0.232	Initial release (assuming build number 232)
3.0.1.305	Compatible with 3.0.0
3.1.0.374	Breaks Compatibility
3.1.1.408	Compatible with 3.1.0
3.1.2.999	Compatible with 3.1.0 and 3.1.1

The MISMOReferenceModelIdentifier SHALL be included in each published schema as schema annotation elements (xsd:annotation). Each schema will also define a optional attribute for the MISMOReferenceModelIdentifier at the top level element of each message. However, instead of having a fixed value as in V2, the MISMOReferenceModelIdentifier attribute WILL be defined as a simpleType with a pattern restriction, as follows:

3.[0-9]{1,2}.[0-9]{1,2,3}(.?[0-9]{3,4,5})?

C3. Schema and XML Instance Examples

C3.1 BORROWER_DETAILS Original Schema Example

Sample XML Instance

<mismo:BORROWER_DETAILS>
	<mismo:BorrowerApplicationSignedDate>2008-07-17</mismo:BorrowerApplicationSignedDate>
	<mismo:BorrowerBirthDate>1981-02-09</mismo:BorrowerBirthDate>
	<mismo:BorrowerSSN>541298651</mismo:BorrowerSSN>
	<mismo:LegalEntityIndicator>false</mismo:LegalEntityIndicator>
</mismo:BORROWER_DETAILS>

C3.2 BORROWER_DETAILS Extended Schema Example

<xsd:complexType name="BORROWER_DETAILS">
	<xsd:sequence>
		<xsd:element name="BorrowerApplicationSignedDate" type="mismo:MISMODateTime" minOccurs="0"/>
		<xsd:element name="BorrowerBirthDate" type="mismo:MISMODateTime" minOccurs="0"/>
		<xsd:element name="BorrowerSSN" type="mismo:MISMOString" minOccurs="0"/>
		<xsd:element name="LegalEntityIndicator" type="mismo:MISMOIndicatorType" minOccurs="0"/>
		<xsd:element name="EXTENSION" type="mismo:BORROWER_DETAILS_EXTENSION_2009_1" minOccurs="0"/>
	</xsd:sequence>
</xsd:complexType>
<xsd:complexType name="EXTENSION">
	<xsd:sequence>
		<xsd:any namespace="##any" processContents="lax" minOccurs="0" maxOccurs="unbounded"/>
	</xsd:sequence>
</xsd:complexType>
<xsd:complexType name="BORROWER_DETAILS_EXTENSION_2009_1">
	<xsd:sequence>
		<xsd:element name="BorrowerEyeColor" minOccurs="0">
			<xsd:simpleType>
				<xsd:restriction base="xsd:string">
					<xsd:enumeration value="Blue"/>
					<xsd:enumeration value="Green"/>
				</xsd:restriction>
			</xsd:simpleType>
		</xsd:element>
		<xsd:element name="EXTENSION" type="mismo:BORROWER_DETAILS_EXTENSION_2009_2" minOccurs="0"/>
	</xsd:sequence>
</xsd:complexType>
<xsd:complexType name="BORROWER_DETAILS_EXTENSION_2009_2">
	<xsd:sequence>
		<xsd:element name="BorrowerHairColor" minOccurs="0">
			<xsd:simpleType>
				<xsd:restriction base="xsd:string">
					<xsd:enumeration value="Black"/>
					<xsd:enumeration value="Red"/>
				</xsd:restriction>
			</xsd:simpleType>
		</xsd:element>
		<xsd:element name="EXTENSION" type="mismo:EXTENSION" minOccurs="0"/>
	</xsd:sequence>
</xsd:complexType>

Sample XML Instance

<mismo:BORROWER_DETAILS>
	<mismo:BorrowerApplicationSignedDate>2008-07-17</mismo:BorrowerApplicationSignedDate>
	<mismo:BorrowerBirthDate>1981-02-09</mismo:BorrowerBirthDate>
	<mismo:BorrowerSSN>541298651</mismo:BorrowerSSN>
	<mismo:LegalEntityIndicator>false</mismo:LegalEntityIndicator>
	<mismo:EXTENSION>
		<mismo:BorrowerEyeColor>Blue</mismo:BorrowerEyeColor>
		<mismo:EXTENSION>
			<mismo:BorrowerHairColor>Black</mismo:BorrowerHairColor>
		</mismo:EXTENSION>
	</mismo:EXTENSION>
</mismo:BORROWER_DETAILS>

C3.3 BORROWER_DETAILS Cleaned up Schema Example

<xsd:complexType name="BORROWER_DETAILS"> <xsd:sequence> <xsd:element name="BorrowerApplicationSignedDate" type="mismo:MISMODateTime" minOccurs="0"/> <xsd:element name="BorrowerBirthDate" type="mismo:MISMODateTime" minOccurs="0"/> <xsd:element name="BorrowerSSN" type="mismo:MISMOString" minOccurs="0"/> <xsd:element name="LegalEntityIndicator" type="mismo:MISMOIndicatorType" minOccurs="0"/> <xsd:element name="BorrowerEyeColor" minOccurs="0"> <xsd:simpleType> <xsd:restriction base="xsd:string"> <xsd:enumeration value="Blue"/> <xsd:enumeration value="Green"/> </xsd:restriction> </xsd:simpleType> </xsd:element> <xsd:element name="BorrowerHairColor" minOccurs="0"> <xsd:simpleType> <xsd:restriction base="xsd:string"> <xsd:enumeration value="Black"/> <xsd:enumeration value="Red"/> </xsd:restriction> </xsd:simpleType> </xsd:element> <xsd:element name="EXTENSION" type="mismo:EXTENSION" minOccurs="0"/> </xsd:sequence> </xsd:complexType> <xsd:complexType name="EXTENSION"> <xsd:sequence> <xsd:any namespace="##any" processContents="lax" minOccurs="0" maxOccurs="unbounded"/> </xsd:sequence> </xsd:complexType>

Sample XML Instance

<mismo:BORROWER_DETAILS>
	<mismo:BorrowerApplicationSignedDate>2008-07-17</mismo:BorrowerApplicationSignedDate>
	<mismo:BorrowerBirthDate>1981-02-09</mismo:BorrowerBirthDate>
	<mismo:BorrowerSSN>541298651</mismo:BorrowerSSN>
	<mismo:LegalEntityIndicator>false</mismo:LegalEntityIndicator>
	<mismo:BorrowerEyeColor>Blue</mismo:BorrowerEyeColor>
	<mismo:BorrowerHairColor>Black</mismo:BorrowerHairColor>
</mismo:BORROWER_DETAILS>

End

Metadata

M1. Metadata

Element Description
Title Versioning and Release Schedule
Identifier MEG0006
Category Foundation 
Date Created 06/06/2008 3:35:00 PM
Last Updated 12/17/2008 8:08:00 PM
Publisher MISMO
Rights ©2008 MISMO. All Rights Reserved.

M1.1 Release History

Release Date Version Comments
6/6/2008 0.01 Initial Version
6/18/2008 0.02 Made updates based on discussions during 6/12 D3 call
7/3/2008 0.03 Added Schema and XML examples
8/20/2008 0.04 Removed the EXTENSION container to allow new elements to be placed directly at their final location in the schema
8/27/2008 0.05 Reverted to nested EXTENSION approach, but without predefining the schedule for non-compatible releases 
9/3/2008 0.06 Added section 6.5 - Senders to use lowest possible version. Other minor edits. 
9/5/2008 0.07 Based on feedback in Architecture meeting made wording changes to clarify process. No changes to extension approach.
10/2/2008 0.08 Some typographical corrections
12/17/2008 0.09 Global MEG format changes; changed “Disclaimer” tab to “Terms” and updated content.

M1.2 Known Issues or Omissions

None.

M1.3 Contacts

Name Organization Contact Details
MISMO Staff MISMO info@mismo.org

M1.5 References

Title Location
RFC2119 http://rfc.net/rfc2119.html
W3C Schema Structure http://www.w3.org/TR/2004/REC-xmlschema-1-20041028/structures.html

Comments

None.

Terms

T1. Terms and Conditions  
T1.1 Disclaimer  
MISMO accepts no liability for the accuracy, adequacy, or completeness of the information contained in this MISMO Engineering Guideline (MEG).  
T1.2 Reproduction 
 
Material in this MEG may be reproduced free of charge without obtaining explicit permission from MISMO, provided that the source is acknowledged, the document title given, and the material used in context.  
T1.3 Copyright 
 
©2008 MISMO. All material in this MEG is the property of MISMO. All Rights Reserved.

MEG0006 Versioning and Release Schedule

Quick Launch View All Site Content

P1. Purpose

P1.1 Introduction

P1.2 Audience

P1.3 Terminology

P1.4 Assumptions

P1.5 Rationale

C1. Content

C1.1 Guidelines

C2. Additional Information

C2.1 Model Versioning Convention

C3. Schema and XML Instance Examples

C3.1 BORROWER_DETAILS Original Schema Example

C3.2 BORROWER_DETAILS Extended Schema Example

C3.3 BORROWER_DETAILS Cleaned up Schema Example

Metadata

M1. Metadata

M1.1 Release History

M1.2 Known Issues or Omissions

M1.3 Contacts

M1.5 References

T1. Terms and Conditions

T1.1 Disclaimer

T1.2 Reproduction

T1.3 Copyright

Quick Launch
View All Site Content