OUM

CV.040 CONVERSION COMPONENT

DESIGNS
<Company Long Name>
<Subject>

Author:

<Author>

Creation Date:

November 22, 2010

Last Updated:

December 20, 2011

Document Ref:

<Document Reference Number>

Version:

DRAFT 1A

Approvals:
<Approver 1>
<Approver 2>

CV.040 Conversion Component Designs

Doc Ref: <Document Reference Number>

December 20, 2011

DOCUMENT CONTROL
1.1

Change Record
3

Date

Author

Version

Change Reference

22-Nov-10

<Author>

Draft 1a

No Previous Document

1.2

Reviewers

Name

<Subject>
File Ref: 257710207.doc

Position

Open and Closed Issues

(v. DRAFT 1A )

23 of 25

CV.040 Conversion Component Designs

Doc Ref: <Document Reference Number>

December 20, 2011

Contents

Document Control..................................................................................................... ii

1.1
1.2

Change Record........................................................................................................... ii
Reviewers.................................................................................................................... ii

Introduction............................................................................................................... 1

2.1
2.2

Purpose....................................................................................................................... 1
Practical Application.................................................................................................... 1

Processing Rules...................................................................................................... 2

3.1

Rules........................................................................................................................... 2

Translation Rules...................................................................................................... 3

4.1

Rules........................................................................................................................... 3

Filter Rules................................................................................................................. 4

5.1

Rules........................................................................................................................... 4

Foreign Key Rules..................................................................................................... 5

6.1

Rules........................................................................................................................... 5

Download Component Logic....................................................................................6

Temporary Table Creation Component Logic.........................................................7

Upload Component Logic......................................................................................... 8

10

Translation Component Logic..................................................................................9

11

Interface Component Logic....................................................................................10

12

Conversion Component Test Plan.........................................................................11

13

Conversion Data Integrity Test Plan......................................................................13

14

Data Acquisition Components...............................................................................16

14.1

Solution / Data Flow.................................................................................................. 16

<Subject>
File Ref: 257710207.doc

Open and Closed Issues

(v. DRAFT 1A )

23 of 25

CV.040 Conversion Component Designs

Doc Ref: <Document Reference Number>

December 20, 2011

15

<Data Flow 1> Process Technical Overview.........................................................17

15.1
15.2
15.3
15.4
15.5

Data Flow Diagram................................................................................................... 17

Data Flow / Mapping Matrix.......................................................................................17
Data Flow Assumptions............................................................................................. 17
Data Flow Prerequisites............................................................................................17
Frequency of Execution.............................................................................................18

16

<Mapping1> Specifications...................................................................................19

16.1
16.2
16.3
16.4
16.5
16.6
16.7
16.8
16.9
16.10
16.11

Mapping Assumptions...............................................................................................19
Mapping Prerequisites..............................................................................................19
Interface Input/Output Parameters............................................................................19
Exception Handling................................................................................................... 20
Pre-Processing Script...............................................................................................20
Post Processing Scripts............................................................................................ 20
Error Logs................................................................................................................. 21
Special Considerations.............................................................................................. 21
Data Requirements................................................................................................... 21
ETL Processing Details............................................................................................. 21
Unit Test Cases......................................................................................................... 22

17

Open and Closed Issues.........................................................................................23

17.1
17.2

Open Issues.............................................................................................................. 23
Closed Issues............................................................................................................ 23

<Subject>
File Ref: 257710207.doc

Open and Closed Issues

(v. DRAFT 1A )

23 of 25

Doc Ref:

INTRODUCTION
This Conversion Component Designs defines the key assumptions, mapping, rules, and logic that is
needed to create the Conversion Components as well as the process flows required for data
extraction, transport and transformation and load for <Company Short Name>. The actual code of
the components is not located in this document. Task CV.055 (Implement Conversion Components)
contains the actual code that is written to perform the conversion. However, this document is
intended to provide the developer with the necessary information for writing accurate conversion
components. Conversion component testing and data integrity testing procedures are also included
in this document.
Distribute the Conversion Component Design as follows:

to the developers who are responsible for writing the various pieces of conversion code

to the conversion team members

to the client member who is responsible for signing off on the accurateness of this
component design

to the overall project leader and the conversion team leader

Use the following criteria to check the quality of this work product:

2.1

Are all of the rules that impact conversion documented so that they can be written in the
conversion code?

Is the component logic required to write the conversion code documented?

Purpose

The purpose of this document is to document and communicate the data mapping and component
design specifications for the conversion of an individual entity that is going to be converted to the
Oracle applications, as well as to define an overall technical model for the solutions interfaces and
ETL processes. This includes high-level descriptions of the components of each ETL flow and data
constraints and test cases for each flow.

2.2 Practical
Application
The Conversion Component Designs is used by the project team as the basis for the design and
construction of the conversion and ETL components

Open and Closed Issues

File Ref: 257710207.doc

(v. )

23 of 25

Doc Ref:

PROCESSING RULES
Below is a table listing the processing rules that are to be used in the conversion of <Entity Being
Converted>.

Processing
Rule

Source Table.Field

Data Source

Data Size/Type

Target Table.Column

Data Size/Type

PR1
PR2
PR3

3.1

Rules

PR1: <Processing Rule 1>

PR2: <Processing Rule 2>
PR3: <Processing Rule 3>

Open and Closed Issues

File Ref: 257710207.doc

(v. )

23 of 25

Doc Ref:

TRANSLATION RULES
Below is a table listing the translation rules, which are to be used in the conversion of <Entity Being
Converted>.

Translation
Rule

Source Table.Field

Data Source

Data Size/ Type

Target Table.Column

Data Size/ Type

TR1
TR2
TR3

4.1

Rules

TR1: <Translation Rule 1>

TR2: <Translation Rule 2>
TR3: <Translation Rule 3>

Open and Closed Issues

File Ref: 257710207.doc

(v. )

23 of 25

Doc Ref:

FILTER RULES
Below is a table listing the filter rules that are to be used in the conversion of <Entity Being
Converted>.

Filter Rule

Source Table.Field

Data Source

Data Size/Type

Target Table.Column

Data Size/Type

FR1
FR2
FR3

5.1

Rules

FR1: <Filter Rule 1>

FR2: <Filter Rule 2>
FR3: <Filter Rule 3>

Open and Closed Issues

File Ref: 257710207.doc

(v. )

23 of 25

Doc Ref:

FOREIGN KEY RULES

Below is a table listing the foreign key rules that are to be used in the conversion of <Entity Being
Converted>.

Foreign Key Source Table.Field

Rule

Data Source

Data Size/Type

Target Table.Column

Data Size/Type

FKR1
FKR2
FKR3

6.1

Rules

FKR1: <Foreign Key Rule 1>

FKR2: <Foreign Key Rule 2>
FKR3: <Foreign Key Rule 3>

Open and Closed Issues

File Ref: 257710207.doc

(v. )

23 of 25

Doc Ref:

DOWNLOAD COMPONENT LOGIC

Open and Closed Issues

File Ref: 257710207.doc

(v. )

23 of 25

Doc Ref:

TEMPORARY TABLE CREATION COMPONENT LOGIC

Open and Closed Issues

File Ref: 257710207.doc

(v. )

23 of 25

Doc Ref:

UPLOAD COMPONENT LOGIC

Open and Closed Issues

File Ref: 257710207.doc

(v. )

23 of 25

Doc Ref:

10

TRANSLATION COMPONENT LOGIC

Open and Closed Issues

File Ref: 257710207.doc

(v. )

23 of 25

Doc Ref:

11

INTERFACE COMPONENT LOGIC

Open and Closed Issues

File Ref: 257710207.doc

(v. )

23 of 25

Doc Ref:

12

CONVERSION COMPONENT TEST PLAN

Below is a table listing the conversion components that need to be component tested:

Seq.

Process

Description

Test

Download Components

Component

Upload Components

Temporary Table Creation

Components

Translation Logic
Components

Interface Programs

Legacy system program to

create ASCII file
Upload script to a predefined
temporary interface table
Interface script to create
temporary information and
update table
Translation of legacy data
elements to Oracle column
requirements
Development of scripts to load
Oracle production tables and
perform data validation

Component
Component
Component
Component

Open and Closed Issues

File Ref: 257710207.doc

(v. )

23 of 25

Doc Ref:

Below are tables for recording the component test design for each conversion component.
An explanation of the Conversion Component Test Plan follows.

Component:
Component Purpose:
Tester:
Date:
Seq.

Action/Test Type

Expected Results

Actual Results

Failure Resolution

Open and Closed Issues

File Ref: 257710207.doc

(v. )

23 of 25

Doc Ref:

13

CONVERSION DATA INTEGRITY TEST PLAN

Below is a table recording the Data Integrity Test Plan. Each entity could have multiple tables to test
depending on the number of data elements that are going to be tested and the number of tables
populated by the entity in Oracle. A table for (later) recording the test results is also provided.
An explanation of the Conversion Data Integrity Test Plan follows:

Open and Closed Issues

File Ref: 257710207.doc

(v. )

23 of 25

Doc Ref:

Entity: <Entity Being Converted>

Table Name:
Test Purpose:
Tester:
Oracle Column

Datatyp Not
e
null?

Test Description: Legacy

Custom?

(Navigation Path/ Object

Name)

Test #

Test Description: Oracle

(Navigation Path/ Object
Name)

Order Number

Order Number

Order Number

________

_________

________

Legacy System

Oracle System

Legacy System

Oracle System

Legacy System

%
Custom Verified Test #
?

Notes

Oracle System

Test #:
Order #:
Failure?:
Resolution:

Open and Closed Issues

File Ref: 257710207.doc

(v. )

23 of 25

Doc Ref:

Test #:
Order #:
Failure?:
Resolution:

Open and Closed Issues

File Ref: 257710207.doc

(v. )

23 of 25

Doc Ref:

14

DATA ACQUISITION COMPONENTS

14.1 Solution / Data
Flow
Dataflow Name

Description

<Data Flow 1>

<Description of Data Flow>

This section contains a matrix listing all the Data Flows that comprise this DW solution.

Open and Closed Issues

File Ref: 257710207.doc

(v. )

23 of 25

Doc Ref:

15

<DATA FLOW 1> PROCESS TECHNICAL OVERVIEW

This portion of deliverable describes one by one each Data Flow in the solution.

15.1 Data Flow

Diagram
This High Level Summary shows the mappings involved in the Data Flow:

<Insert Sample Flow Diagram>

15.2 Data Flow /

Mapping Matrix
The following matrix lists all the mappings that comprise this data flow:

No.

Mapping Name

Description

ETL Technology

Prerequisite
Mapping(s)

<Mapping 1>

<Description of
mapping>

<OWB/ PL/SQL /
Others>

<Flow Name /
Mapping No.>

2
3

15.3 Data Flow

Assumptions
The development specifications for <Flow Name> assume the following:

1. <Assumption1>
2. <Assumption2>
3. <Assumption3>

Open and Closed Issues

File Ref: 257710207.doc

(v. )

23 of 25

Doc Ref:

15.4 Data Flow

Prerequisites
The <Data Flow> load process requires that the following environment setups and process
executions have been completed for appropriate results from the ETL execution.

1. This load process assumes that the following of process have been executed
and sources tables have been populated,

<Process1>

<Process2>

15.5 Frequency of
Execution
This Data Flow should be executed on a <period> basis. It should only be executed once the <system
event> process has completed successfully.

Open and Closed Issues

File Ref: 257710207.doc

(v. )

23 of 25

Doc Ref:

16

<MAPPING1> SPECIFICATIONS

1. Review and select boilerplate for this section from the associated Task and
Deliverable Guideline document. Be careful to review task and deliverable
completion information carefully and select boilerplate content (text, diagrams,
illustrations, etc.) only if it applies to your specific client site. Also, be sure to add
any client specific details or information to make this section complete.

This portion of deliverable describes in detail each mapping within each data flow. Where a mapping
is reused by many data flows it only needs to be described once.

16.1 Mapping
Assumptions
The development specifications for <Mapping1> assume the following:

2. <Assumption1>
3. <Assumption2>
4. <Assumption3>

16.2 Mapping
Prerequisites
The <Mapping1> ETL process requires that the following environment setups and process executions
have been completed for appropriate results from the ETL execution.

1. This ETL process assumes that the following of process have been executed and
sources tables have been populated,

<Process1>

<Process2>

Open and Closed Issues

File Ref: 257710207.doc

(v. )

23 of 25

Doc Ref:

16.3 Interface
Input/Output
Parameters
<Mapping1> would require the following set of parameters. The ETL process must accept these input
parameters and should be able to pass the output parameters back to ensure proper functioning of
the complete ETL system.

Parameter Name

Type (Input/Output)

Comments

P_start_date

Input

P_xxxxxx

Xxxxxxxxxxxx

Specifies the start date of

processing.
Xxxxxxxxxxxx

16.4 Exception
Handling
The following exceptions are to be handled in this mapping:

<Exception1>

16.5 Pre-Processing
Script
The <Mapping1> process for should call the following set of procedures / functions at the beginning of
the mapping process.

Pre-Map Process Name

Expected Return Parameters

Processing Comments

<Process/Procedure/Function
Name>

Return Parameters

Text description

Open and Closed Issues

File Ref: 257710207.doc

(v. )

23 of 25

Doc Ref:

16.6 Post Processing

Scripts
The <Mapping1> process should call the following set of procedures / functions before the mapping
process ends.

Post-Map Process Name

Expected Return Parameters

Processing Comments

<Process/Procedure/Function
Name>

Return Parameters

Text description

16.7 Error Logs

The following set of error logs will be generated:

Steps for Error Logs generation

Step 1:

Step 2:

16.8 Special
Considerations
<List special design considerations here>

16.9 Data
Requirements
16.9.1

SUMMARY OF OBJECTS USED IN THIS MAPPING

The table below summarizes the objects used for the <Mapping1> process:

Object Name

Object Type

Role in the Mapping

(Source / Staging /
Target)

Location

Access
Information

<Object Name>

<Table/File>

<Source / Staging /
Target>

<Database / File
System / Other

<Gateway / DB
Links / Schema /

Open and Closed Issues

File Ref: 257710207.doc

(v. )

23 of 25

Doc Ref:

Object Name

Object Type

Role in the Mapping

(Source / Staging /
Target)

Location

Access
Information

Information>

User
Information>

16.10ETL Processing
Details
This section provides the ETL process details.

Pseudo Code for execution sequence

Step 1:

Step 2:

16.11Unit Test Cases

Test Case ID
1

Test Case Name

Description
<Functionality to be test and testing method>

Open and Closed Issues

File Ref: 257710207.doc

(v. )

23 of 25

Doc Ref:

17

OPEN AND CLOSED ISSUES

17.1 Open Issues

ID

Issue

Resolution

Responsibility

Target Date

Impact Date

Responsibility

Target Date

Impact Date

17.2 Closed Issues

ID

Issue

Resolution

Open and Closed Issues

File Ref: 257710207.doc

(v. )

23 of 25