MEG0026 (Rescinded)
Version: 0.08
Date: 11/11/2010
Status: Rescinded
Purpose - Guidelines for Creating Messages
1. Introduction
The MISMO Reference Model is a schema-based representation of the pieces necessary to communicate a variety of messages, or execute transaction, for the real estate finance industry. As such, the reference model is extremely large and robust. Therefore each MISMO Workgroup has the opportunity to limit the scope of their individual messages and use only the pieces of the reference model deemed necessary.
P1.1 Audience
This MEG was written for the following groups:
- MISMO Workgroup members developing MISMO messages.
- Designers and users of systems that create and consume the XML instance documents used in Real Estate Finance transactions.
- Technical or business professionals wishing to evaluate MISMO specifications.
P1.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
.
1. MUST - This word,or the terms “REQUIRED” or “SHALL”, mean that the definition is an absolute requirement of the specification.
2. MUST NOT - This phrase, or the phrase “SHALL NOT”, mean that the definition is an absolute prohibition of the specification.
3. SHOULD - This word, or the adjective “RECOMMENDED”, mean 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” mean 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”, mean that an item is truly optional.
P1.3 Document Status
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.
P2. Rationale for rescinding this MEG
MEG0026 was originally conceived to provide guidelines for workgroups to develop individual messages from the Version 3.x Reference Models. Since the decision has been made that workgroups will not publish individual schemas for their transactions; instead publishing Implementation Guides and sample XML messages for their specific business case use of a subset of the model.
Content
Guidelines
| Ref |
Guideline |
| 26.1 |
Each MISMO Workgroup MUST be responsible for creating their specific messages. |
| 26.2 |
Each Workgroup message MUST be derived from the MISMO reference model. |
| 26.3 |
Workgroups MAY trim, or restrict, the reference model to only those pieces required by the Workgroup‘s business case. |
| 26.3.1 |
Trimming of the model MUST occur at the container level and not at the data point level. Therefore, if a Workgroup requires a certain data point, they must include the entire container in their message. |
| 26.3.2 |
Workgroups MAY NOT restrict at the enumeration (simpleType) level. |
| 26.3.3 |
The Workgroup‘s Implementation Guide SHOULD indicate which fields within a specific container are required or optional for the particular message or business case. |
| 26.4 |
Each Workgroup‘s message MUST have a root of MESSAGE. |
| 26.4.1 |
Workgroups MAY decide to trim one of the values under the DATA container. The DATA container is a choice group between BUNDLES and DEAL. Each Workgroup MAY choose to either use the choice group or trim the container to include only BUNDLES or DEAL. |
| 26.4.2 |
Workgroups MAY chose to trim the DOCUMENT_SETS container. However, if a Workgroup decides to keep DOCUMENT_SETS, it MAY NOT trim any of the children containers. |
| 26.5 |
Each message published MUST have a description of the message’s intent and specific business usage. The description will be included in the annotation section of the MESSAGE container. |
Additional Information
Metadata
| Document |
| Date Created |
12/4/2008 11:25:00 AM |
| Date Modified |
3/11/2009 3:20:00 PM |
M1.1 Release History
| Date |
Release |
Comments |
| 12/4/2008 |
0.01 |
Created initial draft |
| 12/17/2008 |
0.02 |
Updated contents of Disclaimer tab. |
| 1/5/2009 |
0.03 |
Added information on restriction/trimming. |
| 1/14/2009 |
0.04 |
Updated to add information discussed on 12/8 D3 Call |
| 1/14/2009 |
0.05 |
Updated on 1/15 D3 Call |
| 2/2/2009 |
0.06 |
Updated to reflect PACKAGE decisions at the January trimester |
| 3/5/2009 |
0.07 |
Updated for MESSAGE root |
| 3/11/2009 |
0.08 |
Updated for MESSAGE root |
M1.2 Known Omissions
| Name |
Organization |
Contact Details |
| MISMO Staff |
MISMO |
info@mismo.org |
M1.4 References
Comments
None.
Disclaimer
Disclaimer. MISMO
® accepts no liability for the accuracy, adequacy, or completeness of the information contained in this MISMO Engineering Guideline (MEG).
Circulation. 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.
Copyright 2008 MISMO. All material in this MEG is the property of MISMO. All rights reserved.