Architecture Workgroup

MEG0016 Logical Data Dictionary Contents and New Term Submission

Draft Date 04/10/2009

Purpose

P1.1 Introduction

Describes the contents of the Logical Data Dictionary and provides rules and guidance for the submission of new terms.

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.

To provide feedback on this MEG, go to the Comments tab and click on New Entry.

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 «add reference to MISMO glossary for terminology used in this MEG».

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.

P1.5 Rationale for this MEG

Provide guidance on the format and submission process required for the Logical Data Dictionary.

Content

Guidelines

Ref	Guideline
16.1	The Logical Data Dictionary (LDD) consists of the following parts:
16.1.1	Term Name - Each LDD entry MUST have a name for the term that obeys the MISMO naming conventions. 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 - Each LDD entry MUST have a meaningful definition.
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. MEG 0021 Enumerated values for a single term 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. ManufacturedCondoHighRisePUD 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	Reference Model Context - Each term MUST include a count of the number of times it is used in the Reference Model and the name of the Container(s) in which it is used.
16.1.6	MISMO Data Type - The MISMO data type MUST be include for each term. The data type MUST be consistent with the class word. MEG 0007
16.1.7	Personal Private Information Indicator - Any term that is determined to be Personal Private Information MUST be designated value equal to “Y” (Yes). A term that either by itself or in conjunction with another term may be used to personally identify an individual, is considered confidential information or is deemed sensitive by currently enacted state breach notification laws is considered to be Personal Private Information. MEG 0012 Additional information or references to the federal or state laws associated with the data point MAY also be included in the LDD.
16.1.8	Application Information - Each term MAY contain additional information about its usage.
16.1.9	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 «MISMO namespace in URN form» : 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.2	New terms proposed to be added to the LDD MUST be submitted by a MISMO Workgroup to Core Data Structures for review and approval.
16.2.1	A 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 is 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.2.2	A submission MUST contain the following: Term Name Term Definition Enumerated Value - If applicable Enumerated Value Definition - If applicable Personal Private Information Indicator
16.2.3	Submissions SHOULD include the Reference Model Context (the proposed location in the Reference Model). If a location is not included then Core Data Structures will determine the appropriate location based on the business usage and placement of similar terms within the model.
16.3	The Workgroup that submits the request MUST provide one or more subject matter experts to Core Data Structures to assist in evaluating the submission and moving it through the MISMO approval process.

Metadata

Version .02
04/10/2009

Release History
Date	Release	Comments
DATE	.01	Initial Version
09/03/2008	.02	Reformat and added new information to reflect differences in version 3 LDD from previous versions.
12/15/2008	.02	Updated contents of Disclaimer tab.

Changes Since Last Version

Note

Known Issues

Contacts

Name Organization Contact Details

MISMO Staff MISMO info@mismo.org

Metadata

Element Description

Title MEG0016 Logical Data Dictionary Contents and New Term Submission

Identifier MEG0016

Category Foundation

Publisher MISMO

Rights Copyright 2008 MISMO. All rights reserved.

Date Created 10/23/2006 11:00:00 PM

Date Modifiend 4/10/2009 3:05:00 PM

References

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

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.

MEG0016 Logical Data Dictionary Contents and New Term Submission

Quick Launch View All Site Content