MISMO

2010 Page 1 of 6 7/20/2011 7:48 PM

MISMO Engineering Guideline 0016 (MEG0016)
Logical Data Dictionary and New Term Submission
v_1_1

PURPOSE
1. Introduction
1.1 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.

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.
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.

1.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.
2. Rationale for this MEG
This MEG provides a detailed definition of the contents of the MISMO Logical Data Dictionary and
the process for adding new content.


MEG0016 Logical Data Dictionary and New Term Submission
MISMO

2010 Page 2 of 6 7/20/2011 7:48 PM

CONTENT
1. Guidelines
Ref Guideline
16.0 The Logical Data Dictionary (LDD) is a catalogue of key components of the Reference Model
and MUST contain separate alphabetic list of the following components:
1. Terms
2. Containers
3. Data Attributes
4. ARC Roles

The Logical Data Dictionary MAY also contain sections listing data points and containers that
have been recently deprecated or replaced.

16.1 Each Term in the LDD is defined by the following items:
1. Term Name
2. Term Definition
3. Enumerated Values
4. Enumerated Value Definition
5. MISMO Data Type
6. Usage within the Reference Model
7. Uniform Resource Name
8. Application Information
9. Data Point Name

16.1.1 Term Name The term name MUST obey the MISMO naming conventions. (See MEG 0011)
These conventions include the use of a Class Word that reflects the data type of the fact and
places restrictions on the usage of abbreviations and acronyms.
16.1.2 Term Definition The term MUST have a meaningful definition.
Special characters (<,>,&,, ,etc.) SHOULD not be used in definitions.
MEG0016 Logical Data Dictionary and New Term Submission
MISMO

2010 Page 3 of 6 7/20/2011 7:48 PM
Ref Guideline
16.1.3 Enumerated Value - All terms with the Class Word Type (enumerated data type) MUST
include a list of allowable values.

Enumerated values MUST obey the MISMO naming conventions. (See MEG 0021)

Enumerated values for a single data point SHOULD be mutually exclusive.

Enumerated values for a single term SHOULD include all of the most frequently used values as
determined by current common business practice. The enumerated value of Other MUST be
included in the list, if the list is not exhaustive. When the enumerated value of Other is
included, an additional term MUST be added to the LDD to describe the value of Other. That
term MUST be named using the following format, (Term Name) Other Description.

Example:

Asset Type

Asset Type Other Description

Guidance: MISMO enumerations are based upon strings. There is a balance point between
meaningful human readable strings and overly long strings.

ManufacturedCondominiumHighRisePUD is an example of a poorly constructed enumeration.
It attempts to incorporate information about the method of construction, the ownership, height
above ground and the planning process for the community in which it resides. If you find
yourself struggling with a granularity issue that is you see some enumerations are general and
some more specific consider using two data points.
16.1.4 Enumerated Value Definition - Each enumerated value SHOULD have a definition if the
enumerated value by itself may not be sufficiently understood or if additional clarity is needed.
The use of definitions for enumerated values is an alternative to overly long enumeration value
names.
16.1.5 MISMO Data Type - The MISMO data type MUST be include for each term. The data type
MUST be consistent with the class word. (See MEG 0007)
16.1.6 Usage - The usage of the term within the Reference Model MUST be defined and contain the
following information:
1. Number of times the term is used within the Reference Model.
2. Name of the container(s) the term is used in.
3. The usage name(s) of the term within the Reference Model schema.

Note: In most cases the name of the term in the LDD and the usage name within the
schema are the same. In some instances where the LDD name is a generic type, there
may be one or more different usage names in the schema.
MEG0016 Logical Data Dictionary and New Term Submission
MISMO

2010 Page 4 of 6 7/20/2011 7:48 PM
Ref Guideline
16.1.7 Uniform Resource Name (URN) - Each LDD term and enumeration MUST have a URN. These
are created automatically.

The URN of a term is formed from URN:FDC:MISMO.ORG:2010:RESIDENTIAL followed by
the UpperCamelCase Space removed form of the Data point term. The URN of an enumerated
value is the URN of its data point followed by : Enumeration Value

16.1.8 Application Information - Each term MAY contain additional information about its usage.
16.1.9 Data Point Name Each term MUST have a corresponding data point name. The
representation of the data point name is defined by MEG 0021.
16.2 Each Container in the LDD is defined by the following items:
1. Container Name
2. Container Definition
3. Usage
4. Uniform Resource Name

16.2.1 Container Name The container name MUST obey the MISMO naming conventions. (See
MEG 0011)
16.2.2 Container Definition - The container MUST have a meaningful definition describing its contents
and/or usage.
16.2.3 Usage - The usage of the container within the Reference Model MUST be defined and contain
the following information:
1. A count of the number of times the container is used within the Reference Model.
2. A name(s) of the containers of which the referenced container is a child.
3. The usage name(s) of the data point within the Reference Model schema.

16.2.4 Uniform Resource Name (URN) - Uniform Resource Name (URN) - Each container MUST
have a URN. These are created automatically.

The URN of a container is formed from URN:FDC:MISMO.ORG:2010:RESIDENTIAL followed
by the Upper Case form of the container name where words are separated by underscore.

16.3 Each Attribute in the LDD is defined by the following items:
1. Attribute Name
2. Container Definition
3. Usage
4. Uniform Resource Name
16.3.1 Attribute Name The attribute MUST have a name. Currently there are no naming
conventions for attributes.
MEG0016 Logical Data Dictionary and New Term Submission
MISMO

2010 Page 5 of 6 7/20/2011 7:48 PM
Ref Guideline
16.3.2 Attribute Definition: A data point MUST have a meaningful definition.
16.3.3 Usage - The usage of the attribute within the Reference Model MUST be defined and contain
the following information:
1. A count of the number of times the container is used within the Reference Model.
2. A name(s) of the containers of which the referenced container is a child.
3. The usage name(s) of the attribute within the Reference Model

16.3.4 Uniform Resource Name (URN) - Each attribute MUST have a URN. These are created
automatically. The URN of an attribute is formed from
URN:FDC:MISMO.ORG:2010:RESIDENTIAL followed by the UpperCamelCase space
removed form of the data point name.

16.4 All submissions for maintenance (additions, deletions, modifications) to the LDD (including the
Reference Model structure) MUST be submitted by a MISMO Workgroup to Core Data
Structures (CDS) for review and approval as per MISMO Policies & Procedures.
Submissions are subject to the following additional rules:
16.4.1 Each submission SHOULD have a brief description of the current or future business usage that
would require the exchange of the proposed terms. Each term should be identified for usage in
the exchange as part of an internal process within an organization or for usage in an external
business to business exchange.

MISMO does not standardize process but understanding the process where data is
exchanged is important to understanding the need for the terms and their context in the
Reference Model
16.4.2 All submissions MUST be submitted in a format approved by CDS and MUST be complete. All
mandatory LDD components MUST be included in the submission. CDS will return without
review, all submissions that incomplete or not in correct format.
CDS reserves the right to modify the format in order to support changes in process and
procedures.
16.4.3 All submissions MUST be received by CDS members a minimum of 7 days prior to the
scheduled review date. Under certain compelling circumstances, CDS Chair MAY choose to
waive this requirement.
16.4.4 The Workgroup that submits the request MUST provide one or more subject matter experts to
CDS to assist in evaluating the submission and moving it through the MISMO approval
process.


MEG0016 Logical Data Dictionary and New Term Submission
MISMO

2010 Page 6 of 6 7/20/2011 7:48 PM
METADATA



1. Release History
Date Release Comments
04/10/2009 1_0 Initial release
12/02/2010 1_1 Updated to reflect new content of LDD and clarify submission process.
Further revised to change usage of words data point and term.








2. Changes Since Last Version
Notes: none



3. Known Omissions
Notes: none

4. References



Comments concerning this MEG may be sent to info@mismo.org.

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 materials in these MISMO Engineering Guidelines are the copyright of the MISMO. All
rights are reserved.