Student Scheduling System User Manual - Spring 2018 · PLAY framework for Java ... to feel...

25
Student Scheduling System User Manual Student Scheduling System Team 06 Douglass Kinnes : Project Manager, Quality Focal Point, Implementer Alexey Tregubov : System Architect, UML Modeler, Implementer Mihir Daptardar : Operational Concept Engineer, Quality Focal Point, Implementer Ihsan Tolga : Life Cycle Planner, Feasibility Analyst, Implementer Simone Lojeck : IV&V, Quality Focal Point, Shaper 05/04/2013

Transcript of Student Scheduling System User Manual - Spring 2018 · PLAY framework for Java ... to feel...

Page 1: Student Scheduling System User Manual - Spring 2018 · PLAY framework for Java ... to feel comfortable with Java and Web developing and using MySQL like ... 'Play! Framework 2'. Enter

Student Scheduling System User Manual

Student Scheduling System

Team 06

Douglass Kinnes : Project Manager, Quality Focal Point, Implementer Alexey Tregubov : System Architect, UML Modeler, Implementer Mihir Daptardar : Operational Concept Engineer, Quality Focal Point, Implementer Ihsan Tolga : Life Cycle Planner, Feasibility Analyst, Implementer Simone Lojeck : IV&V, Quality Focal Point, Shaper

05/04/2013

Page 2: Student Scheduling System User Manual - Spring 2018 · PLAY framework for Java ... to feel comfortable with Java and Web developing and using MySQL like ... 'Play! Framework 2'. Enter

User Manual (UM) Version 2.3

UM_IOC3_S13b_T06_V2.3 ii Version Date: 05/04/13

Version History

Date Author Version Changes made Rationale

03/29/2013 Ihsan Tolga 1.0 Draft version of UM is formed. Initial information and guidelines added.

To satisfy the requirements of the CCD/TRR and to provide instructions to the users how to use the scheduling system software.

04/05/2013 Ihsan Tolga 1.1 Sections updated. Guidelines for operation added.

Updates made with respect to upcoming CCD.

04/13/2013 Ihsan Tolga 1.5 Screenshots updated. Minor revisions made. Admin side is updated with respect to the CCD session. Error acknowledgments added.

CCD concern evaluated and changes made. New screenshots due to new UI.

04/20/2013 Ihsan Tolga 1.7 Student Side updated. Admin side screenshot updated.

Updates/revisions made for TS with full system capability.

04/30/2013 Ihsan Tolga 2.0 Tutorials for PLAY and system deployment are added.

Minor revisions and tutorials before system transition.

05/04/2013 Ihsan Tolga

Alexey Tregubov

2.2 Deployment tutorial section added. Documentation figure changed.

Guidelines for binary distributive compilation, changes after cloud deployment and tutorials.

05/03/2013 Ihsan Tolga 2.3 Reset Password directions added.

Added tutorial for Reset Password button.

Page 3: Student Scheduling System User Manual - Spring 2018 · PLAY framework for Java ... to feel comfortable with Java and Web developing and using MySQL like ... 'Play! Framework 2'. Enter

User Manual (UM) Version 2.3

UM_IOC3_S13b_T06_V2.3 iii Version Date: 05/04/13

Table of Contents

VERSION HISTORY................................................................................................................................ II

TABLE OF CONTENTS ......................................................................................................................... III

TABLE OF TABLES .............................................................................................................................. IV

TABLE OF FIGURES ..............................................................................................................................V

1. Introduction ................................................................................................................................................ 1

1.1 System Overview ................................................................................................................................ 1

1.2 System Requirements .......................................................................................................................... 1

2. Installation Procedures ................................................................................................................................ 2

2.1 Installing Play Framework ................................................................................................................... 2

2.2 Re-installation ..................................................................................................................................... 9

2.3 De-installation ..................................................................................................................................... 9

3. Operational Procedures ............................................................................................................................... 9

4. Troubleshooting ........................................................................................................................................ 18

4.1 Frequently Asked questions ............................................................................................................... 18

4.2 Error Codes and Messages ................................................................................................................. 19

4.3 Note .................................................................................................................................................. 20

Page 4: Student Scheduling System User Manual - Spring 2018 · PLAY framework for Java ... to feel comfortable with Java and Web developing and using MySQL like ... 'Play! Framework 2'. Enter

User Manual (UM) Version 2.3

UM_IOC3_S13b_T06_V2.3 iv Version Date: 05/04/13

Table of Tables

No table of figures entries found.

Page 5: Student Scheduling System User Manual - Spring 2018 · PLAY framework for Java ... to feel comfortable with Java and Web developing and using MySQL like ... 'Play! Framework 2'. Enter

User Manual (UM) Version 2.3

UM_IOC3_S13b_T06_V2.3 v Version Date: 05/04/13

Table of Figures

Figure 1: Starting PLAY Console............................................................................................................................ 7

Figure 2: Courses Page ........................................................................................................................................ 10

Figure 3: Add Course Page .................................................................................................................................. 11

Figure 4: Add Course Group Page ....................................................................................................................... 11

Figure 5: Course Group Page .............................................................................................................................. 12

Figure 6: Requirements Page ............................................................................................................................... 13

Figure 7: Degree Program Page .......................................................................................................................... 13

Figure 8: Documentation Page ............................................................................................................................. 14

Figure 9: Degree Selection Page .......................................................................................................................... 15

Figure 10: Degree Selection Page - Courses ......................................................................................................... 16

Figure 11: Study Plan Page .................................................................................................................................. 16

Figure 12: No Study Plan Page ............................................................................................................................ 17

Figure 13: Course Add Page ................................................................................................................................ 18

Figure 14: Course Edit Page ................................................................................................................................ 19

Figure 15: Missing Login Screen .......................................................................................................................... 19

Figure 16: Degree Program Add Page ................................................................................................................. 20

Page 6: Student Scheduling System User Manual - Spring 2018 · PLAY framework for Java ... to feel comfortable with Java and Web developing and using MySQL like ... 'Play! Framework 2'. Enter

User Manual (UM) Version 2.3

UM_IOC3_S13b_T06_V2.3 1 Version Date: 05/04/13

1. Introduction

1.1 System Overview

The purpose of Student Scheduling System is to provide a study plan creation facilitator for both undergrad students and faculty of Steven’s Institute of Technology.

With current manual method, forming a single study plan for a single student may take hours of

collaborative work of advisors and students and regarding each student has different course history or plans, they need to form unique study plan for the majority of the students.

By using the Student Scheduling System; this process is automated; in other words, after

entering the data representing his/her course history/graduation plans, a student can get possible study plan generated by the system. And for the administrative side; they can add/remove courses to the system, modify courses’ features/information, form new course groups and create new degree programs. Meanwhile they are also able to delete/modify these course groups, degree programs or even requirements to complete these programs.

1.2 System Requirements

Minimum hardware/software requirements for running the Student Scheduling System are given below under the related headers.

Requirements might show minor differences among the different systems or hardware/OS equipment. Therefore; the given requirements below represent a recommended configuration as well to operate the Student Scheduling System properly.

1.2.1 Hardware Requirements

Server Side Hardware Requirements: Processor : Intel® Xeon E3xxx Processor or equivalent.

Memory : 3GB

Storage : 5GB for database tier

Data Bandwidth : (Relative to the simultaneous numbers of users.) ~1 Mbit/s

Domain Name and Dedicated IP address

I/O Devices for Maintenance Issues

User Side Hardware Requirements: Processor : Intel® Centrino/Ix/Celeron/PentiumIV; AMD Athlon/Phenom/FX processors or

equivalent.

Memory : 1GB free space

Internet Connection

I/O Devices to operate Web Browsers properly.

Page 7: Student Scheduling System User Manual - Spring 2018 · PLAY framework for Java ... to feel comfortable with Java and Web developing and using MySQL like ... 'Play! Framework 2'. Enter

User Manual (UM) Version 2.3

UM_IOC3_S13b_T06_V2.3 2 Version Date: 05/04/13

1.2.2 Software Requirements

Server Side Software Requirements: UNIX Server or Windows Server

Java Runtime Environment 6 or higher.

MySQL Server

PLAY framework for Java

Java Editor (Recommended for maintenance issues)

XAMPP (Recommended for maintenance issues)

Java IDE for maintenance.

User Side Software Requirements:

Windows, Linux, MacOSx or equivalent (mobile) operating system that can operate supported web browsers.

Google Chrome, Mozilla Firefox web browser. (Strongly recommended.)

Java Runtime Environment 6 or higher.

1.2.3 Other Requirements

It is highly recommended for the student users to be familiar about the courses and their course histories, especially in the cases they are transfer students.

For administrative side; it is highly recommended to be familiar about the relations between course groups and their effects on graduation satisfaction.

It is highly recommended for maintainers to feel comfortable with Java and Web developing and using MySQL like relational database software.

2. Installation Procedures

Follow the steps below to complete installation / deploying of Student Scheduling System successfully in given ways for each preference.

Guidelines for installing and deploying PLAY framework are also given under the related section

below.

2.1 Application Deployment

2.1.1 Binary Distributive Compilation for the Target Server

PLAY framework and JDK 6 or later need to be installed on system as prerequisites for the procedures below.

Compilation:

Prepare a new configuration file for your target server by making a copy of student_scheduling_system/application.conf

Page 8: Student Scheduling System User Manual - Spring 2018 · PLAY framework for Java ... to feel comfortable with Java and Web developing and using MySQL like ... 'Play! Framework 2'. Enter

User Manual (UM) Version 2.3

UM_IOC3_S13b_T06_V2.3 3 Version Date: 05/04/13

Windows: copy application.conf application_production.conf Linux: cp application.conf application_production.conf

Set URL, user name and password of MySQL server in the student_scheduling_system/application_production.conf:

db.default.url = "jdbc:mysql://localhost/student_scheduling_system" db.default.user = "root" db.default.pass = "123"

In command line in project folder run: play -Dconfig.file=conf/application_production.conf dist

Find your distributive in student_scheduling_system/dist folder. Note: Project already contains several configuration files: application.conf - Default configuration; used by developers on local machines.

application_cloudbees.conf - Application configuration for www.cloudbees.com (see section: Application deployment on the cloud )

2.1.2 Application Deployment from Binary Distribution

Prerequisites (For Server):

JDK 6 or later

MySQL Server v5 or later

Binary distributive of the application (See section: Binary Distributive Compilation for the Target Server )

Database dump file (From student_scheduling_system/db/initial_data.sql or from production server)

Data Base Deployment:

If DB student_scheduling_system already exists on the server, simply run: mysql --user=root -p student_scheduling_system < initial_data.sql

If DB student_scheduling_system hasn't been created yet (first time deployment), run: echo 'CREATE DATABASE student_scheduling_system;' | mysql --user=root -p mysql --user=root -p student_scheduling_system < initial_data.sql Instead of 'root' you should use your actual MySQL user name. Software Deployment:

Unzip binary project distributive in the desired directory (current directory by default): unzip ./student_scheduling_system_bin_v1.x.zip

Run: ./student_scheduling_system-1.0-SNAPSHOT/start

Page 9: Student Scheduling System User Manual - Spring 2018 · PLAY framework for Java ... to feel comfortable with Java and Web developing and using MySQL like ... 'Play! Framework 2'. Enter

User Manual (UM) Version 2.3

UM_IOC3_S13b_T06_V2.3 4 Version Date: 05/04/13

Note: Binary distributive is compiled from source code by 'play dist' command. It implies that appropriate /application.conf file was provided when the project was compiled. In other words, such configuration parameters as DB URL, user name and password of MySQL server must be set for the target server before distributive compiled by 'play dist' command.

2.1.3 Application Deployment on Cloud

Credentials:

Email: [email protected]

Email password: Scheduling!23

Cloud service: http://www.cloudbees.com

Username on cloud: alex588

Email used to login the cloud: [email protected]

Password to login to the cloud: Scheduling!23 Prerequisites (Local Machine):

JDK 6 or later.

BeesSDK (see installation instructions here: http://developer.cloudbees.com/bin/view/RUN/BeesSDK )

MySQL Workbench (see installation instructions here: http://dev.mysql.com/downloads/tools/workbench/ )

Binary distributive of the application (see section: Binary distributive creation for target server).

Database dump file (from student_scheduling_system/db/initial_data.sql or from production server)

BeesSDK is a set of utilities from cloudbees. You just need to download distributive (zip archive) from the website and unzip it. After that you can run it from /cloudbees-sdk-1.3.1 folder by using 'bees' command. Deployment (from local machine to the cloud): For general instructions on how to deploy PLAY framework applications on cloudbees.com; you can find useful resources here: http://wiki.cloudbees.com/bin/view/RUN/Playframework If you need to deploy new version of application software on already operating server skip steps 1-5 and do only step 6. If you need to restore data on the operating server, do step 5.

1. Create a new application called 'app': In web browser open http://www.cloudbees.com/ Login the system using credential above. Then click 'ClickStart' (top left corner) and select 'Play! Framework 2'. Enter application name: app

2. Create DB called 'application_db', in command line run: bees db:create application_db

Page 10: Student Scheduling System User Manual - Spring 2018 · PLAY framework for Java ... to feel comfortable with Java and Web developing and using MySQL like ... 'Play! Framework 2'. Enter

User Manual (UM) Version 2.3

UM_IOC3_S13b_T06_V2.3 5 Version Date: 05/04/13

You will need to enter a unique user name and password for this DB. As result you will see: Database Username (must be unique): appdbuser Database Password: appdbuser1 database created: application_db

3. Bind application and DB: bees app:bind -a app -db application_db As result you will see:

application - student-scheduling/app bound to cb-db:student-scheduling/application_db as application_db

4. Update student_scheduling_system/application.conf, so that:

db.default.url="jdbc:mysql://ec2-23-21-211-172.compute-1.amazonaws.com/application_db" db.default.user=appdbuser db.default.password=appdbuser1 Then build a binary distributive: play dist You can find DB configuration parameters by calling: bees db:info application_db And it will show: Database name : application_db Account : student-scheduling Status : active Master : ec2-23-21-211-172.compute-1.amazonaws.com:3306 Port : 3306 Username : appdbuser

5. Populate DB with initial data: Run MySQL Workbench (graphical tool), connect to the DB using credential listed earlier ("New server instance" button).

Then press "Manage Import / Export" button and select section "Data Import / Restore". Then select database dump file in field "Import from self contained file". Select Database 'application_db' and press import.

6. Deploy binary distributive: bees app:deploy -a app -t play2 student_scheduling_system-1.0-SNAPSHOT.zip You should be able to see: Application parameters: {containerType=play2} ........................uploaded 25% ........................uploaded 50% ........................uploaded 75% ........................upload completed deploying application to server(s)... Application student-scheduling/app deployed: http://app.student-scheduling.cloudbees.net

Page 11: Student Scheduling System User Manual - Spring 2018 · PLAY framework for Java ... to feel comfortable with Java and Web developing and using MySQL like ... 'Play! Framework 2'. Enter

User Manual (UM) Version 2.3

UM_IOC3_S13b_T06_V2.3 6 Version Date: 05/04/13

2.1.4 Application Deployment from Project Source Code Archive

Deploying on the Lunux/Unix server o Unzip the project archive in the desired directory (current directory by default): unzip

./student_scheduling_system_v1.x.zip o Deploy DB:

Set URL, user name and password of MySQL server in the student_scheduling_system/application.conf:

db.default.url = "jdbc:mysql://localhost/student_scheduling_system" db.default.user = root db.default.pass = ""

Erase existing instance of DB (optional): ./student_scheduling_system/db/db_drop_schema.sh

Initialize DB schema:

./student_scheduling_system/db/db_schema.sh

Initial DB filling: ./student_scheduling_system/db/db_init_values.sh

o Change directory to the project folder:

cd ./student_scheduling_system

o Run PLAY (make sure you have updated your PATH environment variable, so that play directory is there): play

o Now in play console type:

start 8080 where 8080 - is a port number. You can use any available port number.

After this point; application should be available here: http://yourhostname:8080/ where 'yourhostname’ is your server's name or IP address.

Deploying on the Windows server

o Unzip the project archive student_scheduling_system_v1.x.zip in the desired directory.

o Deploy DB: Set URL, user name and password of MySQL server in the

student_scheduling_system/application.conf:

db.default.url = "jdbc:mysql://localhost/student_scheduling_system" db.default.user = root db.default.pass = ""

Erase existing instance of DB (optional):

student_scheduling_system/db/db_drop_schema.bat

Initialize DB schema: student_scheduling_system/db/db_schema.bat

Page 12: Student Scheduling System User Manual - Spring 2018 · PLAY framework for Java ... to feel comfortable with Java and Web developing and using MySQL like ... 'Play! Framework 2'. Enter

User Manual (UM) Version 2.3

UM_IOC3_S13b_T06_V2.3 7 Version Date: 05/04/13

Initial DB filling:

student_scheduling_system/db/db_init_values.bat

o Change directory to the project folder: cd student_scheduling_system

o Run play (make sure you have updated your PATH environment variable, so that play

directory is there): play

o Now in play console type:

start 8080 where 8080 - is a port number. You can use any available port number.

After that application should be available here: http://yourhostname:8080/ where 'yourhostname' is your server's name or IP address.

Enter the domain address in address bar of web browser.

Figure 1: Starting PLAY Console

2.1.5 Application Database Import / Export

Prerequisites: Client : MySQL Workbench (see installation instructions here:

http://dev.mysql.com/downloads/tools/workbench/ ) Server : MySQL sever v5 or later (see installation instructions here:

http://dev.mysql.com/downloads/mysql/ ) XAmpp bundle tool is recommended.

Page 13: Student Scheduling System User Manual - Spring 2018 · PLAY framework for Java ... to feel comfortable with Java and Web developing and using MySQL like ... 'Play! Framework 2'. Enter

User Manual (UM) Version 2.3

UM_IOC3_S13b_T06_V2.3 8 Version Date: 05/04/13

Database Import on the Server:

If DB student_scheduling_system already exists on the server, simply run: mysql --user=root -p student_scheduling_system < initial_data.sql

If DB student_scheduling_system hasn't been created yet (first time deployment), run: echo 'CREATE DATABASE student_scheduling_system;' | mysql --user=root -p mysql --user=root -p student_scheduling_system < initial_data.sql

Instead of 'root' you should use your actual MySQL user name.

Instead of 'initial_data.sql', you should use your actual database dump file. DB Export on the Server: mysqldump student_scheduling_system --user=root -p > ./2013_04_18__19_36_snapshot.sql Database Import/Export on the Cloud:

For more detailed information, you can refer to http://www.cloudbees.com

Use MySQL Workbench and instructions from http://wiki.cloudbees.com/bin/view/RUN/DatabaseExport

Migration from the cloud to a Linux/Windows server:

Export DB on the cloud to a dump file

Then use section 'Application deployment from project source code archive' to deploy the application.

2.2 Installing Play Framework

To run the Play framework, you need JDK 6 or later.

If you are using MacOS, Java is built-in. If you are using Linux, make sure to use either the Sun JDK or OpenJDK. (Not gcj, which is the default Java command on most Linux distros.) If you use Windows, just download and install the latest version JDK package.

Please ensure that you have the java and javac commands in the current PATH. (You can check

this by typing java -version and javac -version at the shell prompt)

Download the binary package

Download the Play 2.0 binary package (take the latest 2.0 RC) and extract the archive to a location where you have both read and write access. (Running PLAY writes some files to directories within the archive, so do not install to /opt, /usr/local or anywhere else you would need special permission to write to those locations.)

Add the play script to your PATH.

Page 14: Student Scheduling System User Manual - Spring 2018 · PLAY framework for Java ... to feel comfortable with Java and Web developing and using MySQL like ... 'Play! Framework 2'. Enter

User Manual (UM) Version 2.3

UM_IOC3_S13b_T06_V2.3 9 Version Date: 05/04/13

For convenience, you should add the framework installation directory to your system PATH. On UNIX systems, this means doing something like: export PATH=$PATH:/path/to/play20 On Windows you will need to set this in the global environment variables. This means update the PATH in the environment variables and do not use a path with spaces between. If you are on UNIX, make sure that the PLAY script is executable (otherwise do a chmod a+x play). Check that the play command is available From a shell, launch the play help command. $ play help

If everything is properly installed, you should see the basic help of PLAY framework. The URL for that is: http://www.playframework.com/documentation/2.1.1/Home

2.3 Re-installation

Delete the path from the path address bar under environment settings.

Execute db_drop_schema under db directory in source files directory for database reset.

Delete the directory includes source files and .java classes from the hard-drive. Stop the PLAY! Framework (Ctrl+d), clean the workspace. Exit from PLAY! Console.

Repeat the procedure for initial installation.

2.4 De-installation

Follow the steps below to successfully uninstall Student Scheduling System from the server.

Delete the path from the path address bar under environment settings.

Execute “db_drop_schema” under “db” directory in source files directory for database reset.

Delete the directory includes source files and .java classes from the hard-drive.

Stop the PLAY! Framework (Ctrl+d), clean the workspace. Exit from PLAY! Console.

Delete the PLAY! Directory from the hard-drive.

2.5 Localhost Configuration

Download and Install XAMPP - http://www.apachefriends.org/en/xampp-windows.html

Launch XAMPP and make sure that both MySQL and Apache are checked for running and start them by clicking start buttons.

Add the mysql/bin file to your class path. It should be present where you installed XAMPP. In common case, it is at "G:\xampp\mysql\bin". After adding the path, click on Save button.

Go to your project directory and navigate to the db directory.

Double click db_schema.bat and db_init_values.bat (with the same order) to start database operation.

Page 15: Student Scheduling System User Manual - Spring 2018 · PLAY framework for Java ... to feel comfortable with Java and Web developing and using MySQL like ... 'Play! Framework 2'. Enter

User Manual (UM) Version 2.3

UM_IOC3_S13b_T06_V2.3 10 Version Date: 05/04/13

3. Operational Procedures

For the Administrative Users:

On login screen; type defined user name and password in related input boxes. Then click on the login button. The system will check your authorization for related side admin or student.

Admins can change password of any user role (Admin, Director and Student) from the link Reset Password on the left side of the screen.) Directors can only change their own password by using the same link. Students cannot change passwords due to security concerns and because they do not need any private information stored in database or to build a study plan, they do not need a password either. To change the password;

o Enter your user name (i.e. admin) o Enter your old password. o Enter your new password twice for ensuring there is no typing error. Click Submit.

You can return the homepage by clicking on Home button at any time.

From the menu on the left of the screen; select the desired section. There are also links representing recent path in breadcrumbs form at each page’s top section to return back.

o For Administrative Users: Courses: The courses and the information related to them in database are shown

in the table as a list. To add a new course; click on the Add Course button on top of the list. To edit a course, click on the Edit button next to the course’s title. To delete a course, click on the Delete button next to the course’s title and confirm the operation on alert box by simply clicking on the “Yes”.

Figure 2: Courses Page

Add New Course: You should enter the Title in a string form (the system will produce abbreviation from that title i.e. HUM, CS), Course Numbers / Credits as integers, “on campus” / “online” information by checking the related checkboxes. Finally, for the Prerequisites (Prereq) and Corequisites; you should enter those courses’ names as a combination of Prefix and Course Number (i.e. CS105) by leaving a space between different courses (if there are any). Click on the Submit button to add the course.

Page 16: Student Scheduling System User Manual - Spring 2018 · PLAY framework for Java ... to feel comfortable with Java and Web developing and using MySQL like ... 'Play! Framework 2'. Enter

User Manual (UM) Version 2.3

UM_IOC3_S13b_T06_V2.3 11 Version Date: 05/04/13

Figure 3: Add Course Page

Course Groups: The course groups and their related information are shown on

the table on this page. To edit/delete any course group, click on the Delete or Edit button next to the related course’s name. To add/form a new course group, click on the Add New Course Group button on top of the list.

Add New Course Group: You should enter the name of the new course group in related text box and the abbreviation for this particular course group in the given text boxes. And regarding which way is desired to form the new course group, either List of Course or Combination of Groups should be selected. Click on the Submit button after the required information is entered.

Figure 4: Add Course Group Page

o List of Courses: The combination of Prefix and Course number

(i.e. CS105) should be entered in this box by leaving one space between them if this radio button is selected.

Page 17: Student Scheduling System User Manual - Spring 2018 · PLAY framework for Java ... to feel comfortable with Java and Web developing and using MySQL like ... 'Play! Framework 2'. Enter

User Manual (UM) Version 2.3

UM_IOC3_S13b_T06_V2.3 12 Version Date: 05/04/13

o Combination of Courses: The abbreviation of desired course groups should be entered in this text box by leaving one space between them to form a new course group including already existing course groups.

Figure 5: Course Group Page

Requirements: Existing requirements and information related to them are shown

in the table on this page. To edit/delete a requirement; click on the Edit or Delete button next to the name of each existing requirement. To add a new requirement, click on the Add New Requirement button on top of the list.

Add New Requirement: Enter the Name and the Abbreviation for each of the new requirement. Select the requirement type and select the required information for the selected requirement if needed (i.e. for “Simple”). It will be added to the list on the previous Requirements page. Click on the Submit button after the required information is entered. Requirement types are given below:

o Simple (Select group) o Degree Specific Prerequisite o Degree Specific Corequisite o Predefined Semester (Select semester) o Combination

Page 18: Student Scheduling System User Manual - Spring 2018 · PLAY framework for Java ... to feel comfortable with Java and Web developing and using MySQL like ... 'Play! Framework 2'. Enter

User Manual (UM) Version 2.3

UM_IOC3_S13b_T06_V2.3 13 Version Date: 05/04/13

Figure 6: Requirements Page

Degree Programs: The offered “degree programs” exist in the database are

shown on this page. To edit/delete an existing degree program, click on the Edit or Delete button next to its related degree program. To add a new degree program, click on the Add New Degree Program link on top of the list.

Add New Degree Program: Enter the desired name of the new degree program in the related text box. After that, select the Requirements among the existing ones in database which are required to satisfy to graduate from this particular degree program. Click on the Submit button after the required information is entered.

Figure 7: Degree Program Page

Page 19: Student Scheduling System User Manual - Spring 2018 · PLAY framework for Java ... to feel comfortable with Java and Web developing and using MySQL like ... 'Play! Framework 2'. Enter

User Manual (UM) Version 2.3

UM_IOC3_S13b_T06_V2.3 14 Version Date: 05/04/13

Documentation: You can get the desired documentation/manual by clicking on the related links on this page.

i.e. User Manual

Figure 8: Documentation Page

Page 20: Student Scheduling System User Manual - Spring 2018 · PLAY framework for Java ... to feel comfortable with Java and Web developing and using MySQL like ... 'Play! Framework 2'. Enter

User Manual (UM) Version 2.3

UM_IOC3_S13b_T06_V2.3 15 Version Date: 05/04/13

For the Student Users:

On login screen; type given User Name and Password to login. Then click on the Submit Query button.

You can return the homepage by clicking on Home button at any time.

To login as a “student” will lead you to the “Degree Selection” screen. At the top, there are links representing recent path in breadcrumbs form to return back.

Figure 9: Degree Selection Page

o For Student Users:

Select Desired Degree from the list with the same title. (i.e. CS_Entering_2011_Starting_With_CS115)

Enter the Year of Entry as degree catalog year in the related input box. (as an integer form i.e. 2008)

Enter the Desired Number of Semesters in the given input box as an integer (i.e. 8). Note that; if there is no possible study plan for the given number of semester, the system will not be able to provide a plan naturally.

Click on the Submit Query button after entering the required information.

Page 21: Student Scheduling System User Manual - Spring 2018 · PLAY framework for Java ... to feel comfortable with Java and Web developing and using MySQL like ... 'Play! Framework 2'. Enter

User Manual (UM) Version 2.3

UM_IOC3_S13b_T06_V2.3 16 Version Date: 05/04/13

Figure 10: Degree Selection Page - Courses

From screen shown above:

Select minimum and maximum number of courses desired to be taken in each semester.

And for each requirement (they are listed in order); select the courses taken before or wanted to be taken particularly, besides its location and term only as optional. It should be noted that too narrow specifications may lead to no study plan solution found by the system.

If no course is selected within these course groups shown or there is are missing course/courses, the system will assign course on its own.

Click on the Submit Query button. Study plan screen will be retrieved after the system builds a study plan.

Figure 11: Study Plan Page

Courses for constructed study plan are listed right section of their related semesters and year.

Page 22: Student Scheduling System User Manual - Spring 2018 · PLAY framework for Java ... to feel comfortable with Java and Web developing and using MySQL like ... 'Play! Framework 2'. Enter

User Manual (UM) Version 2.3

UM_IOC3_S13b_T06_V2.3 17 Version Date: 05/04/13

Courses (prefix and number) in red color are the courses which the user particularly selected. Ones in white are the courses which the system selected in place of the user.

If the system cannot construct a valid study plan, it will show “No Study Plan” page as a result. The reasons may be too few semesters, non-correlated courses (i.e. prerequisites) or too few maximum course numbers per semester. In other cases, desired classes might not be available on those selected semesters either.

Figure 12: No Study Plan Page

In such cases (with too tight or too loose constraints), it may take up to one minute for system to construct a study plan or figure that there is no valid study plan with given constraints.

To overcome these problems, relieve some of the constraints you gave to the system as inputs. That is sensible to start this relaxation process with the constraint with the least priority.

Page 23: Student Scheduling System User Manual - Spring 2018 · PLAY framework for Java ... to feel comfortable with Java and Web developing and using MySQL like ... 'Play! Framework 2'. Enter

User Manual (UM) Version 2.3

UM_IOC3_S13b_T06_V2.3 18 Version Date: 05/04/13

4. Troubleshooting

4.1 Frequently Asked questions

Do I need to login either as a student or an administrator to interact with the system? o Yes, to build a study plan as a student, you need to login to the system with your

personal credentials (input information); and to get access to the actions of administrative side like adding/deleting courses/requirements/degree programs, you need to login as an admin with individual credentials as well.

For “Course Add” function; is there any preferred format to enter prerequisites and corequisites? o Yes; you need to enter these course related information with such format

<prefixes><course number> with space/and/or between each course. For example: “CS105 and CS125”; “CS105 CS145”; CS105 or CS201” and so on.

Figure 13: Course Add Page

For “Edit Course” function; is there a preferred format to enter prerequisites and corequisites? o Yes, it requires the same format with the inputting of “Course Add” function as below:

<prefixes><course number> with space/and/or between each course. For example: “CS105 and CS125”; “CS105 CS145”; CS105 or CS201” and so on.

Page 24: Student Scheduling System User Manual - Spring 2018 · PLAY framework for Java ... to feel comfortable with Java and Web developing and using MySQL like ... 'Play! Framework 2'. Enter

User Manual (UM) Version 2.3

UM_IOC3_S13b_T06_V2.3 19 Version Date: 05/04/13

Figure 14: Course Edit Page

4.2 Error Codes and Messages

Login action: login = xxx, password: xxx: This error means that you entered wrong login information; the error might be either in username or password or both. The information you entered and the ones in database do not match. In case you leave one of the boxes blank, an error message will appear as below.

Figure 15: Missing Login Screen

Page 25: Student Scheduling System User Manual - Spring 2018 · PLAY framework for Java ... to feel comfortable with Java and Web developing and using MySQL like ... 'Play! Framework 2'. Enter

User Manual (UM) Version 2.3

UM_IOC3_S13b_T06_V2.3 20 Version Date: 05/04/13

Blank Screen (soon to be filled with a valid error message screen) : This means that you did not enter sufficient information to commit the action you desire. For example; to add a new Degree Program, you must enter Degree Program Name and select at least one of the checkboxes which belong to existing requirements on database.

Figure 16: Degree Program Add Page

4.3 Note

CCD : Core Capability Drive-through

Courses to be added for initial tests are stated in the supporting document of “Demonstration Guideline”.

Initial version of system involves actual course and requirements data taken from Steven’s Institute of Technology webpage.

Administrators should get their authentication initials in person from system manager.

There is no login info required for student side due to the fact that there is no personal information of students needed to build a study plan.