Changes

From CDOT Wiki
Jump to: navigation, search

Otts documentation

23 bytes added, 00:37, 10 April 2007
m
''Administrator''
==''Administrator''==
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]]
===Manage Projects===
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.
====Adding a Project====
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]]
====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 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]]
====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 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 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 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 of (- _ or .). 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====
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/>
[[Image:add_admin.JPG|center|650px|Figure 3.3 - Add 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 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/>
[[Image:add_student_1.JPG|center|650px|Figure 3.4 - Add Student]]
====Deleting a User====
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]]
===Deadlines===
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.
====Adding a Deadline====
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/>
[[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 hilighted 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]]
====Editing a Deadline====
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]]
====Deleting 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]]
===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. 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.
====Adding a Semester====
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====
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]]
===Summary===
An administrator can view a table that summarizes all projects and project members. 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:summary.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. 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 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====
1
edit

Navigation menu