You are on page 1of 16

OUM

DS.140 DESIGN SPECIFICATION


<Company Long Name>
<Subject>

Author:

<Author>

Creation Date:

May 7, 2014

Last Updated:

May 7, 2014

Document Ref:

<Document Reference Number>

Version:

DRAFT 1A

Approvals:

<Approver 1>
<Approver 2>

DS.140 Design Specification

Doc Ref: <Document Reference Number>


May 7, 2014

Document Control

1.1

Change Record
5

1.2

Date

Author

Version

Change Reference

7-May-14

<Author>

Draft 1a

No Previous Document

Reviewers

Name

<Subject>
File Ref: 328719776

Position

Document Control
(v. DRAFT 1A )

1216132

DS.140 Design Specification

Doc Ref: <Document Reference Number>


May 7, 2014

Contents

Document Control.................................................................................................... iii

1.1
1.2

Change Record........................................................................................................... iii


Reviewers................................................................................................................... iii

Technical Overview................................................................................................... 1

2.1
2.2

Building Blocks............................................................................................................ 1
Block Relationship Diagram........................................................................................ 1

<Screen Title> - Screen Design................................................................................3

3.1

Navigation Logic.......................................................................................................... 3

<Report Name> - Report Design..............................................................................4

Data Design............................................................................................................... 5

5.1
5.2
5.3

Data Design Table....................................................................................................... 5


Data Sources.............................................................................................................. 5
Validation Logic........................................................................................................... 6

SQL Design................................................................................................................ 7

6.1
6.2

SQL Statements.......................................................................................................... 7
Performance Considerations.......................................................................................7

Behavior Design........................................................................................................ 8

7.1
7.2

Function (Operation) Design.......................................................................................8


Business Rule Design................................................................................................. 8

Interface Design........................................................................................................ 9

8.1
8.2
8.3

Service Design............................................................................................................ 9
External Interface Design............................................................................................ 9
Performance Considerations.....................................................................................10

Quality of Service Design Considerations............................................................11

9.1
9.2
9.3
9.4

Restart Strategy........................................................................................................ 11
Crash Recovery......................................................................................................... 11
Security..................................................................................................................... 11
Performance.............................................................................................................. 11

10

Database Design..................................................................................................... 12

10.1

Database Diagram.................................................................................................... 12

<Subject>
File Ref: 328719776

Document Control
(v. DRAFT 1A )

1316133

DS.140 Design Specification

Doc Ref: <Document Reference Number>


May 7, 2014

10.2
10.3
10.4

Desired Table Changes............................................................................................. 12


Tables, Indexes, Sequences.....................................................................................12
Archiving................................................................................................................... 12

11

Installation Considerations....................................................................................13

12

Open and Closed Issues.........................................................................................14

12.1
12.2

Open Issues.............................................................................................................. 14
Closed Issues............................................................................................................ 14

<Subject>
File Ref: 328719776

Document Control
(v. DRAFT 1A )

1416134

DS.140 Design Specification

Technical Overview

This Design Specification documents the detailed design for <Component Name> that is part of <Use Case Package
Name/Number>. This specification, the design specifications for the other components that are part of this use-case
package (package), along with the Analysis Specification for the package constitute the complete detailed design for this
use case package.

2.1

Building Blocks

Building Blocks

2.2

Block Relationship Diagram

The diagram below represents the base tables of each block or zone of the form (vertical) and tables referenced for
validation or lookups (horizontal).

External
System
<system
name>
Draw
Human
actor here

COMPONENT
<THIS
COMPONENT>

Other
Component
<component
Name>

<Subject>
File Ref: 328719776

External
System
<system
name>

Document Control
(v. DRAFT 1A )

1116131

DS.140 Design Specification

<Screen Title> - Screen Design

Use Case 1

Screen Design A

Screen Design B

Screen Design C

Screen Design D

Use Case 2

3.1

Navigation Logic

Use Case 1
Scenario 1.
Screen A
Screen B
Screen C
Scenario 2.
Screen D
Screen E
Screen F
Use Case 2
Scenario 1.
Screen A
Screen D
Screen E
Scenario 2.
Screen A
Screen C
Screen G

<Subject>
File Ref: 328719776

Document Control
(v. DRAFT 1A )

1216132

DS.140 Design Specification

<Report Name> - Report Design

Use Case 1

Report A

Report B

Report C

Report D

Use Case 2

<Subject>
File Ref: 328719776

Document Control
(v. DRAFT 1A )

1316133

DS.140 Design Specification

Data Design

5.1

Data Design Table

Entity (Class)

Attribute (Data
Field)

Format

Length

Accessibility

Validation Rules

Required?

Person

Name

Alphanume
ric

25

All

Must exist in HR
Database

Yes

5.2

Data Sources

Table

Column

Source Value

<table name>

<column name

<table>.<column>

<column 2>

'Literal string'

<column 3>

(Description of derived value)

5.3

Validation Logic

5.3.1

Table Name

Attribute Name

Validation logic

Warning Conditions

Error Conditions

Attribute 1
Attribute 2

<Subject>
File Ref: 328719776

Document Control
(v. DRAFT 1A )

1416134

DS.140 Design Specification

SQL Design

6.1

SQL Statements

Use Case Scenario 1 - Data Selection

SELECT
<data>
FROM <tables>
WHERE <select criteria>
AND
<join conditions>

Use Case Scenario 1 - Data Deletion

DELETE
<data>
FROM <table>

6.2

Performance Considerations

<Subject>
File Ref: 328719776

Document Control
(v. DRAFT 1A )

1516135

DS.140 Design Specification

Behavior Design

7.1

Function (Operation) Design

Function (operation)
Name

Arguments

Default Values

Return Values

Pseudo code

Comments

Person:ComputePay

HoursWorked,
PayRate

Hours worked
=40

GrossPay

GrossPay =
HoursWorked * PayRate

Only Used for


Exempt Employees

7.2

Business Rule Design

<Subject>
File Ref: 328719776

Document Control
(v. DRAFT 1A )

1616136

DS.140 Design Specification

Interface Design

<Overview description>

8.1

Service Design

<Use Case1 name/number>


<Service Name> is published for this component with the following arguments:
Argument

Prompt

Value Set

Default Value

ORG_ID
USER_ID
DATE

Organization id
Application User ID
Selection Date

Generic
Generic
FND_Date4_required

:$PROFILE$.mfg_organization_id
:$PROFILE$.user_id
:$$DATE$$

<Use Case2 name/number>


<Service Name> is published for this component with the following arguments:
Argument

Prompt

Value Set

Default Value

ORG_ID
USER_ID
DATE

Organization id
Application User ID
Selection Date

Generic
Generic
FND_Date4_required

:$PROFILE$.mfg_organization_id
:$PROFILE$.user_id
:$$DATE$$

8.2

External Interface Design

<Use Case1 name/number>


<Message Name> is sent or received by this component with the following arguments:
Argument

Prompt

Value Set

Default Value

ORG_ID
USER_ID
DATE

Organization id
Application User ID
Selection Date

Generic
Generic
FND_Date4_required

:$PROFILE$.mfg_organization_id
:$PROFILE$.user_id
:$$DATE$$

<Use Case2 name/number>


<Message Name> is sent or received by this component with the following arguments:
Argument

Prompt

Value Set

Default Value

ORG_ID
USER_ID

Organization id
Application User ID

Generic
Generic

:$PROFILE$.mfg_organization_id
:$PROFILE$.user_id

<Subject>
File Ref: 328719776

Document Control
(v. DRAFT 1A )

1716137

DS.140 Design Specification

Argument

Prompt

Value Set

Default Value

DATE

Selection Date

FND_Date4_required

:$$DATE$$

8.3

Performance Considerations

<Subject>
File Ref: 328719776

Document Control
(v. DRAFT 1A )

1816138

DS.140 Design Specification

Quality of Service Design Considerations

Based on the requirements stated in the Supplemental Requirements (RD.055)

9.1

9.2

9.3

9.4

Restart Strategy

Strategy Consideration 1

Strategy Consideration 2

Crash Recovery

Strategy Consideration 1

Strategy Consideration 2

Strategy Consideration 1

Strategy Consideration 2

Security

Performance

<Subject>
File Ref: 328719776

Strategy Consideration 1

Strategy Consideration 2

Document Control
(v. DRAFT 1A )

1916139

DS.140 Design Specification

10

Database Design

This section summarizes new and/or changing database objects and data required to support <Component Name>.
However, the complete database design is documented in the Develop Database Design work product.

10.1 Database Diagram

10.2 Desired Table Changes

10.3 Tables, Indexes, Sequences

10.4 Archiving

<Subject>
File Ref: 328719776

Document Control
(v. DRAFT 1A )

110161310

DS.140 Design Specification

11

Installation Considerations

Installation scripts must be prepared to perform the following actions in an automated way:
1. Create new tables.
2. Insert seed data into <App Prefix>_LOOKUPS as described above.
3. Run grant/synonym script.
4. Define Value Sets and Validation Tables.
5. Define Descriptive Flexfields.
6. Define Help text.
7. Define Message text.
8. Register Forms.
9. Register Concurrent Programs.
10. Register Standard Report Submission parameters.
11. Create Menus.

<Subject>
File Ref: 328719776

Document Control
(v. DRAFT 1A )

111161311

DS.140 Design Specification

12

Open and Closed Issues

12.1 Open Issues

ID

Issue

Resolution

Responsibility

Target Date

Impact Date

Resolution

Responsibility

Target Date

Impact Date

12.2 Closed Issues

ID

Issue

<Subject>
File Ref: 328719776

Document Control
(v. DRAFT 1A )

112161312