Changes

''oTTs, On-Time Timesheets'', is an online system that allows Professors and Students to work collaboratively on System Design Projects. Seneca College's Computer Studies Department emphasizes strong team building skills, and achieves this through team projects. In the past, student and team progress have been monitored and maintained using conventional word processing documents. These conventional methods have proven to be difficult to synchronize between group members, and tended to lack substantial effort from those who were required to use them. ''oTTs'' creates an online environment where professors and students can work together to create and maintain personal timesheets and group project files. By allowing easy maintenance of projects and students for the professor, and simple manipulation functionality of timesheets and project files for students, ''oTTs'' takes the large task of project maintenance, and makes it simple for all of those involved.

''oTTs'' was created for Seneca College's Bachelor of Software Development degree program for the course courses BTS530 & BTS630 - Major Project Implementation. The developers for this project were:<br/>

oTTs strives to achieve a uniform appearance across all browsers and has been tested extensively on Firefox 2.0 and Internet Explorer 7. Either browser must have javascript Javascript enabled for full and proper functionality to work.

For the best performaceperformance, it is suggested that FireFox 2.0 is used, and the system be viewed in full screen mode under a monitor resolution of 1024x768.

Make sure you have installed and met all system requirements listed in [[#System_Requirements| ''Section 2.1 System Requirements'']]. This document will describe how to install ''oTTs'' assuming these requirements have been met.<br /><br />

# Once the validation is complete, run the script by pressing ''F5''. The query should read ''1 row(s) affected.'' The database is now setup. <br/>[[Image:execute_sql_script.JPG|center|550px|Figure 1.2 - Executing SQL Script]]

'''Password:''' master_passwordmaster_admin

# Using Visual Studio 2005, open the Web Site Project, ''oTTs''.# In the Solutions Explorer, right click the Project's name, and select "Copy Web Site"<br />[[Image:copy_website.JPG|center|250px|Figure 1.3 - Copy Web Site]]# Connect to the Remote Web Site, http://warp.senecac.on.ca/bts630_071a01<br/>[[Image:connect_remote_1.JPG|center|650px|Figure 1.4 - Connect to Remote Web Site]]# Select all of the files from the Local Web Site, and copy them to the Remote Web Site.<br/>[[Image:copy_website_1.JPG|center|450px|Figure 1.5 - Copy to Remote Web Site]]# Check that the web site is running successfully, http://warp.senecac.on.ca/bts630_071a01<br/>

There are two types of accepted users that may log into ''oTTs''; students and administrators. The two login types are distinguished by their e-mail addresses. Students have an email address with the domain of ''"learn.senecac.on.ca"'' and professors have an email address with the domain of ''"senecac.on.ca"''. User The user ID for both login types are is their respective email prefix. For example a user with the email address of ''johndoe@learn.senecac.on.ca'', will have a user id ID of ''johndoe''. Each user's initial password will be e-mailed to them upon creation of their account by the system, the and this default password may be changed at any time by using the "Change Password" function (see [[#Change_Password_Function|''Section 3.1.2 Change Password Function'']] for details).

At the main login screen, users will be authenticated, and directed to their appropriate screen. If a user has forgotten their password, it may be retrieved by clicking on the ''Reset Password Link'' located above the login button (see ''Figure 2.1''). The user must enter an email address that either has the domain of ''senecac.on.ca'' for a administrator, or a domain of ''learn.senecac.on.ca'' for a student. The user must enter a valid email address associated with their account in order to have their password reset and emailed to themby the system. For reference, see ''Figure 2.2''. <br />

Passwords may be changed by the user at any time by clicking on the ''Change Password'' button on the default screenfor either login type, see ''Figure 2.3.1''. A floating pop-up box will be displayed, and the screen below will be disabled. The user can You may change their your password, or cancel the action without any changes occurring. When changing a password you must enter your old password, enter your new password and then confirm it. Once all the fields have been validated, and you've clicked the "''Change''" button, your new password will be emailed to you by the system. The ''Change Password'' box will then disappear and the screen below will become reactivated. For reference , see ''Figure 2.3.2''.<br/>'''Note:''' The Change Password popup box is draggable, you may move it around the screen to any location that you wish.<br/>[[Image:change_password_2_3_1.JPG|center|300px|Figure 2.3.1 - Change Password]]<br/>[[Image:change_password_2_3_2.JPG|center|650px|Figure 2.3.2 - Change Password]]

The role of the Administrator user is to create and maintain all users and their associated projects, as well as semester start/end dates, and project/individual deadlines. When an administrator logs in, the default tabs are Summary, Manage Semester, Manage Project, Manage Users , and Deadlines, all of which are described in the following sections. The layout is shown in ''Figure 3.1''. <br/>[[Image:admin_default_3_1.JPG|center|650px|Figure 3.1 - Administration Layout]]

Every student account must be assoicated associated with a project, in order to do so, a project must be created before adding a student account.

When adding a project, you must enter a unique project ID, and a name for the project. Once all fields have been validated, you may then click the "''Add Project''" button. When a project is added it is marked active, and assoicated associated with the current semester. Only active projects are displayed in the project table. For reference, see ''Figure 3.2.1''.<br/>[[Image:add_project.JPG|center|650px|Figure 3.2.1 - Adding a Project]]

To edit a project's details, press the "Edit" button located to the far right of the project's record. This will load the project's details into the form to the left. The project ID will be disabled, ; however you will be able to edit the project's name. To change a project's ID, you must delete the record entire project (see [[#Deleting_a_Project|''Section 3.2.1.3 Deleting a Project'']]), and then re-add (see [[#Adding_a_Project|''Section 3.2.1.1 Adding a Project'']]) it. For reference, see ''Figure 3.2.2''. <br/>[[Image:edit_project.JPG|center|650px|Figure 3.2.2 - Editing a Project's Details]]

To delete a project, select the check box to the left of the record in the table. You may select more than one project at a time. Once you have selected all of the projects you wish to delete, click the "''Delete Project(s)''" button. You will be promted prompted with a confirmation box, if you wish to continue, please click "''Ok''", if you do not want to continue with the delete, please click "''Cancel''". When a project is deleted, all assoicated associated users, timesheets , and tasks are deleted as well. Upon deletion the administrator is prompted with an confirmation box, confirming the delete. For reference, see ''Figure 3.2.3 and 3.2.4''. <br/>[[Image:delete_project_1.JPG|center|650px|Figure 3.2.3 - Deleting a Project]]<br/>[[Image:delete_projects_2.JPG|center|650px|Figure 3.2.4 - Deleting a Project Confirmation]]

An adminstrator administrator can add or edit two types of users, ; other administrators or students. The type of user being added or edited is determined by which radio button is selected, this . This radio button also determines which user table is displayed to the right. Each user is identified by a user ID, this user ID is automatically assigned by using the prefix of the user's email address. A valid email address must be entered, the prefix can only contain letters (a-zAz,A-Z), number (0-9), and special chacters characters of (- _ or .), they must also be longer than one character. Administration email addresses are automatically assigned the the domain of "''senecac.on.ca''", and student email addresses are automatically assigned the domain of "''learn.senecac.on.ca''". Once all of the corresponding fields have been entered and validated, the user is emailed an auto-generated password, this password should be changed as soon as possible using the ''Change Password'' function (see [[#Change_Password_Function|''Section 3.1.2 Change Password Function'']]). A description of how to add or edit each type of user is listed below.

To add an administrator, make sure the "''AdminstratorAdministrator''" radio button is selected. You must enter a first and last name of the administrator, each may only be a maximum of fifty characters. An email address prefix must also be entered, currently . Currently on the Seneca College Web Mail, a valid professor email address should be formatted as "''first_name.last_name''". The email prefix may only be thirty-six characters long. Once all of the required fields have been entered, click the "''Add Administrator''" button, and the new administrator will be shown in the table to the right. If there are any validation errors, they will be shown below each of the fields. For reference, see ''Figure 3.3''<br/>

To add a student, make sure the "''Student''" radio button is selected. You must enter a first and last name of the student, ; each may only be a maximum of fifty characters. An email address prefix must also be entered, ; the email prefix may only be twenty characters long. Each student must also be assoicated associated with a project, to . To do this , select a project name from the ''Project Name'' drop down list (the project ID is assoicated associated within this drop down list). Once all of the required fields have been entered, click the "''Add Student''" button, and the new student will be shown in the table to the right. If there are any validation errors, they will be shown below each of the fields. <br/> A group of students may be entered at one time by uploading a Comma Separated Value File (CSV), File in the file upload section (see ''Figure 3.4''). <br/>The format of the file should be as follows: '''Last_Name, First_Name, Student_ID, Project_ID''', making sure that each field is separated by a comma. <br/>An example of a record in this file would look like the following:<br/>'''Doe, John, JDoe, bts630_071g01'''<br/>For reference, see ''Figure 3.4''<br/>

To edit a user's details, press the "''Edit''" button located to the far right of the user's record. This will load the user's details into the form to the left. The email prefix will be disabled, and you will only be able to edit the enabled fields (first name and last name for an administrator, and first name, last name, and project ID/project name for a student). Once you have edited the details, you can submit the changes by clicking the "''Update <User Type>''" button.<br/>'''Note:''' If you would like to change the user's email address, you will have to delete the user, and re-add them. (For deleting instructions please see [[#Deleting_a_User|''Section 3.2.2.4 Deleting a User'']], and for adding instructions please see [[#Adding_an_Administrator_User|''Section 3.2.2.1 Adding an Administrator'']] or [[#Adding_a_Student_User|''Section 3.2.2.2 Adding a Student'']]) . For reference, see ''Figure 3.5''.<br/>[[Image:edit_user.JPG|center|650px|Figure 3.5 - Edit User Details]]

To delete a user, select the check box to the left of their record in the table. You may select more than one user at a time. Once you have selected all of the users you wish to delete, click the "''Delete <User Type>''" button. You will be promted prompted with a confirmation box, if you wish to continue, please click "''Ok''", if you do not want to continue with the delete, please click "''Cancel''". For reference, see ''Figure 3.6.1 and 3.6.2''. <br/>'''Note:''' If you are deleting a student, you will also be deleting all associated timesheets and tasks for this student. <br/>[[Image:delete_user_1.JPG|center|650px|Figure 3.6.1 - Delete User]]<br/>[[Image:delete_user_2.JPG|center|650px|Figure 3.6.2 - Delete User]]

The administrator can create two types of deadlines, : individual work deadlines for students, or and project work deadlines that are to be completed by all project members.

To select a certain type of deadline, select the appropreiate appropriate radio button, "''Individual''" or "''Project''". For an "''Individual''" deadline, you may select a "''Timesheet''" or "''Other''". For a "''Project''" deadline, you may select a "''Project File''" or "''Other''", for reference see ''Figure 3.7.1''. <br/>

When selecting "''Other''" for either deadline type, a textbox will appear where you must enter a description for that item. For reference see ''Figure 3.7.2''. Once you have selected your deadline type and item name/description, you must select a due date that falls within the dates of the current semester, ; the current date is hilighted highlighted with a border in light grey. After all fields have been validated, you may click the "''Add Deadline''" button.

To edit a deadline's details, press the "''Edit''" button located to the far right of the user's record. This will load the deadline's details into the form to the left. The current due date will be hilighted highlighted with a dark grey background. You may make changes and then click the "''Update Deadline''" button. For reference, see ''Figure 3.8''.<br/>[[Image:edit_deadline.JPG|center|650px|Figure 3.8 - Editing a Deadline]]

To delete a deadline, select the check box to the left of the record in the table. You may select more than one deadline at a time. Once you have selected all of the deadlines you wish to delete, click the "Delete Deadline" button. You will be promted prompted with a confirmation box, if you wish to continue, please click "Ok", if you do not want to continue with the delete, please click "Cancel". For reference, see ''Figure 3.9.1 and 3.9.2''.<br/>[[Image:delete_deadline_1.JPG|center|650px|Figure 3.9.1 - Deleting a Deadline]]<br/>[[Image:delete_deadline_2.JPG|center|650px|Figure 3.9.2 - Deleting a Deadline Confirmation]]

There must be an active semester, before any other functions can be used. A student may not login if there is no active semester. Adminsitrators Administrators are forced to add, or extend a semester if there is no active one. Once a semester has been added, it may not be deleted, only extended. The only time a semester's start date may be edited is when there are no projects (and therefore no students) associated with the semester ID. To edit the semester's start date, make sure to delete all projects associated with the semester (see [[#Deleting_a_Project|Section 3.2.1.3 Deleting a Project]], and then edit the semester's start date.

Adding a semester is only premitted permitted if a semester has ended, or there is no active semester. To add a semester, make sure that the "''Add''" radio button is selected. You may then select a semester ID from the drop down lists, which is unique and does not exist already. You may then select a start date for the semester, the . The start date must be after the end date of the previous semester (if any), but not later the the selected end date for the newly added semester. You may also select an end date for the semester, which must be later than the start date. Neither dates may be left blank. Once all fields have been validated, you may click the "''Add Semester''" button. For reference, see ''Figure 3.10.1''.When the "''Add''" button is click a confirmation box will appear notifing notifying you of the new addition, see ''Figure 3.10.2''.<br/>'''Note:''' When adding a new semester, the previous semester will be marked as "Inactive", and the old "Inactive" semester will be permanently deleted, and in turn will delete all assoicated associated projects, users, timesheets, tasks and deadlines. <br/>[[Image:add_semester_1.JPG|center|650px|Figure 3.10.1 - Adding a Semester]] <br/>[[Image:add_semester_2.JPG|center|650px|Figure 3.10.2 - Adding a Semester Confirmation]]

Extending a semester is permitted if there currently is an active semester, or the current semester has ended. A semester's end date may be extended at any time, or when the previous semester has ended. You may extend the semester by choosing an end date that is later than the current semester end date. Once the end date has been validated you may click the "''Update Semester''" button. To extend a current semester before it ends, see ''Figure 3.11.1'', to extend a semester that has ended, see ''Figure 3.11.2''. The currently select dates are hilighted highlighted in dark grey.<br/>[[Image:extend_semester_1.JPG|center|650px|Figure 3.11.1 - Extending a Semester]]<br/>[[Image:extend_semester_2.JPG|center|650px|Figure 3.11.2 - Extending a Semester]]

An administrator can view a table that summarizes all projects with their project files, and project memberswith their timesheets. A description of each view is described below in the following sections : View Timesheet and View Project File. A sample layout of the summary screen is shown in ''Figure 3.12''. <br/>[[Image:summarysummary_1.JPG|center|650px|Figure 3.12 - Summary]]

An administrator can view a student timesheet by clicking on the "''X''" for a selected week. If there is no "''X''" for a certain week, the student has not submitted a timesheet. If a student has been added after the start of a semester, and has missed some weeks, there will be no entry for those weeks, and it will appear that they have not submitted a timesheet for the missed weeks. For clarification, when the mouse is hovered over a student's week cell, a tooltip is displayed describing its contents. When a timesheet is selected to be viewed, the student's details are shown in the upper left hand corner, their full name, project ID and project name, and the week number for the timesheet. The timesheet lists all tasks that the student had worked on, when it was started and finished and how many hours were spent that week on the task. The timesheet also displays int he botton in the bottom right hand corner, the total hours spent that week on the project, as well as the total hours they have spent on the project over the semester. For reference, see ''Figure 3.13''.<br/>[[Image:view_timesheet.JPG|center|650px|Figure 3.13 - View Timesheet]]

An administrator can view a project's project file by clicking on the project's name in the summary table. When a name is clicked, the project file will be displayed with the project details (name and ID) in the upper left hand corner. The project file contains all tasks for the project grouped in summary tasks. Each task is displayed along with the student assigned to it, date the task was startedand finished, finished and how many hours in total over the semester the task was worked on. For reference, see ''Figure 3.14''. <br/>[[Image:view_project_file.JPG|center|650px|Figure 3.14 - View Project File]]

The role of the Student user is to maintain their projectgroup's project file, and their personal timesheets for the project's durationsemester. When a student logs in, the default tabs are Current Timesheet, Project File, Past Timesheets, and Reminders, all of which are described in the following sections. The layout is shown in ''Figure 4.1''. <br/>[[Image:default_student.JPG|center|650px|Figure 4.1 - Student Default Page]]

A student may maintain their current timesheet by adding tasks and miscellanious miscellaneous tasks, and editing the start and end dates, as well as and the hours for the current week they have spent on them. Adding and editing task and miscellanious miscellaneous tasks are described int he in the following sections Adding a Task, Adding a Micellanious Miscellaneous Task, Editing a Task, and Editing a Miscellanious Miscellaneous Task. A timesheet is created automatically at the start of every new week. All unfinished tasks from the week before will be carried over into the new timesheet. A timesheet may be submiited submitted manually before the due date by clicking the "''Submit Timesheet''" button, this . This will mark the timesheet as submitted, will record the submitted date, and all unfinished tasks will be carried over to the new week. If a timesheet is submitted before the due date, the timesheet will cannot be uneditable edited further until a new week begins and a new timesheet is created. If a timesheet is not submitted before the due date, after the due date the timesheet will be automatically submitted (however marked as late), and all unfinished tasks will be carried over into the new timesheet for the current week. To see an example of an editable timesheet, see ''Figure 4.2.1'', for an uneditable a timesheetthat cannot be edited, see ''Figure 4.2.2''. <br/>'''Note:''' Only Assigned Task's will be carried over to the new timesheet, miscellaneous tasks will not. <br/>[[Image:current_timesheet_1.JPG|center|650px|Figure 4.2.1 - Editable Timesheet]]<br/>[[Image:current_timesheet_2.JPG|center|650px|Figure 4.2.2 - Uneditable Timesheet]]

To add a task to your timesheet, click the "''Show Add Task''" link. A small window will appear above the timesheet, here you . You should select the task type "''Assigned''", this will show all assigned tasks to you in the drop down list. To add one of those these tasks to your timesheet, select it and click the "''Add''" button. If there are no tasks assigned to you, the drop down list will display "''No Assigned Tasks''" and the "''Add''" button will be disabled. For reference, see ''Figure 4.3.1 and 4.3.2''.<br/>[[Image:timesheet_add_task_1.JPG|center|650px|Figure 4.3.1 - Adding a Task]]<br/>[[Image:timesheet_add_task_2.JPG|center|650px|Figure 4.3.2 - No Assigned Tasks]]

====Adding a Miscellanious Miscellaneous Task====To add a miscellanious miscellaneous task to your timesheet, click the "''Show Add Task''" link. A small window will appear above the timesheet, here you . You should select the task type "''MiscellaneiousMiscellaneous''", this will show a text box where you can enter a description of the miscellaneious miscellaneous task. Once you have entered a description, you can add the miscellaneious miscellaneous task to your timesheet by clicking the "''Add''" button. For reference, see ''Figure 4.4''.<br/>[[Image:timesheet_add_misctask_1.JPG|center|650px|Figure 4.4 - Adding a Miscellaneious Miscellaneous Task]]

To edit a task, click the "''Edit''" button to the right of the task record on the timesheet. The row will become editable, text boxes will appear for the editable fields, start and finish date, and the weekly hours spent. To edit either the start or finished date, you may manually type the date into the field in the format of ''mm/dd/yyyy'' or you may select the date from the drop down calendar. To edit the weekly hours spent, you may enter the hours spent using numbers, using decimal places if needed. Decimal places must be calcuated calculated in the hundreds, to do this you can divide the time you spent in minutes divided by sixty, for example 125/60 = 2.08. If a task has been started, the weekly hours spent can not be equal to zero. If a task is edited with a finished date but no start date, than then the start date, finished date and the weekly hours spent are reset to nothing. Once you are done editing the task details and the fields are validated, you may click the "''Update''" button to the right of the record, and then the record will be updated and return to its normal view state. If you do not want to update your changes you may click the "''Cancel''" button. For reference, see ''Figure 4.5''.<br/>'''Note:''' A task will be carried over to a new week's timesheet if the task is unfinished.<br/>[[Image:timesheet_edit_task.JPG|center|650px|Figure 4.5 - Editing a Task]] ====Editing a Miscellaneious Task====To edit a miscellaneious task, click the "''Edit''" button to the right of the miscellaneious task record on the timesheet. The row will become editable, text boxes will appear for the editable fields, start date and the weekly hours spent. <br/>'''Note:''' There will be no editable textbox for the finished date, since a task is considered a miscellaneious task if the task only takes a small amount of time to complete, usually only a day. Therefore the finish date for a miscellaneious task to automatically recorded as the same date as the start date.<br/>To edit the start date, you may manually type the date into the field in the format of ''mm/dd/yyyy'' or you may select the date from the drop down calendar. To edit the weekly hours spent, you may enter the hours spent using numbers, using decimal places if needed. Decimal places must be calcuated in the hundreds, to do this you can divide the time you spent in minutes divided by sixty, for example 125/60 = 2.08. If a miscellaneious task has been started, the weekly hours spent can not be equal to zero. If a miscellaneious task is edited with a finished date but no start date, than the start date, finished date and the weekly hours spent are reset to nothing. Once you are done editing the miscellaneious task details and the fields are validated, you may click the "''Update''" button to the right of the record, and then record will be updated and return to its normal view state. If you do not want to update your changes you may click the "''Cancel''" button. For reference, see ''Figure 4.6''.<br/>'''Note:''' A miscellaneious task is not carried over to a new week's timesheet if it is unfinished.<br/>[[Image:timesheet_edit_misctask.JPG|center|650px|Figure 4.6 - Editing a Miscellaneious Task]] 

A student may view any past timesheets that are displayed on the ''Past Timesheet'' table. The timesheets displayed for every week and are are divided into two groups, timesheets that have been submitted on time, as well as timesheets that have not been submitted on time. If a student has been added after the start of a semester, and has missed some weeks, there will be no entry for either "''Submitted''" or "''Not Submitted''". For reference, see ''Figure 4.7''. <br/>[[Image:past_timesheetpast_timesheet_1.JPG|center|650px|Figure 4.7 - Past Timesheets]]

You may view a past timesheet by clicking on the ''X'' for the week you wish to view. Your past timesheet will be displayed, with your details in the upper left hand corner, including the week number for the task. All tasks that you have finished during this week and their hours are listed, including miscellaneious miscellaneous tasks. For reference, see ''Figure 4.8''. <br/>[[Image:past_timesheet_view.JPG|center|650px|Figure 4.8 - Viewing a Past Timesheet]]

A summary task may only be deleted where there are no tasks associated with it, therefore a "''Delete''" button will only appear if it is allowed. To delete a summary task, click the "''Delete''" button to the right of the summary task name. A confirmation box will appear, click "''Ok''" to confirm the delete, or "''Cancel''" to cancel the delete. For reference, see ''Figure 4.10.3''<br/>[[Image:project_file_3.JPG|center|650px|Figure 4.10.3 - Deleting a Summary Task]]

To add a task to the project file, click on the "''Add Task''" button that is to the right of a summary task name. A popup window will appear to in the upper right hand corner; you must enter a task name, and select a project member to assign it to. If you do not wish to assign the task, select "''Not Assigned''". Then click "''Add''" button. The popup box will then disappear. For reference, see ''Figure 4.10.4''<br/>[[Image:project_file_4.JPG|center|650px|Figure 4.10.3 - Adding a Task]]

A task may only be edited if the task hasn't been started, therefore a "''Edit''" button will only appear if it is allowed. To edit a task's details, click on the "''Edit''" button to the right of the task name. A popup box will appear in the upper right hand corner. To edit the details, change the name in the ''Task Name'' field, and/or change the assignee, and then click "''Update''". The editing popup box will then disappear. For reference, see ''Figure 4.10.5''<br/>[[Image:project_file_5.JPG|center|650px|Figure 4.10.4 - Editing a Task's Details]]

A task may only be deleted if the task hasn't been started, therefore a "''Delete''" button will only appear if it is allowed. To delete a task, click the "''Delete''" button to the right of the task name. A confirmation box will appear, click "''Ok''" to confirm the delete, or "''Cancel''" to cancel the delete. For reference, see ''Figure 4.10.6''<br/>[[Image:project_file_6.JPG|center|650px|Figure 4.10.6 - Deleting a Task]]

Students are required to meet certain deadlines throughout the duration of the project. Each student is responsble responsible for submitting a weekly timesheet and maintaining their project's project file, as well as several other personal and group deadlines. The calendar to the left visually displays upcoming due dates by hilighting highlighting the due dates with a coloured border for quick analysis. A legend for each type of due date is displayed directly below the calendar. The legend colours are described below: <br/>

* an Indiviual Individual Deadline is outlined in Light Steel Blue.

To the right, a table is display displayed showing a list of upcoming deadlines , detailing the type of deadline, the document description and the due date. For reference, see ''Figure 4.11''.<br/>[[Image:reminders.JPG|center|650px|Figure 4.11 - Reminders]]