Architecture Workgroup

 

Version: 0.04

Last Updated: 4/14/2009

Status: Ready For Governance Review

Purpose

1. Introduction

P1.1 Context

MISMO produces a variety of deliverables and collateral for each specification approved and published. In order to achieve a common understanding of each file’s purpose and status in the approval process, it is necessary to have a naming convention. This convention applies to all files regardless of format.

P1.2 Audience

This MEG was written for the following groups:

1. MISMO Workgroup members developing MISMO messages.
2. Designers and users of systems that create and consume the XML instance documents used in Real Estate Finance transactions.
3. Technical or business professionals wishing to evaluate MISMO specifications.

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.

1. MUST - This word, with the term “REQUIRED”, indicates an absolute requirement of the specification.
2. MUST NOT - This phrase indicates an absolute prohibition of the specification.
3. SHOULD - This word, or the adjective “RECOMMENDED”, means that there may exist valid reasons in particular circumstances to ignore a particular item, but the full implications must be understood and carefully weighed before choosing a different course.
4. SHOULD NOT - This phrase, or the phrase “NOT RECOMMENDED” means that there may exist valid reasons in particular circumstances when the particular behavior is acceptable or even useful, but the full implications should be understood and the case carefully weighed before implementing any behavior described with this label.
5. MAY - This word, or the adjective “OPTIONAL”, indicates that the specification allows the designer to choose whether or not to comply.

P1.4 Assumptions

The information supplied in this document reflects the MISMO architecture development and 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 the MISMO constituency.

Content

Guidelines

Ref	Guidelines
10.1	All MISMO published messages, reference models, and LDDs MUST strictly adhere to the following convention: Message Name + “_” + MISMO Version + “_” + Version Qualifier + “_” File Type Description + “.” File Extension.
10.1.1	Message Name – This is the name of the MISMO message. Words are capitalized and individual words separated by underscores.
10.1.1.1	For the MISMO Reference Model, the transaction name MUST be “MISMO_REFERENCE_MODEL”.
10.1.1.2	For the MISMO LDD, the transaction name MUST be “MISMO_LDD”.
10.1.1.3	Short names MAY be used for the message name for individual messages. A list of acceptable short names is included in this MEG.
10.1.2	MISMO Version – This is the number of the MISMO version in which the release candidate is proposed. Please see the MEG on Versioning and Release for additional information.
10.1.3	Version Qualifier – This reflects the state of the current file. Allowable values are: Draft_X, Core_Draft_X, Release_Candidate_X, or Public_Review_Draft. The final published version has no qualifier.
10.1.4	File Type Description- This is optional based on the file type and is only used if the file extension was not sufficient to describe the file (e.g. _With_Comments, New_LDD_Fields).
10.1.5	File Extension – This is the file extension such as .doc, .htm, .xls, .xsd, .xml, or .comp.
10.2	MEGs that are published on the web site, outside of the Wiki, MUST follow adhere to the following convention: “MEG_” + MEG Number + “_” + Version Qualifier + “.” + File Extension.
10.2.1	MEG Number - This is the assigned MEG number as established when the MEG is first created on the MISMO Wiki.
10.2.2	Version Qualifier – This reflects the state of the current file.
10.2.3	File Extension – This is the 3-letter file extension such as .doc, .htm, or .pdf.
10.3	File name MUST only include name characters that are approved by MISMO.
10.3.1	Ignoring usage constraints, the complete character set for naming MISMO resources is (0-9, A-Z, a-z) plus “.”(period), “-” (hyphen), “_” (underscore), “/” (slash), “#” (hash), and “:” (colon).
10.3.2	Hyphen is (“-”) allowed in designated contexts where use of underscore is impractical or undesirable.
10.3.3	Underscore is the preferred character for use as an internal delimiter between name sub elements if an explicit character is used; juncture may also be marked by camel case orthography.
10.3.4	The slash (“/”) or hash (“#”) character is allowable in http://www.w3.org/TR/1999/REC-xml-names-19990114/ URIs according to the rules for URIs and XML namespaces.
10.3.5	Colon (“:”) is expected in URN scheme namespaces.

Workgroup Shortnames

This list reflects the organizational components of the MISMO Residential lending vertical classification. Short names for workgroups in the Commercial vertical are available elsewhere.

Shortname	Workgroup Name
AUS	Origination: Underwriting
BREW	Business Rules Exchange
CLOSING	Origination: Closing
CREDIT	Credit Reporting
DOC_CLASS	Document Classification
EMIT	eMortgage Interface Transaction
EMORT	eMortgage
FLOOD	Flood
FRAUD	Fraud Detection and Prevention
ISWG	Information Security
MI	Mortgage Insurance
ORIG	Origination
PRIA	Property Records Industry Association
REPI	Property and Valuation Services
SEC	Secondary
SERVICING	Servicing
TAX	Real Estate Tax
TITLE	Title Insurance

Metadata

M1. Metadata

Element	Description
Title	File Name Construction
Identifier	MEG0010
Category
Date Created	09/23/2006 11:15:00 AM
Last Updated	03/11/2009 8:45:00 PM
Publisher	MISMO/
Copyright	©2008 MISMO. All Rights Reserved.

M1.1 Release History

Release Date	Version No.	Comments
9/23/2006	.01	Initial Version
1/09/2009	.02	Updated to bring inline with current V3 decisions.
1/19/2009	.03	Make changes per 1/12 D3 call.
3/11/2009	.04	Get in line with format

M1.2 Known Issues or Omissions

None. <developer provided content>

M1.3 Contacts

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

M1.4 References

Title	Location
RFC2119	http://rfc.net/rfc2119.html
W3C Schema Structure	http://www.w3.org/TR/2004/REC-xmlschema-1-20041028/structures.html
<other>	<if included in MEG>

Comments