Data Object Naming Standards - new
*
Introduction
* Tables
* Views
* Columns
* Summary
Name Formatting Chart
Introduction
Standards - Overview
Business Names
A business name is an English phrase with a specific
construction and length that describes a single data object (e.g. table, column
name, etc). Each business name is comprised of one or more prime words,
optional modifying words and one class word. It cannot exceed 100 characters in
length. Systems developers assist end users in the construction of meaningful buiness names.
Class Words
The class word is the highest level of qualification
and the most important word in a business name. The class word is always the
last word of a business name. It must be a noun identifying the general purpose
of the data object. Data object types TABLE, VIEW, FACT_TABLE, etc., are also
class words. Example class words for columns are: NUMBER, NAME, TEXT and CODE. A class word list
is maintained in the naming repository.
A class "word" may be a phrase like SQUARE_FEET or FACT_TABLE.
The class word list is carefully constructed and
seldom extended, but entries can be added if there is a compelling reason to do
so based on changes in the data environment.
Prime Words
A prime word can be a single word, or a phrase such
as CAPITAL_ASSET. It is the most important modifier of the class word. It
identifies the application area, major data category, table, or view, depending
on the data object being named. Approximately 300 prime words are available to
categorize institutional data. Some example prime words are: ACCOUNT, COURSE,
FINANCE, ORGANIZATION, SECTION and STUDENT.
Modifying Words
Modifying words are used to add important business
information to a business name. Thus, addition of the modifying word PHONE to
the business name CUSTOMER_NUMBER forms CUSTOMER_PHONE_NUMBER'
. Similarly, addition of the modifying word LAST to the business name
STUDENT_NAME forms STUDENT_LAST_NAME. Modifying words can be any word or phrase
needed to adequately describe a data object.
Occasionally a data object clearly belongs to more
than one data category. In such cases, the business name should include multiple
prime words. For example, the data element GRADE refers to the score received
by a STUDENT (prime word #1) for work completed in COURSE (prime word #2). The
modifier GRADE describes neither COURSE nor STUDENT, but the relationship
between STUDENT and COURSE. Thus, an appropriate business name would be
STUDENT_COURSE_GRADE, where STUDENT and COURSE are prime words modifying the
GRADE class word.
Technical Names
The Name Validation and Generation (NVG) process
produces technical names by applying standard abbreviations to business names.
The length of technical names must not exceed 30 characters for column names
and 27 characters for object names.
Based on the use of compound word phrases and abbreviations, the Naming
Administrator and the developer can reduce the generated length of the
technical name to conform to the length restriction.
Adding Prime Words and Class Words
Addition of prime and class words can be requested
from the EDSS Naming Administrator. When
justified by the nature of the data being stored, prime words and class words
can be added to the Naming database in keeping with the characteristics and
meaning of these naming components.
General Guidelines
Business Names should be:
* singular for nouns and present tense for verbs.
* as meaningful as possible.
*
self-documenting.
* easily distinguishable.
Abbreviations
Abbreviations are not used in business names with few
exceptions. One reason to do so is to
limit the length of a business name, and then only if the abbreviation is for a
universally-known acronym or abbreviation such as IRS.
Table Standards
.
There are several types of tables-- move tables, fact
tables, dimension tables are examples.
All tables have the same formatting requirements for the business name
and the same length requirement for the generated technical name:
Types of tables:
The Naming application recognizes the following types
of tables. The CLASS_WORD identifies the
table type and is shown with the technical name abbreviation
TABLE _T
DIMENSION_TABLE
_DM
FACT_TABLE
_FT
DATAGROUP _GT
SECURITY_TABLE
_ST
MOVE_TABLE
_MT
Length of table name:
The maximum Oracle table name length is 30. The generated technical name for a table must
be 27 characters or less to reserve space for index names built from the table
technical name. This requirement exists In the EDSS Data Warehouse since the original
complete technical table name must be present in the names of indexes for the
table.
Examples of table business name, maximum-length
generated technical name and associated index names:
PURCHASING_PURCHASE_ORDER_RESTRICTED_MATERIAL_STATUS_HISTORY_TABLE (Business Name)
PUR_PO_RSTRC_MTRL_STATHST_T (Generated Technical Table Name, length =
27)
PUR_PO_RSTRC_MTRL_STATHST_TI1 (Index Name, length = 29)
PUR_PO_RSTRC_MTRL_STATHST_TI10 (Index Name, length = 30)
PUR_PO_RSTRC_MTRL_STATHST_TI29 (Index Name, length = 29)
Formatting requirements:
APPLICATION_NAME, MODIFIER words or
phrases, CLASS_WORD.
Examples of correctly-formatted table names:
STUDENT_LOAN_BORROWER_TABLE
STUDENT_ADVISING_CONTACT_TABLE
PURCHASING_COUNTY_DIMENSION_TABLE
HUMAN_RESOURCES_PERSONAL_DATA_DIMENSION_TABLE
View Standards
The Naming application recognizes two types of
views. The CLASS_WORD identifies the
view type and is shown with the technical name abbreviation
VIEW _V
MATERIALIZED_VIEW
_MV
Length of view name:
The generated technical view name is limited to 27
characters or less as for generated table names.
Formatting requirements:
APPLICATION_NAME, MODIFIER words or
phrases, CLASS_WORD.
Examples of correctly-formatted view names:
GENERAL_LEDGER_BALANCE_ORGANIZATION_HIERARCHY_VIEW
ADMISSIONS_APPLICANT_SUMMARY_MATERIALIZED_VIEW
File Standards
For file names, a required prime word identifies the
application area to which the file belongs.
Modifying words describe the data contained within
the file. The CLASS_WORD is
"FILE"
Formatting requirements:
APPLICATION_NAME or PRIME_WORD, MODIFIER words or
phrases, CLASS_WORD
Examples of correctly-formatted file names:
RESPONSIBILITY_CENTER_BUDGET_SUMMARY_FILE
PHYSICAL_FACILITY_WORK_ORDER_FILE
Column Name Standards
Class words for column names
A column name may end with any class word that does
not represent a table,
view or file as described above.
Examples of valid CLASS_WORDS for columns are NUMBER, TEXT, ADDRESS, KEY, INDICATOR.
Length of column names
The generated technical column name is limited to 30
characters or less.
Formatting requirements:
PRIME_WORD, MODIFIER words or phrases,
CLASS_WORD (Note: PRIME_WORD can be in any position except the
last word.)
Examples of correctly-formatted column names:
ACADEMIC_ADVISING_LOGICAL_NAME_CODE
BORROWER_CITY_NAME
CONTACT_PERSON_PHONE_NUMBER
ver 2.3
4/16/2009