Timeshare UserGuide Admin
From PeacockWiki
| Revision as of 03:29, 27 October 2005 (edit) Trevorp (Talk | contribs) (→Acquiring) ← Previous diff |
Current revision (04:39, 28 October 2005) (edit) Trevorp (Talk | contribs) (→TimeShare Administration - add images) |
||
| Line 1: | Line 1: | ||
| {{Timeshare_UserGuide}} | {{Timeshare_UserGuide}} | ||
| - | <div id="comment">Software Installation, technical Info, system setup</div> | + | This document details the instalation, configuration, and maintanence of the Timeshare System. |
| ==Installation Quick Start== | ==Installation Quick Start== | ||
| Line 50: | Line 50: | ||
| <div id="comment">Clinton 17/10/2005 Quick and simple. There is nothing too complicated about the admin's role yet. May get a little more complicated with the addition of the setup of project ts and sr schedule.</div> | <div id="comment">Clinton 17/10/2005 Quick and simple. There is nothing too complicated about the admin's role yet. May get a little more complicated with the addition of the setup of project ts and sr schedule.</div> | ||
| - | ==Subject Coordinator Adds and groups students== | + | ==TimeShare Administration== |
| - | 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. | + | Before using TimeShare, information about the subject participants should have been collected. This information includes; student??s details (name, e-mail, password, and team role), project groups, and session starting date. This information will be used later in the administration process |
| - | #At the beginning of every project, the subject coordinator will need to add students, groups, and group students together. | + | After logging in using your assigned username and password you will be forwarded to the following administrator home page. |
| - | #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. | + | <div class="thumb tnone"><div style="width:502px;"> |
| - | #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. | + | [[Image:Timeshare_Admin_Nav.png]] |
| - | #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. | + | <div class="thumbcaption" ></div></div></div> |
| - | #The system has now added the user to the group. | + | The first step should be to add a session (semester) that you will be administering the system. TimeShare allows for groups and students to start, stop, or defer after any session so the system has to be able to record projects on a per-session basis. |
| + | Clicking the add a new session link will bring up the next form. | ||
| + | <div class="thumb tnone"><div style="width:502px;"> | ||
| + | [[Image:Timeshare_Admin_Session.png]] | ||
| + | <div class="thumbcaption" ></div></div></div> | ||
| + | Session code is created by the year eg 2006, and semester; autumn = 40, spring = 70. Therefore the code for first session 2006 will be 200640. | ||
| - | ==Subject Coordinator Edits/deletes students== | + | The start of session date is used to calculate the due dates of the timesheets and status reports. It is important that this is accurate so timesheets end at midnight Sunday night. Timesheet periods are currently set at 14 days (2 weeks) and Status Reports at 56 days (8 weeks). When the details are correct, chose the add button. |
| - | 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. | + | |
| - | #A subject coordinator may need to change any details of a user in the system, or delete the user from the system. | + | |
| - | #The coordinator selects to change the details of a user. The coordinator selects a user, and enters the new details, and selects save. | + | |
| - | #The coordinator selects to delete a user. The coordinator selects the user from the list, and selects delete. | + | |
| + | The next step is to enter all User Details. From the Admin home page, select ??add a user??. | ||
| <div class="thumb tnone"><div style="width:502px;"> | <div class="thumb tnone"><div style="width:502px;"> | ||
| - | [[Image:Timeshare Admin home.png|500px]] | + | [[Image:Timeshare_Admin_User.png]] |
| - | <div class="thumbcaption" >Administrator??s home page</div></div></div> | + | <div class="thumbcaption" ></div></div></div> |
| + | The ??user?? includes administrators, supervisors, team managers and students, therefore the role list selection should reflect this. From the details about each user collected earlier, fill out the form then press save. There is error checking on this form to ensure invalid details are not added to the database. Continue adding until all users are in the database, then return to the home page. | ||
| - | After log in administrator will see four functions is there | + | The next step is to add project group names to the session previously added. |
| - | *Add a user | + | <div class="thumb tnone"><div style="width:502px;"> |
| - | *Edit/Delete a user | + | [[Image:Timeshare_Admin_Group.png]] |
| - | *Add a group | + | <div class="thumbcaption" ></div></div></div> |
| - | *Add a user to a group | + | Group names will relate to the type of project assigned or made up by the project teams. Add all the session??s group names, one at a time, to the same session code added earlier. Return to the admin home page. |
| - | + | ||
| - | ==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. | + | |
| - | <div id="comment">Add screenshot - [[User:Trevorp|TrevorP]] 09:58, 27 Oct 2005 (AUS Eastern Standard Time)</div> | + | The next task is to set the relations of the last 3 tasks by adding a user to a group. |
| - | + | Select ??add user to group??, the following screen 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. | + | <div class="thumb tnone"><div style="width:502px;"> |
| - | + | [[Image:Timeshare_Admin_Group2.png]] | |
| - | Clicking Edit/Delete a user link will open Edit/Delete a user page for editing or deleting a user/ users. | + | <div class="thumbcaption" ></div></div></div> |
| - | + | Choose the correct session to get a list of groups just entered for that session. | |
| - | In this page following field and button will appear. | + | In a similar fashion, select the name of the user, and the group they are assigned to. Once all 3 of the selections match, press the add button. This process should be repeated until all of the users are assigned to their groups, then return to the home page. |
| - | + | ||
| - | <div id="comment">Add screenshot - [[User:Trevorp|TrevorP]] 09:58, 27 Oct 2005 (AUS Eastern Standard Time)</div> | + | |
| - | + | ||
| - | 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. | + | |
| - | + | ||
| - | <div id="comment">Add screenshot - [[User:Trevorp|TrevorP]] 09:58, 27 Oct 2005 (AUS Eastern Standard Time)</div> | + | |
| - | + | ||
| - | 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. | + | |
| - | + | ||
| - | <div id="comment">Add screenshot - [[User:Trevorp|TrevorP]] 09:58, 27 Oct 2005 (AUS Eastern Standard Time)</div> | + | |
| - | + | ||
| - | 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. | + | |
| + | To edit or delete the details of a user, select the ??Edit/Delete a user?? link. You have to type the name or email address of the user you are changing into the test box, press the ??Get User? button to bring up that user??s details. | ||
| + | <div class="thumb tnone"><div style="width:502px;"> | ||
| + | [[Image:Timeshare_Admin_Edit_User.png]] | ||
| + | <div class="thumbcaption" ></div></div></div> | ||
| + | You can then make changes, or delete the entire record. This feature may be used if a student has left the subject, if they want a new password, or their e-mail address needs updating. | ||
| {{Timeshare_UserGuide}} | {{Timeshare_UserGuide}} | ||
Current revision
| Overview | Students | Managers | Supervisors | Administrators |
This document details the instalation, configuration, and maintanence of the Timeshare System.
Contents |
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.
TimeShare Administration
Before using TimeShare, information about the subject participants should have been collected. This information includes; student??s details (name, e-mail, password, and team role), project groups, and session starting date. This information will be used later in the administration process After logging in using your assigned username and password you will be forwarded to the following administrator home page.
The first step should be to add a session (semester) that you will be administering the system. TimeShare allows for groups and students to start, stop, or defer after any session so the system has to be able to record projects on a per-session basis. Clicking the add a new session link will bring up the next form.
Session code is created by the year eg 2006, and semester; autumn = 40, spring = 70. Therefore the code for first session 2006 will be 200640.
The start of session date is used to calculate the due dates of the timesheets and status reports. It is important that this is accurate so timesheets end at midnight Sunday night. Timesheet periods are currently set at 14 days (2 weeks) and Status Reports at 56 days (8 weeks). When the details are correct, chose the add button.
The next step is to enter all User Details. From the Admin home page, select ??add a user??.
The ??user?? includes administrators, supervisors, team managers and students, therefore the role list selection should reflect this. From the details about each user collected earlier, fill out the form then press save. There is error checking on this form to ensure invalid details are not added to the database. Continue adding until all users are in the database, then return to the home page.
The next step is to add project group names to the session previously added.
Group names will relate to the type of project assigned or made up by the project teams. Add all the session??s group names, one at a time, to the same session code added earlier. Return to the admin home page.
The next task is to set the relations of the last 3 tasks by adding a user to a group. Select ??add user to group??, the following screen will appear.
Choose the correct session to get a list of groups just entered for that session. In a similar fashion, select the name of the user, and the group they are assigned to. Once all 3 of the selections match, press the add button. This process should be repeated until all of the users are assigned to their groups, then return to the home page.
To edit or delete the details of a user, select the ??Edit/Delete a user?? link. You have to type the name or email address of the user you are changing into the test box, press the ??Get User? button to bring up that user??s details.
You can then make changes, or delete the entire record. This feature may be used if a student has left the subject, if they want a new password, or their e-mail address needs updating.
| Overview | Students | Managers | Supervisors | Administrators |
