Timeshare UserGuide Admin

From PeacockWiki

Revision as of 03:28, 27 October 2005

Installation Quick Start

Introduction

Timeshare is a database system designed for managing student time sheets and status reports, and providing feedback on these.

Requirements

• HTTP server
• PHP 5.0.4
• MySQL PHP Extensions
• MySQL

Acquiring

Timeshare is available from CVS or from a published archive.

CVS Details

• Server: itc307.peacocktech.com
• User: Anonymous
• Path: /cvs/itc307
• Module: sys

cvs -d :pserver:Anonymous@itc307.peacocktech.com:/cvs/itc307 login
# creates a "timeshare" folder in the current directory
cvs -d :pserver:Anonymous@itc307.peacocktech.com:/cvs/itc307 co -d timeshare/ sys

=Archive

Contained within the archive will be a directory (usually root) containing source extracted from the sys module of the CVS repository. Once located and extracted, installation is the same regardless of weather you are using an archive or CVS.

Installation

Provided the requirements are satisfied, the only installation required is to place a copy of the system in your HTTP servers public directory. After installation you should be able to see a login form by pointing a browser at your server.

Configuration

The default configuration assumes you have MySQL installed on localhost, connect with user name 'root', and no password, and have created a database called 'timeshare'.

If this is your configuration, you should disable the setup wizard, by removing the line in config.php.

$CONFIG['allow_setup']=1;

Most likely you will want to use your own settings, which can be done by running the setup wizard. This is initiated by pointing a web browser at setup/ under the root of your timeshare installation. A setup link is also provided on the navigation bar of the main login page.

The wizard will step you through and ask for the following details

• Server, Port and and Schema to use
• If you want the wizard to create the database
• The user name and password of the user to access the database
• Administrative user name and password (if required) (to create database, and associated user)

The wizard asks for details required to run timeshare, and gives you the option to automatically create the database, and a non-administrative user to access that database.

Upon completion, the wizard will overwrite config.php, and in doing so disable itself. It is recommended you backup config.php in a secure location.

If you should ever need to run the wizard again, it may be re-enabled by adding the following line to config.php

$CONFIG['allow_setup']=1;

It should be noted however, that the setup wizard requires no login, and is accessible to any user who has HTTP access to the server. The setup wizard should only be enabled while the server is unavailable to any untrusted network.

Subject Coordinator Adds and groups students

The following scenarios are based upon the Subject Coordinator Adds and groups students use case. These scenarios are possible paths the subject coordinator may take through this use case.

1. At the beginning of every project, the subject coordinator will need to add students, groups, and group students together.
2. The subject coordinator selects to add a new user. Details entered are first and last names, username, password, role, email address, and administrator privileges. The subject coordinator selects save.
3. The subject coordinator selects to add a new group. They enter a group name, and the session they are active. The subject coordinator selects save.
4. The subject coordinator selects to add a user to a group. They select a session, and select get groups. They then select the user�??s name, and the group, and select save.
5. The system has now added the user to the group.

Subject Coordinator Edits/deletes students

The following scenarios are based upon the Subject Coordinator Edits/deletes students use case. These scenarios are possible paths the subject coordinator may take through this use case.

1. A subject coordinator may need to change any details of a user in the system, or delete the user from the system.
2. The coordinator selects to change the details of a user. The coordinator selects a user, and enters the new details, and selects save.
3. The coordinator selects to delete a user. The coordinator selects the user from the list, and selects delete.

After log in administrator will see four functions is there

• Add a user
• Edit/Delete a user
• Add a group
• Add a user to a group

Adding a user

Clicking Add user link will open another page for adding a user/ users. In this page following fields and button will appear.

First and last names text field box require user�??s actual name. Username, Password and User's Email Address text box are for user�??s login name, password and e-mail address. There is a combo box for User's role in the subject to assign a role for the user. If the user needs administrator access (without administrator access user will have limited access), just click on check box and save these data in database by clicking save button.

Clicking Edit/Delete a user link will open Edit/Delete a user page for editing or deleting a user/ users.

In this page following field and button will appear.

In the text box type a user name what will be edited or deleted and then click �??Get user�?� button.

Same as add user page, every text field will be there. What ever need to edited, after edit click on Save button or if need delete the user just chick on delete button,

Adding a group

Clicking Add a Group link will open Add a Group page for adding a Group/ Groups.

In this page following fields and button will appear.

Group Name text field is for name of a Group like timeshare or Group 5. Session field is for which session is the group belong to. After that, hit save button to save the data in to database.

Adding a user to a group

Clicking Add a user to a group link will open Add a user to a group page for Adding a user to a group.

In this page following fields and button will appear.

selecting a session and click the �??Get group�?� button group member/members name will appear in the Group Member Name combo box and then select the which is wanted. Same as from �??Group�?� combo box select a group name where the user/ Group member will be assigned. after that click on �??Save�?� button to save the data into database.

Click on �??Logout admin�?� for logging out.