Difference between revisions of "Otts documentation"

From CDOT Wiki
Jump to: navigation, search
(Before you Begin)
(''Administrator'')
Line 57: Line 57:
  
 
==''Administrator''==
 
==''Administrator''==
The administrator is responsible for setting deadlines, creating accounts, and creating users.
+
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 describe below. (INSERT SCREEN SHOT OF ADMIN DEFAULT)
 +
 
 +
 
 
===Manage Projects===
 
===Manage Projects===
 +
An administrator must create at least one project before creating any student accounts. Each project must have an unique project ID, and a name assoicated with it. (INSERT SCREEN SHOT) Only active projects are displayed in the display list, and when a project is deleted, all assoicated users, timesheets and tasks are deleted as well. Upon deletion the administrator is prompted with an confirmation box, confirming the delete.
 +
 +
 
===Manage Students===
 
===Manage Students===
 
* when adding ''or'' updating a user, password is automatically regenerated and emailed
 
* when adding ''or'' updating a user, password is automatically regenerated and emailed

Revision as of 18:12, 4 April 2007

This Wiki/Project is a work in progress and is subject to change.

INTRODUCTION

Synopsis

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.

Disclaimers

This project site and wikipedia are a student project only. Any opinions, statements or claims expressed here are those of the creators and are not necessarily those of Seneca College. Seneca College's Information Technology Acceptable Use Policy (ITAUP) can be found here.


INSTALLATION

System Requirements

In order to host oTTs, the system requirements are as follows:

  1. Internet Information Service (IIS)
  2. Web server such as warp.senecac.on.ca or hermes.senecac.on.ca
  3. Microsoft SQL Server
  4. ASP
  5. Compatible Browser (see Section 2.2 Browser Compatibility)

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 enabled for full and proper functionality to work.

For the best performace, it is suggested that FireFox 2.0 is used, and the system be viewed in full screen mode.

Getting Started

Before you Begin

Make sure you have installed and met all system requirements listed in Section 2.1 System Requirements (link..?). This document will describe how to install oTTs assuming these requirements have been met.

Database Step Up

  1. Create a database in MS SQL using whichever database name you would like.
  2. Run the MS SQL script provided by oTTs, otts_schema.sql


Note: By default after the script has been executed, there will be a master adminstrator login in the database. It is recommended to use this login in order to create the initial adminstrator login before using the system. It is also highly recommended that the master administrtor login password be changed upon initial login. Since the master administrator has no assigned email address, you must keep a record of the master administrator passsword.

Master Adminstrator Login Information:
User ID: master_admin
Password: master_password

System Deployment



FUNCTIONALITY

Logging In

There are two types of accepted users that may log into oTTs, students and administrators. The two are distinguished by their email addresses, students have email addresses with domains of "learn.senecac.on.ca" and professors have email addresses with domains of "senecac.on.ca". User ID's for both login types are each respective email prefix, for example a user with the email address of johndoe@learn.senecac.on.ca, their user id would be johndoe. Each user's initial password wil be emailed to them upon creation of their account by the administrator, the default password may be changed at any time by using the "Change Password" function (see Section _ for details).

Forgotten Passwords

At the main login screen, users will be autheticated, and directed to the appropriate screen. If a user has forgotten their password, it may be retrieved by clicking the Reset Password Link located above the login button (INSERT SCREEN SHOT). The user must enter a valid email address associated with their account inorder to have their password reset and emailed to them.

Change Password Function

Passwords may be changed by the user by clicking on the Change Password button on the default screen. (INSERT SCREEN SHOT) A floating pop-up box will be displayed, and the screen below will be disabled. The user can change their password, or cancel the action without any changes occuring.

Valid Passwords
Passwords must be at least one character in length, and are case sensitive. A passwor may contain numbers, letters, and most special characters with the exception of single quotation marks.

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 describe below. (INSERT SCREEN SHOT OF ADMIN DEFAULT)


Manage Projects

An administrator must create at least one project before creating any student accounts. Each project must have an unique project ID, and a name assoicated with it. (INSERT SCREEN SHOT) Only active projects are displayed in the display list, and when a project is deleted, all assoicated users, timesheets and tasks are deleted as well. Upon deletion the administrator is prompted with an confirmation box, confirming the delete.


Manage Students

  • when adding or updating a user, password is automatically regenerated and emailed
  • A CSV file must contain the following fields in the following order separated by commas :

Last Name, First Name, Student ID, Project ID

for example we can have :

Doe, John, JDoe, bts630_071g01

Deadlines

The administrator can create any number of deadlines for the current semester.

Manage Semester

Summary

Student

Current Timesheet

Past Timesheets

Project File

The project file contains all the tasks that a group has completed or is going to complete. All tasks are broken in Summary Tasks that categorizes these tasks. For example, Create Tables might be one task in your Database category.

Time is broken into hours, and fractions if necessary. For example, 3.33 hours represents 3 hours and 20 minutes. Which you can get by calculating (time you spent in minutes)/60

Reminders

The calendar has coloured days for a quick analysis of future deadlines.

  • Purple days represent deadlines that the entire team is responsible for
  • Green days represent individual deadlines and timesheet deadlines