Logical Data Model Conventions 16143327
Logical Data Model Conventions 16143327
Page i
Table of Contents
1. Background ............................................................................................................................................. 1 2. Scope........................................................................................................................................................ 1 2.1. In Scope........................................................................................................................................... 1 2.2. Out of Scope.................................................................................................................................... 1 3. Audience .................................................................................................................................................. 1 4. Roles and Responsibilities .................................................................................................................... 1 4.1.1. Data Architects ................................................................................................................... 1 4.1.2. Data Modelers .................................................................................................................... 1 4.1.3. Business Analysts............................................................................................................... 2 4.1.4. Quality Assurance Analysts (where applicable) ................................................................. 2 4.1.5. Business Client ................................................................................................................... 2 4.1.6. Project Manager ................................................................................................................. 2 4.1.7. LDM Responsibilities .......................................................................................................... 2 5. LDM Process ........................................................................................................................................... 3 5.1.1. Hold Project Data Planning Session................................................................................... 3 5.1.2. Develop Data Structure and Definitions ............................................................................. 3 5.1.3. Hold Logical Model Reviews............................................................................................... 3 5.1.4. Resolve Significant Issues.................................................................................................. 3 5.1.5. LDM Process In Plain Terms .............................................................................................. 3 6. LDM Guidelines ....................................................................................................................................... 3 6.1.1. Use of the Data Models ...................................................................................................... 4 6.1.2. Entity Relationship Diagram ............................................................................................... 4 6.1.3. Standard Notation............................................................................................................... 4 6.1.4. Large Data Models ............................................................................................................. 4 6.1.5. Entity Naming Guidelines ................................................................................................... 4 6.1.6. Entity Definition Guidelines................................................................................................. 5 6.1.7. Attribute Definitions............................................................................................................. 5 6.1.8. Name Structure................................................................................................................... 5 6.1.9. Description .......................................................................................................................... 7 6.1.10. Format............................................................................................................................... 7 6.1.11. Length ............................................................................................................................... 7 6.1.12. Optionality ......................................................................................................................... 7 6.1.13. Domain of Values ............................................................................................................. 7 6.2. Standard: Relationship .................................................................................................................... 7 6.2.1. Definition ............................................................................................................................. 7 6.2.2. Properties............................................................................................................................ 7 6.2.3. Cardinality ........................................................................................................................... 7 6.2.4. Optionality ........................................................................................................................... 7 6.2.5. Rolename............................................................................................................................ 7 7. Logical Model Checklist ......................................................................................................................... 8 7.1.1. Technical quality or the entity relationship diagram ........................................................... 8 7.1.2. Technical quality of the data dictionary. ............................................................................. 8 7.1.3. Data Dictionary ................................................................................................................... 8 8. LDM Deliverables .................................................................................................................................... 9 9. Open Issues............................................................................................................................................. 9
Page ii
10. Model and Model Description .............................................................................................................. 9 11. Procedures ............................................................................................................................................ 9 12. Glossary................................................................................................................................................. 9 13. Associated Instruments ..................................................................................................................... 10 13.1. Related CIBC Technology Architecture Guidebook Standards................................................... 10 13.2. Related Documents ..................................................................................................................... 10 14. Control Information............................................................................................................................. 11 14.1. Contact Information ..................................................................................................................... 11 14.2. Publication ................................................................................................................................... 11 14.3. Version History ............................................................................................................................ 11 Appendix: Standard Abbreviation List ................................................................................................... 12
Page 1 of 13
1. Background
The Logical Data Management (LDM) process outlines how models are produced and reviewed during the development of an application. The LDM guidelines describe the specific requirements tested for in the model reviews. The LDM responsibilities indicate persons or organizational roles responsible for producing endorsed models.
2. Scope
2.1. In Scope
Standards and guidelines for documenting business data requirements in a logical data model. Logical data model naming conventions.
3. Audience
Data architects, data modelers, and business analysts who document business data requirements in data models. Project managers, business clients, and quality assurance analysts who sign off on models and verify use of the guidelines. Developers, database analysts, and anyone else who reads and reviews data models.
Page 2 of 13
Ensure all informational business rules are documented in the data model, according to the standards, including entities, attributes, and relationships, entity and attribute definitions, valid values, default values, and relationship optionality and cardinality. Ensure data-related naming conventions and standards are applied consistently. Ensure that all business data requirements are addressed by the data model. Sign-off on completed model from a modelling or standards point of view.
Project Manager Follow LDM process. Perform Quality Assurance. Project Participants Prepare LDMs.
Data Administrator Provide consultation. Interpret standards. Expedite development. Produce feedback. Steering Committee and Managers Resolve issues.
Page 3 of 13
5. LDM Process
5.1.1. Hold Project Data Planning Session
At the initiation of a project, the Project Manager holds a data planning session with the Data Architecture Group to establish the broad data requirements for the project. The number and size of models are determined and the appropriate standards are identified. Sources for some models may also be identified. The data planning session is held early in the project, well before formal requirements are resolved. The Data Architecture Group will be responsive and cooperative during the planning session.
6. LDM Guidelines
The intent of the Logical Data Model is to explicitly document a comprehensive understanding of the data to be stored and delivered in an application. Documentation provided for the review should be at a level of detail where little information is required to read and understand the datas structure as a whole. The presented model may refer to readily available documents or append any ancillary information as necessary. The Logical Data Model (diagrams and dictionary) are produced with the CIBC-recognized
Page 4 of 13
CASE tool. The currently recognized CASE tool within CIBC is Ca ERwin. Other forms of presentation are not permitted. Entity and attribute names must conform to CIBC naming standards. The intent of system development is to produce a working application. The intent of this document is not to impact that process, but enhance it, to the benefit of CIBCs business objectives as a whole. Where the efforts to produce the Logical Data Model appears excessive, and it can be shown that the risks the models attempt to expose are understood and resolved elsewhere, the guidelines may be explicitly relaxed by the Data Architecture Group. Where significant maintenance is performed on a system that doe not have any models, data models must be provided for the parts of the system that are significantly altered. Where maintenance is performed on systems with existing models, the models must be changed to reflect these standards before the maintenance is performed.
Page 5 of 13
1. Instances
An entity must have instances. 2. Nouns The first sentence of the definition should give a noun or group of nouns, with modifying adjectives or phrases that summarize the meaning of the entity. e.g., An Employee is any person, alive or dead, who works or has worked for the company. 3. Examples Typical examples are included. The first example should be one that is firmly in the collection, which solidly reinforces the readers understanding. Other examples should reveal the bounds of the entity. An example that may not be considered an instance will help establish the boundary. This requires anticipating instances where there may be confusion for the reader. Also of value is an example of an instance that is not a valid member of the group. This shows the boundary from another angle. Often wording that explains why and whether examples are included are necessary. The definition should include a clear explanation of why these examples are or are not included. e.g., As soon as a person becomes a candidate for a position in the company, he becomes an Employee whose status is un-hired. This allows personal information to be entered only once. Applicants who are not considered for a position are not Employees. 4. Intent Where possible, the intent of the entity should be shown. This allows the reader to understand the rationale for the entity and fit their own understanding of the business into the one represented by this entity. e.g., The intent of the Employee entity is to capture any information about a person the company deals with in an employee-employer relationship. This includes personal information, tax, skills, and capabilities. Information relating to contracted individuals is kept with the client entity. 5. Differentiation Where there may be confusion between two similar entities, either because their names are similar or because their descriptions or relationships are similar, there should be explicit text that explains the difference. e.g., The Worker entity may be confused with the Employee entity. The Worker entity is used to collect information about clients who are supported in the work they do.
Page 6 of 13
modeling technique used to lend clarity to attribute names and is a means of categorizing data (e.g. is it time, date, monetary amount, coded information). The following table defines the current, valid classwords:
Classword Address Physical Abbreviation adr Description Identifies a component of an address that is not covered by other classwords (in particular, to be used for e-mail addresses). May also apply to Line 1, 2 of an address. For City, Province, use City Name, Province Name. A number of monetary units, which is always expressed in whole and fractional portions. A unit of currency is required. A classification of data that is not codified and does not require a reference or transaction table to become meaningful information. Words, letters, figures, or symbols used to represent others, for brevity or secrecy. Requires a reference or translation table to become meaningful information. An integer (>= 0) that represents the whole number of units of a given item in the indicated unit of measure. Available for arithmetic use. A measurement of time from which year, month, and day may be derived. A measurement of time from which year, month, day and time may be derived. Data that is unstructured, relatively undefined in content, and varying in length. Text-type data generally contains a description that applies to a code or an entity. May contain text, alphanumeric and other printable characters. A quantitative measure of spatial proportions in up to three dimensions. A non-intelligence bearing attribute whose purpose is to uniquely identify an independent entity. A picture or graphic. A field that may contain one of two values only, usually Y or N. When more than two states apply, use Code as the classword. A system generated ID or surrogate key. Typically used in dimensional modelling as a primary key for a dimension. A word or phrase that constitutes the distinctive, formal or legal designation of a person, place, thing, or concept. What the person, place, thing, or concept is known by or called. A numeric integer used for identification or sequencing, and not intended for arithmetic use. A numeric ratio of two values having the same unit of measure, expressed in hundredths. A unit-less measurement expressing a part of a whole. A period of time month and year A number of units. A real number indicating a measure implied to be in units and available for arithmetic use. A measurement of change over time expressed in designated units of measure. A quantity or amount measured with respect to another measured quantity or amount, or a fixed charge, cost or value. An indication of time of day that is capable of indicating hours, minutes, and/or seconds, including fractions. A numeric quantity that is assigned or is determined by calculation or measurement. Note: For financial or monetary values, the classword Amount is to be used. A value that represents the year portion of a date. Comments and Examples
Amount
amt
Category
cat
Code
code
Count
cnt
To replace dimension
Key
key
Name
name
Number Percentage
nmbr pct
pd qty rate
Time Value
time value
Year
yr
Page 7 of 13
6.1.9. Description
An attribute description contains a narrative description of the data contained in the attribute. The description: Must be clear, concise and self-explanatory, using only CIBC business terminology without references to technology, implementation or system processing rules. Must not include abbreviations or acronyms.
6.1.10. Format
Format refers to the type of data contained in an attribute (e.g., numeric, text, date, time).
6.1.11. Length
Length is the maximum number of characters or digits allowed for each value of an attribute. The maximum length varies according to the domain.
6.1.12. Optionality
Optionality identifies whether an attribute is mandatory or optional.
6.2.2. Properties
A relationship has the following properties: Cardinality (zero, one or more to one or many) Optionality (mandatory or not) Rolename)
6.2.3. Cardinality
Describes the number of times an instance of an entity may participate in a relationship with another entity. Cardinality is documented using the IE notation in ERwin to draw the relationship.
6.2.4. Optionality
Indicates whether the relationship is optional or mandatory, for the entities that are joined by a relationship.
6.2.5. Rolename
A rolename must be applied to a relationship to specify the role that the entity is playing in that relationship.
Page 8 of 13
o o
o o o o o
Page 9 of 13
8. LDM Deliverables
The LDM deliverables are as follows: A scheduled data-planning meeting, including agenda (Project Manager) Scheduled reviews of suitable size (Project Manager) A Logical Data Model consisting of entity relationship diagrams and the data dictionary (Project Manager) The review's feedback document (Data Architecture Group) Data Model Sign-off: The logical data model is considered complete when unconditionally signed off by the Project Manager, the business users, the Data Architecture Group, the Application Manager and the authors of the models
9. Open Issues
There are no open issues associated with this document.
11. Procedures
There are no procedures associated with this document.
12. Glossary
Word/Acronym Attribute Definition A property or characteristic of an entity. An attribute must describe one concept and have singularity of purpose or use. An attribute is the lowest level of information that qualifies and describes an entity on a logical data model and represents facts about an entity. Describes the number of times an instance of an entity may participate in a relationship with another entity. Values: 1-to-1, 1-to-many, and many-to-many Examples: A Customer may have one or many Accounts. A noun within an attribute name that defines the generic grouping of data to which the attribute belongs. Classwords are the last component of an attribute name. Classwords are reserved words and should not be used anywhere else in the attribute name. A Classword is a modelling technique used to lend clarity to attribute names. A Classword is a means of categorizing data (e.g., is it time, date, monetary amount, coded information). This is a technique developed to structure data around natural business concepts, and to provide a foundation for performance-related data analysis. The focus in dimensional modelling is to organize information according to the way business analysts intuitively think about their data, and to minimize the number of joins required to retrieve the information into meaningful, integrated reports. Provides the ability to view the basic informational components of the enterprise independent of existing database constraints and political or parochial perspectives. An Enterprise (Logical) Data Model: Represents one single version of the truth for the data and related business rules of the enterprise. Consists of the set of logical data models for all the subject areas required by the business. All user views of the data are merged into one enterprise view to facilitate the development of integrated databases in which the commonality of data used by different areas is recognized. An entity is a fundamental thing of relevance to the enterprise about which data is kept. It is composed of a collection of logically related units of data or attributes that describe the entity (see Attribute). An entity can be classified and have stated relationships to other entities. A representation of the data entities, relationships and attributes for the scope of the logical data model. A logical data model consists of a diagram and the supporting data dictionary documentation.
Cardinality
Classword
Dimensional Modelling
Entity
Page 10 of 13
Definition Data about data. Metadata describes characteristics of data, such as size of field, what kind of data can be in it (numeric, character), whether field is optional or must have a value, valid values, etc. A component of the attribute naming conventions. A modifier is an adjective that narrows the scope identified by the prime and classwords (e.g., open, start, close). Represents business data requirements in its simplest form. Normalization in this context refers to the elimination of redundancy and inconsistent dependency. This is done by: Eliminating repeating groups in individual entities Creating separate entities for each related set of data Identifying atomic pieces of data (e.g., attributes) Identifying each set of related data with a unique identifier or primary key Creating separate entities for sets of values that appear in multiple instances (reference tables) Relating entities to each other with foreign keys (relating unique identifiers) Eliminate attributes in the entities that do not depend on the unique identifier Indicates whether entities joined by a relationship must participate in the relationship. Values: optional, mandatory Examples: An Account must have at least one Card associated with it. A Customer may or may not have an e-mail address. Describes the proposed or existing data store structure. An attribute that uniquely identifies an entity. It is sometimes referred to as a unique identifier or UID. A component of the attribute naming conventions. A Primeword describes the high-level concept associated with the attribute (e.g., Account, Party, Product). In the context of a logical data model, relationships describe the interaction between entities and are often a graphical representation of the business rules. The relationship on the diagram describes the optionality of the business rule (i.e., is there a mandatory relationship?) and the cardinality of the business rule (i.e., is it one or many?). For example, in a spousal relationship, at any given time, one person may be related to one other person in the role of spouse. Therefore, the cardinality of the relationship is 0 or 1. The relationship is optional; a person may or may not have a spouse. An area of interest to the enterprise, centered on a major resource, asset, product, or activity of the enterprise. A subject area is a logical grouping of related entities. Capitalization of the first letter of each word in the name of an entity, attribute name, and so on. For example: Customer Name, Customer Address.
Optionality
glossary.xls
Page 11 of 13
14.2. Publication
This document (in PDF format) is available for viewing and printing on CIBCs Intranet, CIBC Technology Standards site: http://w2.cibc.com/en/techops/tech/standards/Pages/default.aspx
1.3
Revised name of Data Management and Integration Management standard in Control Information section.
Page 12 of 13
Page 13 of 13
Word PACKAGE PAYMENT RATE PERCENT(AGE) PERFORMANCE PERSON PORTFOLIO PREFERENCE PRINCIPAL PRODUCT PROGRAM QUANTITY RECEIVE RECOMMEND/ RECOMMENDATION REPAYMENT REPORT/REPORTING REQUEST
Abbreviation PKG PYMT RT PCT PERF PERS PORTF PREF PRINCPL PROD PRGM QTY RCV RECMD REPYMT RPT REQST