padding=10 cellspacing=0 width=100%>Yahoo! is not affiliated with the authors of this page or responsible for its content.






Data Dictionary (DD) Template Version 5.4
8/1/2008

A DD Template provides
HUD a standard DD template for use in new database systems development. It provides
a standard format for loading data element information into a future
Metadata Repository (MDR). A DD template is required by the HUD System
Development Methodology (SDM) as specified in the SDM Database Specifications Checklist document. This template defines the required format and contents
for that DD requirement. It will be filled out in two phases, initially
after the SDM Define System phase is completed and then it is completed
after the SDM Build System phase. The When Required column identifies
which DD template column should be completed during which phase. 

This document describes
the contents of the template; the actual template is an Excel spreadsheet
which contains the following fields:

Template Column

Description

Value

Restriction 

(blank =
none)

When Required

(Define or Build)

HUD System Code

HUD IT system code. This identifies the system that
the data element belongs to.

 

Build

HUD System Name

HUD IT system name that identifies the system

 

Build

HUD DRM Subject Area

The HUD DRM Subject Area that the data element maps
to. HUD DRM Subject Areas are documented in the HUD Target EA Document, http://www.hud.gov/offices/cio/ea/newea/resources/eav5.pdf

 

Define

HUD DRM Entity

The HUD DRM Entity that the data element maps to.
HUD DRM Entities are documented in the HUD Target EA Document, http://www.hud.gov/offices/cio/ea/newea/resources/eav5.pdf

 

Define

LDM Entity Name

Name of entity in the Logical Data Model (LDM) that
the data element is stored in.

 

Define

Data Element (DE) Name

The name of the data element or attribute as represented in the
LDM. The most elementary unit of data that can be identified and described.

 

Define

DE Description

The description of the data contained in the data
element.

 

Define

Physical Table
Name

The name of the table in which
the proposed physical data element will reside.

 

Build

Physical Data Element Name

The name of
the proposed physical data element.

 

Build

Data Type

Database data element type, i.e. Integer, Char, DateTime.

 

Define

Max Length

Maximum length of the data that can be stored in
the data element.

Numeric value

Define

Precision (numeric)

Precision of numeric data element; the number of
decimal places.

Numeric  value

Build

Primary key?

Answers the question: Is this data element the primary
or part of the primary key for the table that the data element is a
part of?

Y or N

Define

Foreign key?

Answers the question: Is this data element a foreign or part of a foreign key for the table that
the data element is a part of?

Y or N

Define

Listed or Enumerated Values

The valid values for this data element if the data
element value is constrained.

 

Define

Default Value

The default value for this data element if no value
is entered at the time the record is created.

 

Define

Required?

Answers the question: Is the data element required
to contain data when the record is created?

Y or N

Define

Read-only?

Answers the question: Does this data element contain
read only or static data?

Y or N

Define

Integrity Requirements
The dependence of the data element
on the existence of another data element and, if so, what the requirements
of the dependency are.
 
Define
Format Requirements
Data format requirements (i.e.,
Social Security number must include dashes).
 
Define

Security Classification

The security classification of the data element.

 

Define

Business Rules
The constraints on the data
elements value based on a business requirement (e.g., a purchase order
number may not be created if the customer's credit rating is not adequate).
 
Define/Build
Data Source System
If this data element originates
from another system, enter that system name, table name, and data element
name in this field.
 
Define
Data Source Requirement Reference
The form, law or act, HUD requirement
that this data element meets or comes from, if applicable. Some possible
examples are; Sponsor
Address Street Name from HUD-40112 (form), or Section of Act
504 (2) (a), Education
Institution Name (Congressional act), or Type of
Assistance Transaction from the Federal Funding Accountability
and Transparency Act
 
Define

XML Tag

The XML tag for this data element if the data element
is part of an XML document.

 

Build

Logical Business English Name

The full business
name used at HUD to identify this element and which corresponds to the data
dictionary data element.

 

Define

Data Steward Name

Name and email
contact information for the data element owning HUD Data Steward. Contact
the EA Team (ea.team.support@hud.gov) for information about the current
Data Stewards at HUD.

 

Build

 

Data Element Descriptions Guidance

Precise and unambiguous
data definitions or description are one of the most critical aspects
of ensuring data sharing.  It is essential that there is explicit
understanding regarding the meaning of data.  One primary way for
ensuring that the datas meaning is clearly understood is by the data
description.  Therefore, it is required that every data element
have a well-formed definition, one that is clearly understood by every
user.

This section contains the
guidelines for providing good da