TDD Template

TD.01 - TECHNICAL DESIGN DOCUMENT FOR MODULE INITIALS(XXX) – GAP ID (000) - DESCRIPTION

<<CLIENT NAME>> <<LOGO>>

Author:Deliverable Name:Project Plan Completion Date:Date Provided to Rutgers UniversityDate Feedback due to Oracle:

*This deliverable is certified by Oracle that it is complete and meets the deliverable guidelines.

Approvals:

Document Control

Change Record

1

Date Author Version

Change Reference

DD-MMM-YY <Author> Draft 1a

No Previous Document

Reviewers

Name Position

Distribution

Copy No.

Name Location

1 <iProject Workspace Name>234

DOCUMENT CONTROL..................................................................................................................................2

BACKGROUND.............................................................................................................................................5

ASSUMPTIONS.............................................................................................................................................5

TECHNICAL DEPENDENCIES..................................................................................................................5

RELATED DOCUMENTS............................................................................................................................5

REQUIREMENT SOURCE................................................................................................................................5OTHER DOCUMENTS.....................................................................................................................................5GENERAL INFO.............................................................................................................................................6

IMPACT ANALYSIS.....................................................................................................................................6

OTHER PEOPLESOFT PRODUCTS IMPACTED.................................................................................................6COMMON COMPONENT IMPACT...................................................................................................................6DATA MODEL IMPACTS................................................................................................................................6

TECHNICAL DESIGN..................................................................................................................................7

DESIGN OVERVIEW......................................................................................................................................7ERD DIAGRAM............................................................................................................................................7

PEOPLESOFT OBJECTS............................................................................................................................7

PROJECTS......................................................................................................................................................7FIELDS - NEW...............................................................................................................................................7FIELDS - RENAME.........................................................................................................................................7TRANSLATE VALUES....................................................................................................................................7TABLES - NEW/MODIFY...............................................................................................................................7TABLES - RENAME/DELETE..........................................................................................................................8VIEWS - NEW/MODIFY/RENAME/DELETE....................................................................................................8RECORD RELATIONSHIP DESCRIPTIONS (RRDS)- NEW...............................................................................8PAGE.............................................................................................................................................................8COMPONENT.................................................................................................................................................9PEOPLECODE................................................................................................................................................9MENU...........................................................................................................................................................9FOLDERS.......................................................................................................................................................9FILE LAYOUTS..............................................................................................................................................9COMPONENT INTERFACES..........................................................................................................................10

Frequency, Timing & Volume of data...................................................................................................10

DATA MAPPING.........................................................................................................................................10

MAPPING....................................................................................................................................................10Application Field Value Mappings.......................................................................................................10Technical Field Mapping......................................................................................................................12Exception Processing............................................................................................................................13Error Correction Processes..................................................................................................................13

APPLICATION ENGINE PROGRAM...............................................................................................................13Comments / Purpose.............................................................................................................................13Program Properties..............................................................................................................................13Section...................................................................................................................................................13Step........................................................................................................................................................13Action....................................................................................................................................................14SQL Objects..........................................................................................................................................14Notification...........................................................................................................................................14

EXTERNAL PROGRAM ADDITIONS/CHANGES.............................................................................................14Comments / Purpose.............................................................................................................................14

EXTERNAL PROGRAM SPECIFICATIONS.........................................................................................14

QUERY DESIGN..........................................................................................................................................14QUERY ATTRIBUTES...................................................................................................................................14TREE DESIGN..............................................................................................................................................15

TREE NODES...............................................................................................................................................15

BATCH PROCESSING...............................................................................................................................16

BATCH PROCESSES SUMMARY...................................................................................................................16BATCH PROCESSING DETAILS....................................................................................................................16

APP CLASSES..............................................................................................................................................16

OBJECT MODEL..........................................................................................................................................16CLASS DESCRIPTIONS.................................................................................................................................16

PROGRAMS.................................................................................................................................................17

PRIORITY (INCASE OF PROCESS / REPORT)....................................................................................17

MESSAGE CATALOG...............................................................................................................................17

SECURITY...................................................................................................................................................17

ROLES.........................................................................................................................................................17PERMISSION LISTS......................................................................................................................................17ROLE-PERMISSION LIST.............................................................................................................................17

PERFORMANCE CONSIDERATIONS...................................................................................................18

CONTROLS AND AUDIT TRAIL............................................................................................................18

RECOVERY / RESTART AND TROUBLESHOOTING.......................................................................................18

UNIT TEST PLAN.......................................................................................................................................18

GLOSSARY..................................................................................................................................................18

APPENDIX A: PAGE..................................................................................................................................18

APPENDIX B: PEOPLECODE..................................................................................................................18

APPENDIX C: SQL.....................................................................................................................................18

APPENDIX D: APPENGINE......................................................................................................................19

APPENDIX E: UNIX SCRIPT....................................................................................................................19

OPEN AND CLOSED ISSUES FOR THIS DELIVERABLE.................................................................20

Open Issues...........................................................................................................................................20Closed Issues.........................................................................................................................................20

BackgroundThe Technical Design Document (TDD) describes technical details of the design. It builds upon the design described in the corresponding FDD. It should be viewed as a technical supplement to the FDD describing how the feature will technically be implemented. Information contained in the FDD should not be repeated or duplicated in the TDD.

The goal of producing a TDD is to help developer’s plan and layout the technical architecture for their feature and capture information that will be helpful to others during a technical review. The goal is not to document technical details after the fact on what was implemented. If written upfront, it encourages developers to think through the entire process before they start coding. It also provides an inventory of the objects that will need to be built/changed, which should help in estimating the development effort.

AssumptionsList any assumptions made in this technical design document. Include any other TDDs that this TDD is dependent on.

Technical DependenciesList any PeopleTools features not yet completed that this technical design is dependent on. Also include any other TDDs or other technologies this TDD is dependent on.

Related Documents

Requirement Source

Itemize any other reference documents, including the name of the document and its location that were used

Name of FDD and the details of the reference documents

Other Documents

List any other related documents that can help in the understanding of this feature

If yes, specify the folder name and path

General Info

Developer Name: <Developer’s Name>

Development Approach

<Programming Approach>

Type <Interface/Conversion/Report/Process/Customization/Enhancements>

Platform <People Tools Version>

Related Vendor Package

<In case of an interface only , List Vendor Package name>

Functional Spec Reference

<Functional Specification Document>

Database Platform <Database>

Existing Report(Y/N) <Incase of SQR / nVision/ Crystal reports only>

Report Owner <Incase of SQR / nVision/ Crystal reports only , Enter Role/User >

Report Distribution <Incase of SQR / nVision/ Crystal reports only , to the person who has access to execute the report>

Report Security <Incase of SQR / nVision/ Crystal reports only , Enter Security>

Approximate Size (# of Pages)

<Incase of PS/nVision reports ,No. of Pages>

Impact Analysis

Other PeopleSoft Products Impacted

As a result of the technical design, describe how any other products will be impacted beyond what is already described in the FDD.

Common Component Impact

As a result of the technical design, describe any impact to utilities like the currency conversion utility, or other Common Components.

Data Model Impacts

Describe any downstream impacts these data model changes will have on existing on-line pages, reports and integrations. Describe what objects will need to be changed as a result of the data model changes.

Technical Design

Design Overview

Describe the design and include a Process Flow, Data Flow, and/or State Diagrams as appropriate.

ERD Diagram

Include a high level ERD diagram of the tables involved in this design.

PeopleSoft Objects

Projects

List any projects that will need to be created/modified.

Project Name Description Action (N/M/D) Comments

Fields - New

List any new fields that will need to be created

Field Name Type Length Short Name Long Name

Fields - Rename

List any fields that will need to be renamed. Renamed fields will be needed for the upgrade data conversion maps.

Old Field Name New Field Name Type Length Short Name

Long Name

Translate Values

List any translate values that will need to be added/modified.

FieldAction (N,M,D) EFFDT

Status (A/I) Value Long Name Short Name

Tables - New/Modify

List any tables that will need to be created and/or modified. Indicated if the table is high volume (i.e. tables that for a very large customer could have more than 100,000 rows in them). Indicated if the table needs a related language table.

Table Name Description New/Modify High Volume

Related Language

Y/N Y/N

Tables - Rename/Delete

List any tables that will need to be renamed or deleted. Renamed tables will be needed for the upgrade data conversion maps.

Current Table Name Description Rename/Delete New Table Name

Views - New/Modify/Rename/Delete

List any views that will need to be created, modified, renamed or deleted.

View Name Description New/Modify/Rename/Delete

New View Name

Record Relationship Descriptions (RRDs)- New

List any new RRDs that will need to be built.

Table Name 1 Table Name 2 Relationship Type

Page

For the component, using the table below, identify the pages that need to be added and modified. Delete any of the tables below that have no entries.

Action (N,M,D) Page Name Page Description Description of Modification

For the Page, using the table below, identify the records and record fields need to be added and modified

Page Name Record Record Field Record Field Properties

Insert a Page screenshot in Appendix-A.

Component

For each component that needs to be create/modified, replicate the following section and describe the component and pages that comprise it.

Component Name: Enter component name here

Market: Enter market here

Portal/Registry Name: Employee

Navigation Path: Plan Salaries > Report > Employee with Merit Should be in FDD.

Permission Lists: Enter the permission list(s) that should be associated with this component

Actions allowed: Add, Update/Display, Update/Display All, Correction

Component Type: PIA transaction or Portal Pagelet

Search Record: Enter search record name here

Add Search Record: Enter search record name that will be used on add here

PeopleCode

For the component/Record and/or page, list the PeopleCode that will need to be created/modified.

FieldComponent/Page/record

Action (N, M, D)Event Description of Modification

No PeopleCode will be physically deleted. They need to be commented out.

Menu

List any Menus that will need to be created/modified.

Action (N,M,D) Menu Name Bar Name Item Name Description of Modification

Folders

Folder Name Description Action(N,M,D) Parent Folder Comments

File Layouts

File Layout Name Description Action (N,M,D)

Based on Table

Comments

Refer to Data Mapping Section for details about file layout field mapping

Component Interfaces

List any components that you are adding/modifying that need a Component Interface built for them.

Component Interface Name

Description Selected Component

Comments/Purpose

Frequency, Timing & Volume of dataMention the frequency and timing of the Inbound and Outbound interface.

Volume of data is considered only for inbound interface

Data Mapping

Mapping

Source Target Observations

File/Table ColumnData type File/Table Column

Data type

(Auto generated? Derived from work record?)

Application Field Value Mappings <Provide a mapping between source layout and the target online application. Include a set of screens numbered sequentially/named, and label each of the fields to be mapped. >

<Field Name>

Source value(s)

Target value(s)

Logic

<Field Name>

Source value(s)

Target value(s)

Logic

Technical Field MappingBased on the Application field mapping, provide technical record/field mapping

Record: Description: Component Interface: Issues:

CI Field Name Field Description Type Len Key Req ValueSource System

Source Record

Source Field Logic

Exception Processing

Error Correction ProcessesDescribe technical and functional error correction procedures including reports that are used to maintain or debug interface exceptions.

# Exception or Error Condition Action to be Taken Number

Describe the Error Describe what should occur in the event of the error. If an error message should appear, include the specific error message text.

Application Engine Program

Application Designer – File – Open – App Engine Program – [App Engine Program Name]

Comments / PurposeComments

Program PropertiesProgram Name Attachment Reference

Comments

Description

State Records Temp Tables

Application Engine Program[] Disable Restart [] Application Library [] Upgrade Only

Message Set Number:Code / Changes

SectionSection Effective Date Effective

StatusAuto Commit Access

Description

StepStep Commit After Frequency On Error Active

Description

ActionAction Type Characteristics

Description

Code / Changes

SQL Objects SQL Name Description Action(N,M,

D)High Volume

Related Language

NotificationDescribe notifications required. For each notification, describe the events that trigger it, the routing logic and notification template to use.

External Program Additions/Changes

Comments / PurposeComments

External Program SpecificationsProgram Name Program Description Attachment

Reference

[] SQR [ ] COBOL [ ] nVision [ ] Crystal [ ] Other

Code / Changes

Query Design

(If required - copy this section for multiple queries)

Query Attributes

Query Name Query Description Public/Private Query Type Distinct Comments /

Purpose[] Query

[] Role Query

[] Database Agent Query

Record Field Name Aggregate? Criteria

<If joining tables provide join details in criteria column>

Tree Design

(If required - copy this section for multiple Trees)Tree Name

Chart Field

Setid

Effective Date

Status

Category

Structure Id

Use of Levels

All Details Values in Trees

Allow Duplicate Values

Comments

Tree Nodes

Parent Node Node Name Detail Item Or Dynamic Range

From To


From To


From To

Batch Processing

Batch Processes Summary

List any batch processes that will need to be written and/or modified.

Batch Program Name Description New/Modify Technology (AE, SQR or COBOL)

Batch Processing Details

For each new/changed batch process, describe what needs to happen in the batch process. For new batch programs, explain the reasoning behind why this process should be performed in batch, given our goal of enabling the real-time enterprise and reducing the latency of when information is updated in our systems. Include the following items in your description of the batch process:

the high level processing logic

the selection criteria/run control that should be used to initiate each batch process.

the approach to be used for parallel processing

the restart capabilities

how the number of objects in a database unit of work can be customer configured

how it is initiated (scheduled, upon request, recurrent, triggered by workflow, etc.)

the Process Scheduler requirements

Report Logic

For each new/Changed SQR or COBOL, List the abstract logic of code.

App Classes

Object Model

If necessary, provide a UML diagram of the App Classes you plan to build.

Class Descriptions

For each class that needs to be create/modified, replicate the following table and specify details on the class. Also describe any methods being modified or removed.

Package Name: Specify package name hereClass Name: Specify class name here

Method Parameters Returns Description

ProgramsPeopleCode: Refer Appendix BSQL : Refer Appendix CAE Program: Refer Appendix DUNIX Script: Refer Appendix E

Priority (Incase of process / Report)

Mandatory Critical High Medium Low

Message CatalogNew Warnings/Error are created for Work unit (Conversion/Interface)

Message Set No.

Msg. No.

Severity Message text Explanation

Security

Roles

List any new roles that need to be setup

Roles

Permission Lists

List any new permission lists that need to be setup

Permission Lists

Role-Permission List

List any Role-Permission List associations that will need to be setup.

Role Name Permission Lists

Performance Considerations(Address any performance considerations listed in the corresponding Functional Design Document. Also, list any technical performance considerations. For example:

Any indexes that are needed for SQL processing The design will accommodate up to 1000 users in the page at one time The process needs to run on Tuesday night prior to process XYZ. Describe the risks for data growth on the records included in the design)

Controls and Audit Trail (Describe audit reports\logs\controls here and formats where applicable.)

Details of errors encountered during the <work unit> (Conversion/Interface) run will be reported in the message log.

Recovery / Restart and Troubleshooting

(Describe any restart functionality/troubleshooting here.)

For Example: “Troubleshooting has to be done manually based on the message displayed in the Message log.”

Unit Test Plan Identify the unit test requirements, test cases and the data necessary to execute them.

Unit Test Case

Test Condition Required Data

Expected Results

Glossary<List any new terms, terms that the average reader would not be familiar with and acronyms used in this document and what they mean>

Appendix A: PageInsert screenshot of Page here. Developer is responsible to add screenshot of Page in this section.

Appendix B: PeopleCodeInsert PeopleCode text here. Developer is responsible to add peoplecode text in this section.

Appendix C: SQLInsert SQL text here. Developer is responsible to add SQL text in this section.

Appendix D: AppEngineInsert AE text here. Developer is responsible to add AppEngine program text in this section.

Appendix E: Unix ScriptInsert Shell Script here. Developer is responsible to add UNIX Script in this section.

Open and Closed Issues for this Deliverable

Open Issues

ID Issue Resolution Responsibility Target Date Impact Date

Closed Issues

ID Issue Resolution Responsibility Target Date Impact Date