CF Web>UserSupport>IudDraft (revision 9)~~EditAttach~~

Inventory System Triage Documentation (Draft)

The inventory system is an online view of the inventory that is currently logged in the equipment database. It can be accessed at https://cs.uwaterloo.ca/cscf/internal/inventory/.

Inventory System Triage Documentation (Draft)

System Specifications

Hardware

Key hardware information related to the system

Software

Is there any server OS information that we can/should add?
System's URL: www150.cs:/software/odyssey-3_apache/data/vhosts/cs.uwaterloo.ca/cscf/internal/inventory
Error log files: www150.cs:/software/odyssey-3_apache/logs/yyyy/mm/dd//www150-errors-cs-ssl
Database:
- Stored on database.cs
- Named equipment
- What type of database is it?

Authentication and Authorization Information

If you are not already logged in, the inventory system will prompt you for a username and password after you view one of its pages. Your WatIAM credentials will give you access and your session won't expire for one day.

People

People that may need to be contacted when working with this system

Administrator: Yan Martel
Point of contact (expert): Daniel Allen
Major clients:

Should be formatted as a list of clients with a sub-list outlining some details specific to each client. These details will vary significantly, however they should generally include how each client uses the system, what they commonly require from USG, and the name of the primary contact. For example:

Major clients:
- CS 100
  - Requires system for use in assignments
  - Usually requires approximately 200 accounts
  - Primary contact: Arthur Conan Doyle (ext. 22790)
- CS 136
  - Requires system for assignments
  - ...

Terminology

Terminology that might be required while performing tasks on this system

For example:

Definitum
- In a defintion the word being defined is the definitum
- Is a fancy word that nobody ever really uses
MarkUs
- A marking system in which students can submit their code and faculty can provide feedback and assign grades
- Originates from the University of Toronto

Guides to the Completion of Scheduled Tasks

Some tasks must be completed on a regular basis. List the scheduled tasks from least frequently recurring to most frequently recurring. Each one must have a steps that describe how to go about completing the task and how often/when the task must be completed. Try to be as detailed as possible.

For example:

Between Every Term

Empty the database

Keeps things clean and organized

Step 1
- Log in to the database.
Step 2
- Run the :purge command
Step 3
- log out

Test: Try to return an entry from the database. If it cannot find the entry, the database was emptied successfully.

Another Example, also completed between every term

This example will help you understand

Step 1
- Do this
Step 2
- Do that
Step 3
- Now do something fancy

Test: How to know if it worked

On the First Day of Every Month

Task Name

A really good purpose

Step 1
- Do this
Step 2
- Do that
Step 3
- Now do something fancy

Test: How to know if it worked

Guides to the Completion of Common Requests

Adding a New User

Users must be added manually:

Do something that will allow you to get to the place where you are able to do step 2
Add a row to users in the following format:

INSERT INTO `users` (
  `userid` , `comment` , `expires` , `unit` , `suFlag` , `swFlag` , `flags`
) VALUES (
  '$USERID', 'added 2012/05/08  ST #82450', '2012-06-01', 'CS', NULL, NULL, ''
);
NOTE: suFlag and swFlag are historical and should be set to NULL. flags can be set to '' for read-only access; 'wmd' for read/write/delete and mass-add/edit access; 'wm' for read/write and mass-add/edit access; and 'w' for read/write access.

Removing a User

Users must be removed manually. You essentially need to edit the users table such that the user's expiration date is in the past.:

Do something that will allow you to get to the place where you are able to do step 2
Modify the row of the user you are trying to delete such that the expiration date is some time in the past. The row will have the following format. The expiration date lies in the expires section.

INSERT INTO `users` (
  `userid` , `comment` , `expires` , `unit` , `suFlag` , `swFlag` , `flags`
) VALUES (
  '$USERID', 'added 2012/05/08  ST #82450', '2012-06-01', 'CS', NULL, NULL, ''
);

Common Failures/Bugs & Troubleshooting

People see a 500 Error <-- Should probably be a bit more descriptive

The issue is probably the fault of CAS. Users will have to remove their browser cookies related to cs.uwaterloo.ca and re-authenticating.

The procedure for deleting cookies varies from browser to browser. http://www.aboutcookies.org/default.aspx?page=2 explains the process for all browsers.

Current Discussions Related to the System

Some systems have important long-term changes that are being discussed. If needed, a summary of each discussion may be included here.