timetablesystem.files.wordpress.com€¦  · web viewour system will consist of two parts. this...

30
ÇANKAYA UNIVERSITY FACULTY OF ENGINEERING COMPUTER ENGINEERING DEPARMENT CENG 407 INNOVATIVE SYSTEM DESIGN AND DEVELOPMENT I Software Design Description Version 1.0 Mert Çelebi 201311012 Ali Can Aygör 201211009 Atilla Duruel 0

Upload: others

Post on 18-Sep-2020

1 views

Category:

Documents


0 download

TRANSCRIPT

Page 1: timetablesystem.files.wordpress.com€¦  · Web viewOur system will consist of two parts. This parts are database part and web part. In the database part, the data to be entered

ÇANKAYA UNIVERSITYFACULTY OF ENGINEERING

COMPUTER ENGINEERING DEPARMENT

CENG 407

INNOVATIVE SYSTEM DESIGN AND DEVELOPMENT I

Software Design Description

Version 1.0

Mert Çelebi201311012

Ali Can Aygör201211009

Atilla Duruel201111017

16 / 12 / 2016

0

Page 2: timetablesystem.files.wordpress.com€¦  · Web viewOur system will consist of two parts. This parts are database part and web part. In the database part, the data to be entered

TABLE OF CONTENTS

1. Introduction31.1.................................................................................................................................... Purpose1.2....................................................................................................................................... Scope1.3.................................................................................................................................. Glossary1.4..................................................................................................... Overview of the Document

2. Deployment Diagram63. Architecture Design7 3.1. Web System Architecture 7 3.1.1. Login Page7 3.1.2. Admin Page 8 3.1.3. User 9 3.1.4. Department Page 11 3.1.5. Course Page 12 3.1.6. Message Page134. Data Structure Design14 4.1. System User (Student) Information 14 4.2. System User (Instructor) Information 15 4.3. Department Administrator Information 16 4.4. System Administrator Information 17 4.5. Course Information17 4.6. Class Information185. Use Case Realizations18 Use Case: Admin 19 Use Case: User 20 Use Case: Department 216. Interface Design22

1

Page 3: timetablesystem.files.wordpress.com€¦  · Web viewOur system will consist of two parts. This parts are database part and web part. In the database part, the data to be entered

LIST OF FIGURES

Figure 1: Deployment Diagram6Figure 2: Architecture Design7Figure 3: System Sequence Diagram18Figure 4: Admin Sequence Diagram19Figure 5: User Sequence Diagram 20Figure 6: Department Sequence Diagram 21Figure 7: Login Page22Figure 8: User Page22Figure 9: Admin Page23Figure 10: Department Page23

2

Page 4: timetablesystem.files.wordpress.com€¦  · Web viewOur system will consist of two parts. This parts are database part and web part. In the database part, the data to be entered

1. INTRODUCTION

1.1. Purpose

In this software design description document, the general design fundamentals

about timetable system will be detailed. Software design description document describes

the general architecture and design of the system. This document will help us in terms of

software development. Questions like how the system should do, how the system

architecture should be, what will be the design criterias for this product and how these

design criterias will be transferred to the customers in an understandable way in terms of

development process will be responsed. One of the most important purposes of this

document is to present the design visually. As we declare before in the SRS, we will

construct the design and implementations of the timetable system.

1.2. Scope

Our system will consist of two parts. This parts are database part and web part. In

the database part, the data to be entered will be determined. The design of the database,

the arrangement of relationships, defining of primary and foreign keys will be considered.

The number of tables needed for the database will be determined. Already building a

database is an essential part of our development. We have to create this database to reach

the data we will use on the web part of the project. In the web part, the work that system

users, department administrator and system administrator can do will be detailed. As each

user has different authorities, the things they can do are different. This visual design

should be simple, understandable and easy to use because the visual design of the web

pages will affect the users. Obviously, visualization is not expected much from the design

of a system whose content is a timetable. Thus user interface must be simple. UML of the

system and sequence diagrams of the system will be drawn. At the same time there will be

also database and web design figures.

3

Page 5: timetablesystem.files.wordpress.com€¦  · Web viewOur system will consist of two parts. This parts are database part and web part. In the database part, the data to be entered

1.3. Glossary

TERM DEFINITION

System User The person who can make only certain changes in the program like choosing course

Department Administrator The person who can make only certain changes in the program like changing instructor name, course time and course room.

System Administrator The person who can make only certain changes in the program like add/drop courses, instructors, students, changing user information and course name.

Database A database is a place where we store information. More than that, its a place where we store organized information for a purpose or a set of purposes.

Student User type with specific characteristics

Instructor User type with specific characteristics

SQL (Structured Query Language)

SQL is a special-purpose domain-specific language used in programming and designed for managing data held in a relational database management system (RDBMS), or for stream processing in a relational data stream management system (RDSMS).

Website Website is a collection of related web pages, including multimedia content, typically identified with a common domain name, and published on at least one web server.

Primary Key The primary key constraint uniquely identifies each record in a database table.

4

Page 6: timetablesystem.files.wordpress.com€¦  · Web viewOur system will consist of two parts. This parts are database part and web part. In the database part, the data to be entered

Foreign Key A foreign key in one table points to a primary key in another table.

SDD Software description document (SDD) contains information on how the system will be designed.

SRS Software requirement specification (SRS) contains information on the requirements of the system.

Microsoft Visual Studio 2015

It is used to develop computer programs for Microsoft Windows, as well as web sites, web applications and web services.

Microsoft Azure Microsoft Azure  is a cloud computing platform and infrastructure created by Microsoft for building, deploying, and managing applications and services through a global network of Microsoft-managed data centers.

Microsoft SQL Management Studio

SQL Server Managemet Studio is used for configuring, managing, and administering all components within Microsoft SQL Server.

1.4. Overview of the Document

Chapter 2 is a Physical version of the system. We can see there all component of the

sistem which we are use.

Chapter 3 is a Architectural Design of the system. This part of document shows us

definitions of the system functions. System be explained for each user.

Chapter 4 in this part we expalin which data are we use in program.

Chapter 5 include figures of system operation in sequence diagram

Chapter 6 pictures of UI design.

5

Page 7: timetablesystem.files.wordpress.com€¦  · Web viewOur system will consist of two parts. This parts are database part and web part. In the database part, the data to be entered

2. Deployment Diagram

Figure 1: Deployment Diagram

6

Page 8: timetablesystem.files.wordpress.com€¦  · Web viewOur system will consist of two parts. This parts are database part and web part. In the database part, the data to be entered

3. Architecture Design

3.1. Web System Architecture

Figure 2 : Architecture Design

3.1.1 Login Page

Name: Admin Login page

Type: Webpage

7

Page 9: timetablesystem.files.wordpress.com€¦  · Web viewOur system will consist of two parts. This parts are database part and web part. In the database part, the data to be entered

Description: When the user clicks the Login button in main page, it connects to the

admin,user or teacher page. Such as person enters their own userid and password after than by

clicking the login button user can entered the page.

Attributes:

UserID: Int

UserPassword: String

Resources: None

Operations: If valid userid and password is entered, person can login

Arguments: None

Returns: None

Pre-condition: Click the Login button

Post-condition: Needed to be logged in

Exceptions: If userid and password is not valid, person cannot log in and system gives

error message

Flow of Events:

1. Entering the userid and password

2. Click the login button

3. Login can be done

3.1.2. Admin Page

Name: Admin Page

Type: Webpage

Description: This is the System Administrator page. In this page, There are nine buttons. First

button makes to change user information. Second button makes to add/drop courses. Third

button makes to add/drop instructors. Fourth button makes to change course name. Fifth

8

Page 10: timetablesystem.files.wordpress.com€¦  · Web viewOur system will consist of two parts. This parts are database part and web part. In the database part, the data to be entered

button confirm register of users. Sixth button for viewing all courses. Seventh button show

online students. Eighth button makes add/drop student. Ninth button logout.

Attributes:

UserName :string

UserSurname : string

UserPassword: string

UserIDNumber: int

UserEmail: string

UserPhone: int

Resources: None

Operations: Making all the changes in the system. Insert, delete, confirmation as example.

Arguments: None

Returns: None

Pre-condition: Connected to site

Post-condition: Access to the system

Exceptions: Approves or /not Approves all changes made to the system.

Flow of Events:

1. The Admin is on the “Admin” pages.

2. Add/Delete/Update/Approve person/course/changing

3. Click the “Check” button.

3.1.3 User Page

Name: User Page

Type: Webpage

9

Page 11: timetablesystem.files.wordpress.com€¦  · Web viewOur system will consist of two parts. This parts are database part and web part. In the database part, the data to be entered

Description: This is the System User page. In this page, There are four buttons. First

button makes to change user information. Second button select course. Third button for

viewing all courses. Fourth button logout.

Attributes:

UserName :string

UserSurname : string

UserPassword : string

UserIDNumber : int

UserClass : int

UserFaculty : string

UserDepartment : string

UserCurriculumName : string

UserAdvisorName : string

UserEmail: string

UserPhone: int

IsApprove : bit

Resources: None

Operations: Making user information changes in the system. Course

registration/insert/delete/update as example.

Arguments: None

Returns: if click the courses button, view all courses and his/her courses.

Pre-condition: Connected to site

Post-condition: View content of his/her courses.

Exceptions: Download or Upload his/her lesson report.

Flow of Events:

10

Page 12: timetablesystem.files.wordpress.com€¦  · Web viewOur system will consist of two parts. This parts are database part and web part. In the database part, the data to be entered

1. The User is on the “User” pages.

2. Add/Delete course.

3.Download/Upload lesson report/homework

4. Click the “Submit” button.

3.1.4 Department Page

Name: Department Page

Type: Webpage

Description: This is the System Department page. In this page, There are seven

buttons. First button makes to confirm timetable. Second button makes to change department

information. Third button makes to change instructor name. Fourth button makes to change

course time. Fifth button makes to change course room. Sixth button for viewing all courses.

Seventh button logout.

Attributes:

UserName :string

UserSurname : string

UserPassword : string

UserIDNumber : int

RoomNumber : int

UserFaculty : string

UserDepartment : string

UserEmail: string

UserPhone: int

AcademicDomain : string

11

Page 13: timetablesystem.files.wordpress.com€¦  · Web viewOur system will consist of two parts. This parts are database part and web part. In the database part, the data to be entered

AcademicDegree : string

InstructorWebSite : string

InstructorDuty : string

IsApprove : bit

Resources: None

Operations: Making department information changes in the system. course

registration/insert/delete/update as example.

Arguments: None

Returns: if click the courses button, view all courses and his/her courses.

Pre-condition: Connected to site

Post-condition: View content of his/her courses.

Exceptions: Download or Upload his/her lesson report.

Flow of Events:

1. The Department User is on the “Department” pages.

2. Add/Delete/Update course.

3. Upload lesson report

4. Click the “Submit” button.

3.1.5 Course Page

Name: Course Page

Type: Webpage

Description: This is the Course page. In this page, Users(students) can see the contents

of the courses they take. New assignments etc. Department Admins can add new assignments

for their classes. They can grade. They can change the course time.

Attributes:

12

Page 14: timetablesystem.files.wordpress.com€¦  · Web viewOur system will consist of two parts. This parts are database part and web part. In the database part, the data to be entered

CourseName: string

CourseCode : string

CourseHour : int

CourseSemester : string

CourseInstructor : string

CourseTime : Datetime

DepartmentID : int

CourseTypeID : int

CourseTypeName : string

IsApprove : bit

Resources: None

Operations: View content of courses.

Arguments: None

Returns: None

Pre-condition: Connected to site

Post-condition: All courses.

Exceptions: The information of the selected course is brought to the screen.

Flow of Events:

1. The Department User is on the “Department” pages.

2. Add/Delete/Update course.

3. Upload lesson report

4. Click the “Submit” button.

3.1.6 Message Page

13

Page 15: timetablesystem.files.wordpress.com€¦  · Web viewOur system will consist of two parts. This parts are database part and web part. In the database part, the data to be entered

Name: Message Page

Type: Webpage

Description: This is the Message page. In this page, people can communicate with

each othe or they can chat online.

Attributes: None

Resources: None

Operations: None

Arguments: None

Returns: Send or Receive new message.

Pre-condition: Connected to site

Post-condition: Messaging board.

Exceptions: View messages in his/her page.

Flow of Events:

1. The Message Board is on the “User/Department/Admin” pages.

2. Click the “Send” button for new message.

4. Data Structure Design

Our data will be stored in Timetable system database.

4.1. System User (Student) Information

14

Page 16: timetablesystem.files.wordpress.com€¦  · Web viewOur system will consist of two parts. This parts are database part and web part. In the database part, the data to be entered

4.2. System User (Instructor) Information

15

Attribute Name Attribute Type Attribute Size

UserName Nvarchar(50) 50

UserSurname Nvarchar(50) 50

UserPassword Nvarchar(50) 50

StudentNumber Int 20

UserIDNumber Int 20

UserClass Int 4

UserFaculty Nvarchar(50) 50

UserDepartment Nvarchar(50) 50

UserCurriculumName Nvarchar(50) 50

UserAdvisorName Nvarchar(50) 50

UserEmail Nvarchar(50) 50

UserPhone Int 20

IsApprove Bit

Page 17: timetablesystem.files.wordpress.com€¦  · Web viewOur system will consist of two parts. This parts are database part and web part. In the database part, the data to be entered

4.3. Department Administrator Information

16

Attribute Name Attribute Type Attribute Size

UserName Nvarchar(50) 50

UserSurname Nvarchar(50) 50

UserPassword Nvarchar(50) 50

InstructorNumber Int 20

UserIDNumber Int 20

RoomNumber Nvarchar(20) 20

UserFaculty Nvarchar(50) 50

UserDepartment Nvarchar(50) 50

UserEmail Nvarchar(50) 50

UserPhone Int 20

AcademicDomain Nvarchar(50) 50

AcademicDegree Nvarchar(50) 50

InstructorWebSite Nvarchar(50) 50

InstructorDuty Nvarchar(50) 50

IsApprove Bit

Page 18: timetablesystem.files.wordpress.com€¦  · Web viewOur system will consist of two parts. This parts are database part and web part. In the database part, the data to be entered

4.4. System Administrator Information

17

Attribute Name Attribute Type Attribute Size

UserName Nvarchar(50) 50

UserSurname Nvarchar(50) 50

UserPassword Nvarchar(50) 50

InstructorNumber Int 20

UserIDNumber Int 20

RoomNumber Nvarchar(20) 20

UserFaculty Nvarchar(50) 50

UserDepartment Nvarchar(50) 50

UserEmail Nvarchar(50) 50

UserPhone Int 20

AcademicDomain Nvarchar(50) 50

AcademicDegree Nvarchar(50) 50

InstructorWebSite Nvarchar(50) 50

InstructorDuty Nvarchar(50) 50

IsApprove Bit

Page 19: timetablesystem.files.wordpress.com€¦  · Web viewOur system will consist of two parts. This parts are database part and web part. In the database part, the data to be entered

4.5. Course Information

4.6.

Class Information

18

Attribute Name Attribute Type Attribute Size

UserName Nvarchar(50) 50

UserSurname Nvarchar(50) 50

UserPassword Nvarchar(50) 50

UserIDNumber Int 20

UserEmail Nvarchar(50) 50

UserPhone Int 20

Attribute Name Attribute Type Attribute Size

CourseName Nvarchar(50) 50

CourseCode Nvarchar(20) 20

CourseHour Int 20

CourseSemester Nvarchar(20) 20

CourseInstructor Nvarchar(50) 50

CourseTime Datetime

DepartmentID Int 20

CourseTypeID Int 20

CourseTypeName Nvarchar(20) 20

IsApprove Bit

Attribute Name Attribute Type Attribute Size

ClassName Nvarchar(50) 50

ClassCapacity Int 20

IsApprove Bit

Page 20: timetablesystem.files.wordpress.com€¦  · Web viewOur system will consist of two parts. This parts are database part and web part. In the database part, the data to be entered

5. Use Case Realizations

Figure 3: System Sequence Diagram

Use Case: Admin

You can see the detailed information about admin use case in SRS.

19

Page 21: timetablesystem.files.wordpress.com€¦  · Web viewOur system will consist of two parts. This parts are database part and web part. In the database part, the data to be entered

Figure 4: Admin Sequence Diagram

Use Case: User

You can see the detailed information about user use case in SRS.

20

Page 22: timetablesystem.files.wordpress.com€¦  · Web viewOur system will consist of two parts. This parts are database part and web part. In the database part, the data to be entered

Figure 5: User Sequence Diagram

Use Case: Department

You can see the detailed information about department use case in SRS.

21

Page 23: timetablesystem.files.wordpress.com€¦  · Web viewOur system will consist of two parts. This parts are database part and web part. In the database part, the data to be entered

Figure 6: Department Sequence Diagram

6. Interface Design

22

Page 24: timetablesystem.files.wordpress.com€¦  · Web viewOur system will consist of two parts. This parts are database part and web part. In the database part, the data to be entered

Figure 7: Login Page

Figure 8: User Page

23

Page 25: timetablesystem.files.wordpress.com€¦  · Web viewOur system will consist of two parts. This parts are database part and web part. In the database part, the data to be entered

Figure 9: Admin Page

Figure 10: Department Page

24