Global Services

Detailed Design Specification

Project name : Train Information Report

Generation

Application name: Reporting

Project number : N/A

Customer : IRL

Version: 1.0
Date: 6/Jul/2011
Status: Final Version

Copyright Notice
Copyright  2023 IBM Global Services. All rights reserved.
Train Information Report Generation System Detailed Design Specification
Project Control Book

For more information

IBM contact Customer contact

Venukrishnan Unnikrishnan Joydeep Banerjee

Project Manager Project Manager

About this document

 Produced using Microsoft Word Version <enter version>
 Filename: Detailed Design Specification V1.0.doc<enter file location or version control tool
here>IIGA
 Template Version: 1.0

Revision History:

Version Date Author Change Description

0.1 05/07/11 Amala S Krishnaveni Initial Draft

0.2 02/07/13 Jignesh Rawal Case Study(changes made)

1 02/07/13 Jignesh Rawal Final

Approvals:
This document requires the following signed approvals:

Name Title Signature

Joydeep Banerjee Customer, Project Manager Joydeep Banerjee

Venukrishnan Unnikrish- IBM India, Project Manager Venukrishnan Unnikrishnan

nan

Amala S Krishnaveni IBM India, IT Architect Amala S Krishnaveni

Distribution:

Version: 1.0 Last Saved: 1/19/2023 Page: 2 of 13

Train Information Report Generation System Detailed Design Specification
Project Control Book

This document has been distributed to:

Name Title

Joydeep Banerjee Customer, Project Manager

Venukrishnan Unnikrish- IBM India, Project Manager

nan

Amala S Krishnaveni IBM India, IT Architect

Version: 1.0 Last Saved: 1/19/2023 Page: 3 of 13

Train Information Report Generation System Detailed Design Specification
Project Control Book

Table of Contents
1Introduction................................................................................................................................................ 4
1.1Architectural Overview........................................................................................................................ 4
1.2Data Flow Diagram (DFD) – Application Model..................................................................................5
1.3Deployment Unit Model....................................................................................................................... 8
We have following two deployment unit as part of the deployment..........................................................8
Application module: It contain VSAM File loading JCL and report program. This both consider as sin-
gle program module to deploy................................................................................................................. 8
1.4Architecture Decisions........................................................................................................................ 8
1.5Coding Guidelines............................................................................................................................... 8
1.6Appendix B – DDS Verification Checklist............................................................................................ 9

Table of Figures

2 Introduction
This document establishes the Reporting low-level or detailed system design for the Train Information Re-
port Generation System project.

Train Information Report Generation System that proposes to act as a generation system of the detailed
train Information. The key theme of the application is to bring all the train schedule together and all infor -
mation in a core place which will help the consumer.

.This section documents the architecture of the Report Component for the Train Information Report Gen-
eration System project.

2.1 Architectural Overview

Version: 1.0 Last Saved: 1/19/2023 Page: 4 of 13

Train Information Report Generation System Detailed Design Specification
Project Control Book

Creation of Transaction File 1 and File 2

Load the data from File 1 to VSAM File

Read Trans2 file and based on the key ,

Read VSAM File

Create Detailed Report of Train schedule

2.2 Data Flow Diagram (DFD) – Application Model

 VSAM Master file name should be “TRNG320.VSAM.KSDS99”.

 The record length of Master VSAM file is 100.
 TRAIN-NUMBER is the primary Key.
 Load the sequential file (Transaction File 1) into the Master VSAM file using JCL. The filename
should be “TRNG320.INPUT1.SEQFILE”.
 Another sequential file 2 “TRNG320.INPUT2.SEQFILE” for reading the input.
 All data should be used as provided in the below record layout.
Master VSAM File Record Layout :-

Field Type
TRAIN-NUMBER
 9(6).
TRAIN-NAME
X(20).
TRAIN-TYPE X(01).

Version: 1.0 Last Saved: 1/19/2023 Page: 5 of 13

 Train Information Report Generation System Detailed Design Specification
Project Control Book

TRAIN-DEP-STN
X(10).
TRAIN-DEP-TIME
X(05).
TRAIN-ARR-STN
 X(10).
TRAIN-ARR-TIME
X(05).
TRAIN-CURR-DATE
X(10).
TRAIN-FARE
X(10)
TRAIN-DEP-LATE
X(03).
TRAIN-ARR-LATE X(03).

Transaction File1 Record Layout :-

Record 1 Value Record 2 Value Record 3 Value Record 4 Value
Field Type
TRAIN-NUMBER 123456 223456 523456 723456
 9(6). (Use this as
Primary key)
TRAIN-TYPE S S M M
X(01).
TRAIN-NAME MYSORE EX- CHENNAI EX- BANGALORE MYSORE MAIL
PRESS PRESS MAIL
X(20).
TRAIN-DEP-STN MYSORE CHENNAI BANGALORE MYSORE
X(10).
TRAIN-DEP-TIME 18 :30 18 :30 18 :30 12 :30
X(05).
TRAIN-ARR-STN CHENNAI MYSORE MYSORE BANGALORE
 X(10). Alt Key
TRAIN-ARR-TIME 04 :30 04 :30 20 :30 16 :30
X(05).
TRAIN-FARE 400 400 120 120
X(10)

Version: 1.0 Last Saved: 1/19/2023 Page: 6 of 13

Train Information Report Generation System Detailed Design Specification
Project Control Book

Transaction File2 Record Layout:-

Record Record Record Record Record Record Record
1 2 3 4 5 6 7
Field Type Value Value Value Value Value Value Value
TRAIN-NUMBER 123456 223456 323456 423456 523456 623456 523456

 9(6)

Output Report Layout :-

 The length of each field should be same as the input file mentioned above with appropriate fillers in
between.

 Any value other then mentioned in the file format, will be considered as corrupted and will required to
be discarded.

 Get System date and time and display in the output report

 Read the data one by one from the Transaction File 2 and check if the train number is existing in the
VSAM file . If existing display the values as shown in Output Report Layout. Else display the message
as “RECORD NOT FOUND” as shown in Output Report Layout.

 Check for file status code after OPEN,each READ and CLOSE..

Version: 1.0 Last Saved: 1/19/2023 Page: 7 of 13

Train Information Report Generation System Detailed Design Specification
Project Control Book

2.3 Deployment Unit Model

We have following two deployment unit as part of the deployment

 Application module: It contain VSAM File loading JCL and report program. This both consider
as single program module to deploy.

 Database Module: NA

2.4 Architecture Decisions

Architecture Decision Number About Architecture Decision

Decision
Numbers
ARC 001 VSAM File VSAM and Seq file will be used as file access method to store
the data and access.
ARC 002 Reports Generation We will use the COBOL program to generate the reports
Technology
ARC 005 Data Interface We don’t have any requirement to pull the data from external
system. We should use local file for process.

2.5 Coding Guidelines

The purpose of this section is to document the coding guidelines for the project. The coding guidelines
are located in the project’s PCB in Section 7.9, document name Coding Guidelines.

TITLE: Train Information Report Generation System.

OBJECTIVE: To retrive a report of trains from a master file according to the train information given in an
input file.
REQUIREMENTS:
1) Create 2 input sequential files and load the data as specified.The names are:
(a) TRNG320.INPUT1.SEQFILE
(b) TRNG320.INPUT2.SEQFILE
Specification Of two files are as follows:
Space=Tracks ; Primary=10 ; Secondary=20 ; Record Length=100 ; Record Format=FB ; Block
Size=1000
(2) Create a master KSDS VSAM file : TRNG320.VSAM.KSDS99
Specification: Space=Tracks ; Primary=10 ; Secondary=20 ; Record Size=(100,100) ; Key=(6,0) ; Organi-
zation= indexed

Version: 1.0 Last Saved: 1/19/2023 Page: 8 of 13

Train Information Report Generation System Detailed Design Specification
Project Control Book

(3) Create an output sequential file : TRNG320.OUTPUT.SEQFILE

Specification : Space=Tracks ; Primary=10 ; Secondary=20 ; Record Length=100 ; Record Format=FB ;
Block Size=1000

IMPLEMENTATION:
(1) Load the input file TRNG320.INPUT1.SEQFILE using IDCAMS utility to the master file
TRNG320.VSAM.KSDS99 .
(2) Describing about the files in the ENVIRONMENT DIVISION.
Input File 1 as PS
Input File 2 as VSAM
Output File as PS
(3) Defining the record structure of the Input File 1, Input File 2 and Output File in FILE SECTION OF
DATA DIVISION.
(4) Defining the file status of Input File 1, Input File 2 and Output File in WORKING-STORAGE SECTION.
(5) IN PROCEDURE DIVISION:
(a) Open the files Input File 1 , Input File 2 and Output File .
(b) Read the column TRAIN-NUMBER from input file 1 and move it to the key TRAIN-NUMBER of input
file 2.
(c) Read the key TRAIN-NUMBER in input file 2 and compare it with the exisiting keys.If found write spe-
cific details in the output file else write RECORD NOT FOUND along with the train number.
(d) Repeat steps (b) and (c) until last record of input file 1.
(e) Close all the opened files.

(6) LIBRARY DETAILS:

(a) TRNG320.COBOL.JCL which contains JCL programs for loading input file to VSAM file and for com-
piling and running COBOL program.
(b) TRNG320.COBOL.SOURCE which contains source code of the COBOL program.
(c) TRNG320.COBOL.LOAD which contains load module of the COBOL program.

7.)Time Estimation
Understanding:
Estimate: 1.5 hours
Actual : 1.5 hours
Design Document:
Estimate: 2 hours
Actual : 1 hours
Design Document Review:
Estimate: 1 hours

Version: 1.0 Last Saved: 1/19/2023 Page: 9 of 13

Train Information Report Generation System Detailed Design Specification
Project Control Book

Actual : 1 hours
Design Document Rework:
Estimate: 1 hours
Actual : 1 hours

Coding
Creation of 2 flat files , with data required:
Estimate: 0.5 hours
Actual : 0.5 hours
JCL for VSAM creation:
Estimate: 0.5 hours
Actual : 0.5 hours
COBOL source code creation:
Estimate: 5 hours
Actual : 5 hours
JCL for COBOL run:
Estimate: 0.5 hours
Actual : 0.5 hours
Coding review:
Estimate: 1 hours
Actual : 1 hours
Coding Rework:
Estimate: 0.5 hours
Actual : 0.5 hours

Potential Corresponding Work Product Descriptions (WPD) from IBM Global Services Method
APP 117 – Coding Guidelines

The APP 117 - Coding Guidelines work product includes documented rules (things you must do) and
guidelines (things you should do) of the programming style to be used in a software development project.
These guidelines usually cover things not detected by the compiler that may cause errors or problems as-
sociated with maintenance, portability, adaptability, performance, simplicity, clarity, and conflict.
Typical topics covered by Coding Guidelines include:
 File naming conventions
 File structure
 File and function prologues (security and copyright)
 Identifier naming conventions
 Composition editor (user interface) layout conventions and techniques

Version: 1.0 Last Saved: 1/19/2023 Page: 10 of 13

Train Information Report Generation System Detailed Design Specification
Project Control Book

 Global names
 Class/structure layout
 Initialization
 Use of types within language
 Calling conventions and return types
 Cohesion, encapsulation, binding
 Memory management
 Exception and error handling
 Use of language-specific features
 Terseness of expression
 Performance
 Portability
 Formatting

2.6 Appendix B – DDS Verification Checklist

Use this checklist as a guide when in-
ICAT580_C Internal Design Document

specting or reviewing an Detailed Design Specifiaction

(DDS).

Document name: Jignesh Rawal Document Id.: .....................

Checked by: R. Nagarani Date: 03/07/2013

Does the DDS meet the following criteria? Verification

[Y, N, n/a]
Correct/Clear/Concise
1. Free from error. Y

2. Clearly and properly written, in terminology appropriate for the audience (i.e., developers and Y
other relevant project team members).
3. Terms and units of measure are defined. Y

Traceability
1. The design correctly implements the requirements at a detailed level. NA

2. Elements of the design are traceable to the requirements. NA

3. No additional features or functions, other than those identified in the requirements, are in- NA
cluded in the design.
Design
1. The level of detail in the design is appropriate for the functionality proposed. Y

2. The design is maintainable and understandable. Y

3. Client use cases are developed and documented. Y

Version: 1.0 Last Saved: 1/19/2023 Page: 11 of 13

Train Information Report Generation System Detailed Design Specification
Project Control Book

Does the DDS meet the following criteria? Verification

[Y, N, n/a]
4. The system’s operational environment (e.g., network topology, deployment units) are defined. NA

5. Component designs are complete and documented. Y

6. Security and privacy requirements are addressed. NA

7. Performance requirements are addressed (e.g., data/transaction volumes, number of concur- NA

rent users, response times).
Interfaces
1. All internal interfaces (between sub-systems) and interfaces with other applications are identi- NA
fied correctly.
2. All interface characteristics are defined (e.g., direction, frequency, technology, data type, de- NA
pendencies, interface type, data content).
3. User interfaces including layout, screen flow and usability are properly defined. NA

4. All external interfaces (messages to and from the system) are identified. NA

5. Report layouts and frequency are defined. NA

Version: 1.0 Last Saved: 1/19/2023 Page: 12 of 13

Train Information Report Generation System Detailed Design Specification
Project Control Book

Does the DDS meet the following criteria? Verification

[Y, N, n/a]
Data Design
1. Logical data design is complete. Y

2. Physical database designs and file layouts are complete. NA

3. Covers all necessary data migration and conversion requirements. NA

4. Database accesses/updates are adequately described. NA

5. Covers data backup and retention (both on-site and off-site/vital record backup). NA

6. Data encryption is considered for confidential data. NA

Error handling
1. All possible error conditions are identified and handled correctly. Y

2. All exceptional conditions are clearly identified. Y

Standards
1. Design complies with all development standards and guidelines, both organizational and local. Y

2. Design complies with standards for accessibility. Y

3. For ASCA (Application Systems Control and Auditability) certifiable applications, all control NA
point are defined and included in the design.
Completeness
1. Defines the scope of the document. Y

2. All mandatory work products / document sections completed. Y

3. Work products have the level of detail appropriate for a Detailed Design. Y

4. All non-functional requirements have been addressed. Y

End of document– ICAT580_C Internal Design Document

Version: 1.0 Last Saved: 1/19/2023 Page: 13 of 13