Changes

Jump to: navigation, search

Otts documentation

707 bytes added, 16:13, 10 April 2007
Editing a Task's Details
'''This Wiki/Project is a work in progress and is subject to change.'''
 
=INTRODUCTION=
==''Synopsis''==
==''Browser Compatibility''==
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.
==''Getting Started''==
====Master Administrator Login Information====
'''User ID:''' master_admin<br/>
'''Password:''' master_passwordmaster_admin
===System Deployment===
=== Change Password Function ===
Passwords may be changed at any time by clicking on the ''Change Password'' button on the default screen for either login type, see ''Figure 2.3.1''. A floating pop-up box will be displayed, and the screen below will be disabled. You may change 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]]
====Valid Passwords====
====Editing a Project's Details====
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 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]]
====Deleting a Project====
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 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 associated users, timesheets, and tasks are deleted as well. Upon deletion the administrator is prompted with a 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]]
===Manage Users===
An 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 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-z,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.
====Adding an Administrator User====
====Adding a Student User====
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 associated with a project. To do this, select a project name from the ''Project Name'' drop down list (the project ID is 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 (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/>
[[Image:add_student_1.JPG|center|650px|Figure 3.4 - Add Student]]
====Editing a User's Details====
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]]
====Deleting a User====
===Deadlines===
The administrator can create two types of deadlines: individual work deadlines for students, and project work deadlines that are to be completed by all project members.
====Adding a Deadline====
[[Image:add_deadline_1.JPG|center|650px|Figure 3.7.1 - Adding a Individual Deadline]]<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 highlighted with a border in light grey. After all fields have been validated, you may click the "''Add Deadline''" button.
[[Image:add_deadline_2.JPG|center|650px|Figure 3.7.2 - Other Description]]
===Manage Semester===
There must be an active semester, before any other functions can be used. A student may not login if there is no active semester. 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====
===Summary===
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]]
====View Timesheet====
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 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]]
====View Project File====
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]]
==''Student''==
===Current Timesheet===
A student may maintain their current timesheet by adding tasks and 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 miscellaneous tasks are described int he in the following sections Adding a Task, Adding a Miscellaneous Task, Editing a Task, and Editing a 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 submitted manually before the due date by clicking the "''Submit Timesheet''" button. 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 cannot be 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 a timesheet that 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]]
====Adding a Task====
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 Miscellaneous Task====
To add a 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 "''Miscellaneous''", this will show a text box where you can enter a description of the miscellaneous task. Once you have entered a description, you can add the 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 Miscellaneous Task]]
====Editing a 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 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 Miscellaneous Task====
To edit a miscellaneous task, click the "''Edit''" button to the right of the miscellaneous 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 only considered a miscellaneous task if the task takes a small amount of time to complete, usually only a day. Therefore the finish date for a miscellaneous 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 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 miscellaneous task has been started, the weekly hours spent can not be equal to zero. If a miscellaneous 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 miscellaneous 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.6''.<br/>'''Note:''' A miscellaneous 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 Miscellaneous Task]]  
===Past Timesheets===
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]]
====Viewing a Past Timesheet====
====Adding a 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]]
====Editing a Task's Details====
A task may only be edited if the task hasn't been startedtherefore 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 sppear 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]]
====Deleting a Task====
* an Individual Deadline is outlined in Light Steel Blue.
* a Project Deadline and an Individual Deadline due on the same day is outlined in Dark 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]]
1
edit

Navigation menu