Software Requirements Specification

Version 1.0

Oct 19, 2021

Gradebook System

Ericka Koyama
2.0. Overall Description

2.1 Product Perspective

Figure 1. System Environment

The Gradebook Service has two actors and one cooperating system. Both the Student and

Instructor access the system via the Internet website. An Instructor can manage assignments by

adding, modifying, and grading them. A Student can view their own assignment grades in the

courses they are enrolled in. The Registration Service is a cooperating system that informs the

Gradebook Service about new course enrollments, and also receives final course grades from the

Gradebook Service.

3.0 Specific Requirements

3.2 Functions

3.2.1 Instructor adds an assignment for a course

SRS V 1.0 2 October 19, 2021

 Use Case Name Instructor adds an assignment for a course

XRef None

Trigger The instructor clicks on ‘Add Assignment’ button in

assignment list for course

Precondition The course exists in the gradebook service and the

instructor teaches the course for the assignment they are
creating.

Basic Path 1. Instructor logs in

2. Instructor views a list of assignments for a course
3. Instructor clicks ‘Add Assignment’ button
4. Instructor views ‘Add Assignment’ modal
5. Instructor fills out required assignment information
6. Instructor clicks ‘Add’ button

Alternative Paths N/A

Postcondition The assignment has been added to the database

Exception Paths The assignment failed to be created. A failure toast

notification is displayed in the UI.

Other The assignment is associated with a course id, due date,

and a name supplied by the instructor.

3.2.2 Instructor enters scores for an assignment

Use Case Name Instructor enters scores for an assignment

XRef None

Trigger The instructor enters a grade for an assignment grade row

Precondition ● Instructor has already created an assignment by

3.2.1: Instructor adds an assignment for a course
use-case
● The assignment due date has passed
● The instructor is teaching the course for the
assignment

Basic Path 1. Instructor logs in

SRS V 1.0 3 October 19, 2021

 2. Instructor views list of assignments that need
grading
3. Instructor selects an assignment and clicks ‘Grade’
button
4. Instructor enters scores in each row, with each row
being an enrollment in the course.

Alternative Paths None.

Postcondition The assignment grades have been updated in the database.

Exception Paths The assignment grading failed to be entered. A failure toast

notification is displayed in the UI.
The Instructor may abandon the operation at any time.

Other The assignment is entered as a numerical value score. This

use-case builds on 3.2.1 Instructor adds an assignment for
a course

3.2.3 A student views their scores for a course

Use Case Name A student views their scores for a course

XRef None

Trigger The student views the gradebook page

Precondition Some assignment grades for the Student have been entered
by the 3.2.2 Instructor enters scores for an assignment
use-case

Basic Path 1. Student logs in

2. Student views gradebook page
3. Student can see their course assignments, along
with their score on each assignment, if it has been
graded

Alternative Paths None

Postcondition The assignment has been added to the database

Exception Paths The assignment grades fail to load. A failure toast

notification is displayed.
The Student may abandon the operation at any time.

SRS V 1.0 4 October 19, 2021

 Other The assignment is associated with a course id, a due date,
and a name supplied by the instructor.

3.2.4 Instructor submits final grades for a course

Use Case Name Instructor submits final grades for a course

XRef None

Trigger The instructor clicks a button ‘Submit Final Grades’ on the

course assignments page

Precondition The course exists in the gradebook service, has not already
been final graded, and the user is the Instructor that teaches
the course. All assignments for the course have been
graded.

Basic Path 1. Instructor logs in

2. Instructor views list of courses they are teaching
3. Instructor selects a course and clicks the ‘Submit
Final Grades’ button

Alternative Paths N/A

Postcondition The course final grades has been sent to the schedule
service

Exception Paths The course final grades failed to be sent. A failure toast
notification is displayed.
The Instructor may abandon the operation at any time.

Other This use case is built on …. , assuming all course

assignments have been graded

3.3 Performance Requirements

The website to access the Gradebook Service will be deployed in a cloud

environment, with high-performing server resources. The security of the website

will use OAuth2 through Google. Modern browsers should be used to access the

SRS V 1.0 5 October 19, 2021

website, such as Google Chrome (minimum version 94), Mozilla Firefox

(minimum version 93), Microsoft Edge (minimum version 94), or Apple Safari

(minimum version 14).

3.4 Logical Database Requirements

Figure 2. Logical Structure of the Gradebook Service

Course Data Entity

Data Item Type Description Comment

ID Integer The identifier of the Primary key

course

Instructor String The email of the Used as an identifier

instructor for the
course

SRS V 1.0 6 October 19, 2021

Semester String The semester the
course is offered

Title String The title of the course

Year Integer The year the course is

offered

Enrollment Data Entity

Data Item Type Description Comment

ID Integer The identifier of the Primary key

enrollment

Student Email String The email of the Used as an identifier

student enrolled

Student Name String The name of the

student enrolled

Course ID Pointer Course entity Foreign key to

Course table

Assignment Data Entity

Data Item Type Description Comment

ID Integer The identifier of the Primary key

assignment

Due Date Date The date the

assignment is due

Name String The name of the

assignment

Needs Grading Integer Whether the 1 for needs grading,

assignment needs to or 0 for doesn’t need
be graded or not grading. Value is
based on the due date
having passed.

Course ID Pointer Course entity Foreign key to

Course table

SRS V 1.0 7 October 19, 2021

Assignment Grade Data Entity
Data Item Type Description Comment

ID Integer The identifier of the Primary key

assignment grade

Score String The score for the Stored as a string and

student’s assignment parsed to determine
submission letter grade for final
grades. Field is empty
until the assignment
is graded for
enrollment.

Assignment ID Pointer Assignment entity Foreign key to

Assignments table

Enrollment ID Pointer Enrollment entity Foreign key to

Enrollment table

SRS V 1.0 8 October 19, 2021