MEG0021 Term Name, Enumerated Value and Container Name Representations
Draft Date (12/18/2008)
Version 1.0
Purpose
P1. Purpose
P1.1 Introduction
The purpose of this MEG is to define the guidelines for the representation of term names, enumerated values, and container names used within the Logical Data Dictionary and the MISMO standard.
P1.2 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.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.
- MUST - This word, with the term “REQUIRED”, indicates an absolute requirement of the specification.
- MUST NOT - This phrase indicates an absolute prohibition of the specification.
- 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.
- 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.
- 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.
2. Rationale for this MEG
Provide guidance on the XML format required for the MISMO data standards.
Content
C1. Content
C1.1 Guidelines
| Ref |
Guideline |
| 21.1 |
A term name, enumerated value or a container name MAY use an acronym in place of a word as specified in MEG 0008. The use of all other abbreviations and acronyms in a term name and enumerated values SHALL be prohibited. |
| 21.2 |
Proper nouns MAY be used in a term name, enumerated value or container name. If the proper noun is being used as a adjective or modifier to provide context, it is recommended that a more generic word be considered. |
| 21.3 |
Form names that are not under the control of MISMO MAY be used as enumerated values. These MAY be represented as published by the controlling source. It is however recommended that whenever possible a generic or universal form name be used.
For example:
Fannie Mae Appraisal Form #2055 ⇒ FNM2055. |
| 21.4 |
The format of the a term name, enumerated value, or container name MUST comply with the following rules: |
| 21.4.1 |
The first letter of every word MUST be capitalized. For example, Alimony Owed To Name, Borrower Requested Loan Amount. |
| 21.4.2 |
Approved acronyms MUST be represented in all capital letters.
For example, MSA Identifier, Seller Paid FHA VA Closing Costs Percent.
In some cases proper nouns may appear to be an acronym but in fact are not (i.e. there is no fully spelled out long name). In those cases the proper noun may be used but is represented as a single word.
For example: CASA, an application name with no long version would be represented as a single word Casa. |
| 21.4.3 |
Words that are hyphenated SHALL appear as two words.
For example:
VA Co-borrower Name ⇒ VA Co Borrower Name
VA Non-taxable Amount ⇒ VA Non Taxable Amount |
| 21.4.4 |
The use of punctuation and special characters SHALL be prohibited. Examples of punctuation and special characters are: &, /, (.), (,), etc. The one exception to this rule is that the underscore (_) SHALL be used in container names, to separate acronyms and other approved uses.
Commitment/Origination Fee ⇒ Commitment Origination Fee
203 (b) / 251 ⇒ 203 B 251 |
| 21.4.5 |
Single letters or Roman Numerals that are used SHALL be considered as individual words and treated the same. For example:
B II Condominium ⇒B II Condominium
eMortgage ⇒ E Mortgage
E PUD ⇒ E PUD
401k Account ⇒ 401 K Account |
| 21.4.6 |
Ordinal numbers that are used SHALL be spelled out. For example:
First Lien
Second Lien
Eleventh District Cost Of Funds |
| 21.4.7 |
Cardinal numbers that are used SHALL be represented in the following manner. |
| 21.4.7.1 |
Numbers less than or equal to twenty (20) SHALL be spelled out.
For example:
Three Two Option
Three Year Treasury |
| 21.4.7.2 |
Numbers greater than twenty (20) SHALL be represented using Arabic numerals.
For example:
Credit Liability Late 120 Day Count
FRE 60 Day Required Net Yield Percent |
| 21.5 |
Terms, enumerated values and container names SHALL be represented in the XML Schemas as follows: |
| 21.5.1 |
Terms and enumerated values SHALL be represented using upper camel case. There SHALL be no spaces between the words.
For example:
LienPriorityType |
| 21.5.2 |
Container names SHALL be represented using all capital letters. Spaces between words SHALL be replaced with an underscore (_).
For example:
LOANS
BORROWER_ALIAS |
| 21.5.3 |
Acronyms used in terms and enumerated values are represented in all capital letters. If two or more acronyms are used consecutively in a term or enumerated value the acronyms SHALL be separated by an underscore (_).
For example:
FHA_VALoanOriginatorIdentifier |
| 21.6 |
The XML representations of terms, enumerated values and containers SHALL be identical to their non-XML representation form. Therefore, the term “Adjustment Change Projected Principal Balance Amount” shall be represented in the XML as “AdjustmentChangeProjectedPrincipalBalanceAmount”. If a Workgroup identifies a business case requiring shortened names, the MISMO Architecture Committee MAY choose to allow such XML representation. |
M1. Metadata
| Element |
Description |
| Title |
MEG0021 Term Name and Enumeration Representations |
| Identifier |
MEG0021 |
| Category |
LIST OF CATEGORIES |
| Publisher |
MISMO |
| Copyright |
©2008 MISMO. All Rights Reserved. |
M1.1 Release History
| Release Date |
Version No |
Comments |
| 09/05/2008 |
.01 |
Initial Version |
| 12/15/2008 |
.02 |
Correct typographical errors |
| 12/15/2008 |
.03 |
Additions and clarifications based on 12/15 D3 call |
| 12/17/2008 |
.04 |
Updated contents of Disclaimer tab. |
| 12/18/2008 |
1.0 |
Governance Approval. |
M1.2 Known Issues or Omissions
None.
| Name |
Organization |
Contact Details |
| MISMO Staff |
MISMO |
info@mismo.org |
M1.4 References
Comments
None.
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 is used in context.
T1.3 Copyright
©2008 MISMO. All material in this MEG is the property of MISMO. All Rights Reserved.