Sdd updated checked

SAINT COLUMBAN COLLEGE

PAGADIAN CITY

COLLEGE OF COMPUTER STUDIES

Software Design Descriptionfor

SCC Newscast System

IT Group 2

“Mach5”

Almonte, Jelly Mae P.

Baltazar, Jessaneth B.

Ching Carl Angelo L.

Ihara Jr, Noel B.

Salazar, Ragde Ama T.

Signature

The following signature indicates approval of the enclosed Software Requirements Specifications Document.

Noel B. Ihara, Jr.Project manager

Jelly Mae P. Almonte Carl Angelo L. ChingSystem Analyst Programmer

Ragde Ama T. Salazar Jessaneth B. BaltazarQuality Assurance Documenter

Mr. Neil Owen B. Jandugan Adviser/Editor

Submitted and accepted by:

Mr. Philipcris C. Encarnacion , MCS CCS Dean

Change History

Table 1

Revisions Date Reason For Changes Person who

suggested the

changes

Group Name June 16, 2014 Team Celeron change its name to

Mach5 because the meaning of

Celeron itself does not suit the group’s

characteristics.

Jessaneth B. Baltazar

(Documenter)

Title Name September 8,2014 The title of the study was changed

from E-Bulletin to SCC Newscast

System to make it more suitable with

the proposed system.

Ragde Ama T. Salazar

(QA Tester)

List of Figures October 24, 2014 The list of figures was revised and the

alignment of the content was properly

arranged.


(Documenter)

List of Table October 24, 2014 The page number of the list of tables

was changed.


(Documenter)

Preface

This document contains the software design descriptions of SCC Newscast System. This document is prepared according to the “IEEE Standard for Information Technology Software Design Descriptions – IEEE Std 1016 - 2009” document. This Software Design Documentation (SDD) provides a complete description of all the system design and views of the SCC Newscast System. The first and second sections of this document include the purpose, scope, definitions of the document and the references used though out the document. The third section includes the decomposition description for software design descriptions. The fourth section contains dependency description information content, the fifth section includes the interface description and lastly, the sixth section presents the detailed design of the SCC Newscast System. The main aim of SDD is to give information’s to clients about the processes of the system. This document is very useful in Software Test Design (STD) in conducting test of the system.

Table of Contents

Signature....................................................................................................................................................................................2Change History..........................................................................................................................................................................3Preface........................................................................................................................................................................................4Table of Contents.......................................................................................................................................................................5List of Figures............................................................................................................................................................................6List of Table................................................................................................................................................................................71. Introduction...........................................................................................................................................................................8

1.1. Purpose............................................................................................................................................................................................. 81.2. Scope................................................................................................................................................................................................ 81.3. Definitions and Acronyms................................................................................................................................................................8

2. References..............................................................................................................................................................................93. Decomposition Description.................................................................................................................................................10

3.1. Module Decomposition..................................................................................................................................................................103.1.1. Administrator Class Description...........................................................................................................................................10

3.2. Concurrent Process Decomposition................................................................................................................................................103.2.1. Registration Process Description..........................................................................................................................................103.2.2. Request Verification Process Description..............................................................................................................................10

3.3. Data Decomposition.......................................................................................................................................................................103.3.1. Data Entity Admin Description.............................................................................................................................................103.3.2. Data Entity User Description................................................................................................................................................11

4. Dependency Description ....................................................................................................................................................124.1. Inter-module Dependencies............................................................................................................................................................124.2. Inter-process Dependencies............................................................................................................................................................124.3. Data Dependencies.........................................................................................................................................................................13

5. Interface Description...........................................................................................................................................................145.1. Module Interface ...........................................................................................................................................................................14

5.1.1. Module 1: Log-in Form.........................................................................................................................................................145.1.2. Module 2: Main Form...........................................................................................................................................................155.1.3. Module 3: Announcement Management Form......................................................................................................................165.1.4. Module 4: Sample Output.....................................................................................................................................................175.1.5. Module 5: Templates.............................................................................................................................................................18

5.2. Process Interface ............................................................................................................................................................................195.2.1. Adding of announcement in a form of a video/text format.....................................................................................................19

6. Detailed Design....................................................................................................................................................................206.1. Module Detailed Design ................................................................................................................................................................20

6.1.1. Module Detail.......................................................................................................................................................................207. Appendices...........................................................................................................................................................................21

7.1. Use case realization (Sequence diagram / Communication diagram)..............................................................................................217.2. Entity-relationship diagram............................................................................................................................................................22

8. Index.....................................................................................................................................................................................23

List of Figures

Figure 1: Module Log-in Form ...............................................................................................................................12

Figure 2: Main Form ……………………………….………………………………………………………………............13

Figure 3: Announcement Management Form ………………..…………………………...………………………….….13

Figure 4: Sample Output ………………………………………..…...………………………………...……..……………14

Figure 6: Templates…………………….……..………………………………….…………………………………………14

Figure 7: Adding of announcement in a form of a video/text format …………………….........................................32

Figure 8: UML Activity Diagram …………………………………..…..………...………….…………….……………….16

Figure 9: Input-Process-Output Diagram …………………………..….……………………….…………………….….19

Figure 10: Class Diagram…………………………………………………………………………………………………..20

Figure 11: Sequence Diagram…………………………………………………………………………………………….21

Figure 12: User Interface Design………………………………………………………………………………...……22-24

Figure 13: Entity-Relationship Diagram…………………………………………………………………………………..25

List of Table

Table 1: Change History…………………………………………………………………………………...…………………..3

Table 2: Definitions and Acronyms……………………………………………………………………................................8

Software Design DescriptionSCC Newscast System

Document Version: 3.0Published Date: 27 October 2014

1. IntroductionSoftware Design Description introduced in this document describes the whole description of the system together with its modules, data decomposition and class diagram in order to meet and accomplished all requirements that are needed to complete and finish the whole system.

1.1. Purpose

The purpose of this study is to enable the optimum use of the system in disseminating information to the SCCians through submission and approval of request to the Information Office by the aid of multimedia and networking technology. The purpose of this software design description (SDD) document is to describe how the software will be structured to satisfy the requirements of the SCC Newscast System. This document will explain the design details of the system.

1.2. Scope

This document contains a description and scope of the objective and benefits of SCC Newscast System. The basic architecture is a client/server or a windows form application that connects the three departments to the Information office. It will be more efficient if the three departments will only send the announcement virtually. The basic pages contain functions related to the current form. The administrator is in charge of the system, shall have full access to the database and is authorized to make changes if it is considered to be necessary.

1.3. Definitions and Acronyms

Table 2

Term Definition

SDD Software design description to specify

system architecture and system design.

Database Collection of all the information monitored by

this system.

Design A document that shows the architecture of

the system and the assignment of its

component to physical nodes.

Module A group of related activities.

of 23



2. References

• [IEEE] Recommended Practice for Software Design Descriptions in “IEEE Standards Collection,” 1998 edition.

• https://www.google.com.ph/#q=software+design+description+sample

• https://www.google.com.ph/url?sa=t&rct=j&q=&esrc=s&source=web&cd=3&cad=rja&uact=8&ved=0CCcQFjAC&url=https%3A%2F%2Fwww.oasis-open.org%2Fcommittees%2Fdownload.php%2F24846%2FExample-SoftwareDesignDocument-LegalXMLUtility.pdf&ei=nhpPVP_VGcHf8AXYnoGwBg&usg=AFQjCNGogpXu90mB2JagXPOgEAhgkqIhLQ&bvm=bv.77880786,d.dGY

of 23



3. Decomposition DescriptionThis section of this document decomposes each use-case feature into its data flow processes by examining its data flow diagram and its process flow through the use of sequence diagrams. These assist us in determining the preliminary members and methods of the modules that need to be implemented, or the modifications to existing modules to implement the feature. This document uses the names of the use cases in the Software Requirement Specification document as the names of the features. This section includes the description of the intended design to meet the requirements. When appropriate, the use cases will be expanded to include system requirements. This section also incorporates a number of sequence diagrams, updated from the initial prototype and analysis .

3.1. Module Decomposition

Module Decomposition is a decomposition of a graph into subsets of vertices called modules.

3.1.1. Administrator Class Description

This class includes the attributes of the administrator which specifies the author, department type, timeframe, announcement details. It also identifies the previous announcement proposal by displaying the time, date, author name and department type. This class is design for verifying the pending announcement proposal and finalizing information for the proposed announcement.

3.2. Concurrent Process Decomposition

3.2.1. Registration Process Description

This process dictates the functionality of the system because this is where the user of the system are registered in order to have their account relevant to perform the rest of the operations included in the system. This also creates an event for the user specifying which department they belong.

Only the admin can create a guest or another account to be used by the information personnel. It will only require a username and a password to fill it up.

3.2.2. Request Verification Process Description

This process is to be performed by the Information personnel by means of logging in to the admin workstation to gain access to the admin panel and check the notification displayed in the system tray in order to view the recent proposed announcement/news whether it is to be approved or not. If the Information personnel will approve a particular announcement, it will then be automatically queued to the playlist and if the proposed announcement is disapprove it will be deleted in the pending announcement list.. There will be notifications if there are queued announcements on the database.

3.3. Data Decomposition

3.3.1. Data Entity Admin Description

This entity will do the process of request verification process and for most of the accessibility as for maintaining the system’s database content. This entity will do the process of registering the new users, verify the user’s account and have the capability of maintaining the database of the system.

of 23



3.3.2. Data Entity User Description

This entity will do the processes ranging from sending an approval of announcement entry , filling up the pending list and updating the admin’s activity log.

of 23



4. Dependency Description

4.1. Inter-module Dependencies

When designing an Inter-module Dependencies of the system, it could be designed by two broad ways and the first way is to design the complete system using the known existing system and implement new features needed to enhance the effectiveness of the system and test it in the real conditions. An alternative way would be to design the system and usually due to the cost of putting up interfaces between modules.

The module of the SCC Newscast System depends in the dissemination of information. This inter-module of the study is the display of the announcements and it includes the database of the system. Then the entire information that has been entered will be saved in the database, which is from the announcement input process until displaying it to other monitor.

4.2. Inter-process Dependencies

The inter process of posting an announcement will be based on the user’s process which is filling up the announcement information provided in order to submit a proposal and then it will be added to the list of pending announcements.

Figure 1

Figure 1 provides an overview of the system by describing the objects and classes inside the system and the relationships between them.

of 23



4.3. Data Dependencies

Data Dependencies are based on the user. They are the one who will verify or approve the queued announcement.

of 23



5. Interface Description…

5.1. Module Interface …

5.1.1. Module 1: Log-in Form

Figure 2

Figure 2 shows the user authentication form which requires username and password to gain access to the main form.

of 23

DSA OFFICE, 10/27/14

Introductory line


Insert figure and label… add description


Description of module interface



5.1.2. Module 2: Main Form

Figure 3

Figure 3 shows the main form of the admin panel side which is capable of managing event, choosing template and notification section.

of 23


Add label to figure… and description



5.1.3. Module 3: Announcement Management Form

Figure 4

This figure 4 shows the Announcement Management Form which allows the user to update display, search, add, delete and update running text.

of 23





5.1.4. Module 4: Sample Output

Figure 5

Figure 5 shows the output form. This is the output screen which will be displayed in the four (4) monitor inside Saint Columban College.

of 23





5.1.5. Module 5: Templates

Figure 6

Figure 6 shows the template form which allows the user to choose desired template for the specific announcement.

of 23





5.2. Process Interface

…

5.2.1. Adding of announcement in a form of a video/text format

Figure 7

Figure 7 shows the adding of announcement where the user can either add a video, input announcement or add a running text.

of 23




Add introductory remark or description



6. Detailed Design…

6.1. Module Detailed Design …

6.1.1. Module Detail

The Main Form is the control for managing the announcements. The second display or the extended display is responsible for showing the announcements on the monitors.

Figure 8

Figure shows the Activity between the Departments, Admin and The System.

of 23











7. Appendices….

7.1. Use case realization (Sequence diagram / Communication diagram)

Figure 9

The figure above shows the sequence of the processes happen in the SCC Newscast System.

of 23


Add label to figure… and description….improve diagram


????



7.2. Entity-relationship diagram

Figure 10

This figure above shows the entity relationship diagram of the system. It explained how the different tables in the database connected with the other tables.

of 23



8. Index

Attributes 12,

Data Entity 13, 16

References 11

Software Design 9,11

of 23

Sdd updated checked

Technology

Transcript of Sdd updated checked