sdd enote (repaired)

16
TABLE OF CONTENTS 1 . 1. 1 INTRODUCTION Purpose 2 2 1. 2 Scope 2 1. 3 Overview 2 1. 4 Reference Material 2 1. 5 Definitions and Acronyms 2 2 . SYSTEM OVERVIEW 4 3 . SYSTEM ARCHITECTURE 4 3. 1 Architectural Design 4 3. 2 Hardware and Software 5 3. 3 System Design 6 4 . 4. 1 DESIGN DATABASE Introduction 9 9 4. 2 System Interfaces 9 4. 3 System Software Attributes 10 5 . System Object Model 11 5. 1 Introduction 11 5. 2 Design Input 11 5. 3 User Registration Form 12 6 . Glossary 12 7 Conclusion 12 1

Upload: corey-gordon

Post on 27-Jan-2016

216 views

Category:

Documents


1 download

DESCRIPTION

ENOTE

TRANSCRIPT

Page 1: Sdd Enote (Repaired)

TABLE OF CONTENTS

1.

1.1

INTRODUCTION

Purpose

2

2

1.2 Scope 2

1.3 Overview 2

1.4 Reference Material 2

1.5 Definitions and Acronyms 2

2. SYSTEM OVERVIEW 4

3. SYSTEM ARCHITECTURE 4

3.1 Architectural Design 4

3.2 Hardware and Software 5

3.3 System Design 6

4.

4.1

DESIGN DATABASE

Introduction

9

9

4.2 System Interfaces 9

4.3 System Software Attributes 10

5. System Object Model 11

5.1 Introduction 11

5.2 Design Input 11

5.3 User Registration Form 12

6. Glossary 12

7 Conclusion 12

1

Page 2: Sdd Enote (Repaired)

1. INTRODUCTION

1.1 Purpose

Software Design Documentation (SDD) was developed as a reference to the system builder, or to stakeholder they will perform or make process reengineering again. System CS Note is a product that provides courses notes to the UTM Student. CS note system is easy to use for student to get the past year notes and final exam questions.

1.2 Scope

The scope of this document will describe in detail the architecture system development, database and interface systems will be built. System CS Note will allow user to view and download notes from their courses. There are 3 user involved in the system. The users are data admin, super admin and user from computer science student. This system will facilitate students in computer science download the lesson notes on the subject they need.

1.3 Overview

This document will contain a detailed description development system through the Process Flow Diagram (PFD), Figure use diagrams and establishing systems to enable users understand more clearly about the development of this system. This system was developed to facilitate students to download notes by subject matter required. This system consists of data managers, system managers and users of the system diagram below is an overview of the system.

1.4 Definitions and Acronyms

CS – Computer Science

Note – Note/Syllabus document provided by lecturer

Response Time – feedback time from server/database

File Size – material/document capacity

Speed Download – connection speed/page loading (3G/4G speed)

2

Page 3: Sdd Enote (Repaired)

2.0 SYSTEM OVERVIEW

2.1 System Overview Flowchart

This system was developed to facilitate students to download notes by subject matter required. This system consists of data managers, system managers and users of the system diagram below is an overview of the system.

Figure 1: Overview System Flowchart

2.2 Role of Consumers

3

Page 4: Sdd Enote (Repaired)

No. Consumer Role

1. UserThe main role is for users make a search in online notes of UTM Student. Users will be registered and will log into the system before entering the search criteria. In addition, the super admin user can also monitor the search case where this account will expire and user can renew their account.

2. Super Admin User The main role is for super admin user is control the report of the system. Super Admin will generate report and print report for user.

3. Data Manager User The main role is for data manager user is managing the data control of the system. Data Manager will register the student, upload notes in the system, and download notes and updates notes in the system.

4. Student User The main role is for Student user is using the e-note system. Student User can search the notes; download the notes from the system. After user use the system, user can rating and share the application with their friends and online social media is satisfied with the system.

3.0 SYSTEM ARCHITECTURE

3.1 Architectural Design

In chapter 3, has explained that this system is developed in environment using BootStrap design, JQuery programming, HTML, JavaScript, and MySQL database. However, the system architecture framework is as shown in Figure 2.

Software Design Documentation (SDD)

Figure 2: Framework System Development

4

USER INTERFACEUSER INTERFACE

ENTITYENTITY

BUSINESS LOGICBUSINESS LOGIC

DATA ACCESSDATA ACCESS

DATABASEDATABASE

Page 5: Sdd Enote (Repaired)

The framework used is four (4) layer constructions that uses component - component entity, data access, business logic and user interface. Each of these components will be connected to one another to form a simple algorithm and orderly. Table 3 will describe each layer components Figure 2.

No. Component Description1 Database Information data / records will be locked in the system2 Entity Linking databases built by declaring - field with data type (data type) and a

database table3 Data Access Data Access database to connect to declare fields - fields that will be

accepted in the database and integration with databases.4 Business Logic Linking between entity and data access where it will do the algorithm

component in a data access such as insert, update, delete, and query. In tone aka business logic algorithm which involves two types of table and view.

5 Interface Display interface that connects the main algorithm and interact with layer - layer component to another.

Table 3: Function Component Architecture System Development

3.2 Hardware and Software

Technical infrastructure or resources that are needed:

Hardware infrastructure

Infrastructure DescriptionComputer Needed for documentation purposeWindow XP / Window 7/ Windows 8 operating system

Compatible

Internet connection Finding of information required for the project

Software infrastructure Infrastructure Description

Microsoft Word Helps in preparing the documents related to the system

Microsoft Project Develop the work breakdown structureMicrosoft Powerpoint Needed to prepare the slides for presentationMicrosoft Visio Needed to develop the data flow diagramMySQL Create the database that allow the data storage

and retrievalHTML / PHP/JQuery Write the coding that is required to develop the

system

5

Page 6: Sdd Enote (Repaired)

3.3 System Design

i) Downloading Case Search Notes Online stm Use Case Model

Start

Choose User

RegisteredUser

Please Register User

Login

Verify User

Verified

Login into system

Login again

Choose Menu Button

Choose Categories of subject

Browse the notes

Select notes

Download Notes

Confirm download

Download

User Accept download notes

SystemVerified

Generate Report

finish

[No]

[Yes]

[Yes][No]

[Yes]

[yes]

[No]

[No]

Figure 4: Downloading Case Search Notes Online

6

Page 7: Sdd Enote (Repaired)

ii) Sequence flow of download notes module

sd Sequence Download

User Login Login Control Download Menu Download Menu Control

Database

Get ID and Password()

Get ID And Password()

Get Menu system()

Get Download Menu()

Download Data()

Display Download data()

Figure 5: Sequence flow of download notes module

Figure 6 describes the overall registration process for download notes. This process starts from the user login until user finish downloads the notes.

iii) Admin User Login

act Admin Login

Start

Enter Username

and Password

Verify Login

Verified

Enter User Menu

Enter Usename

and password

again

Finish

[Yes]

[No]

Figure 6 : Admin User Login

7

Page 8: Sdd Enote (Repaired)

iv) Others Module

\

8

START

Login Module

Register User

Generate report Module

Search Module

Upload Module

Update Module

Download Module

Share Module

Rating Module

Verified

End

Page 9: Sdd Enote (Repaired)

4.0 DESIGN DATABASE

4.1 Introduction

The Design Overview is section to introduce and give a brief overview of the design. The System Architecture is a way to give the overall view of a system and to place it into context with external systems. This allows for the reader and user of the document to orient them to the design and see a summary before proceeding into the details of the design.

4.2 System Interfaces

4.2.1 External User Interface Requirements

4.2.1.1 User Interfaces

The user interface for the system will allow the user to easily generated documents, search for documents, and modify documents. The user can use all main functions on the first user interface page to allow for the user to select the function to use without the need to navigate inward to find it. The interface will need to use tab focus marks to allow for navigation using a keyboard as much as possible to alleviate stress on users' arms and hands caused by changing constantly from keyboard to mouse. It will be accessible through a web interface to allow for centralized hosting and use by various operating systems.

4.2.1.2 Software Interfaces

The software mentioned has a high performance on the Microsoft Window operating system such as Window XP or Window 7 and Windows 8. Microsoft Window XP is one the most popular operating system in the world and it is also the most frequently used operating system.

The software will need to interface with a case management system to pull data from it and push data updates to it. The connection will be a standard database connection using JDBC or ODBC.

9

Page 10: Sdd Enote (Repaired)

4.2.1.3 Software System Attributes

4.2.1.3.1 Usability

Usability defines how well the application meets the requirements of the user and consumer by being intuitive, easy to localize and globalize, providing good access for disabled users, and resulting in a good overall user experience.

4.2.1.3.2 Reliability Reliability is the ability of a system to remain operational over time. Reliability

is measured as the probability that a system will not fail to perform its intended functions over a specified time interval.

4.2.1.3.3 Performance Performance is an indication of the responsiveness of a system to execute any

action within a given time interval. It can be measured in terms of latency or throughput. Latency is the time taken to respond to any event. Throughput is the number of events that take place within a given amount of time.

4.2.1.3.4 Security Requirements Security is the capability of a system to prevent malicious or accidental actions

outside of the designed usage, and to prevent disclosure or loss of information. A secure system aims to protect assets and prevent unauthorized modification of information.

10

Page 11: Sdd Enote (Repaired)

5.0 SYSTEM OBJECT MODEL

5.1 Introduction

The System Object Model Section allows for a description of the subsystems in use. This allows for describing the system in an overall manner to show the different groupings of parts into respective systems. For the System under Design, only one system is used and no subsystems are specified.

5.2 Design input

User needs to log in first into the system for use of the module in the system.

5.2.1 User Interface

Figure 7: User Interface

11

Page 12: Sdd Enote (Repaired)

5.2.2 User Registration Form

Figure 8: User Registration Form

6.0 GLOSSARY

Not Connected

7.0 CONCLUSION

SDD is a reference development system to be used by system developers, systems analysts and stakeholders. These documents will also be the basis for improvement that occurred there in the future.

12