STUserManagementRequirements < CF

CF Web>CSCFSoftwareNotes>STUserManagementRequirements (2014-01-07, DanielAllen) (raw view)

---+ ST User Management Web Interface Requirements Document

%TOC%

_The information presented below corresponds to [[https://www.cs.uwaterloo.ca/cscf/internal/request_debug/UpdateRequest?82920][ST#82920]]: ST User Management Web Interface_

---++ Summary

STAddingStaffMember describes a many-step process for adding new users to ST.

Every term, a staff member has to repeat these steps for any new CSCF co-ops, as well as 8 or so MFCF consultants and removing expired MFCF consultants. The first 4 steps are reasonable to automate using a web interface, and will reduce repetitive work for staff.

---++ Overall design
   * intuitive navigation
      * minimum amount of required clicking 
      * clear and descriptive headings
      * links, buttons, etc, are clearly indicative of where they lead
   * logical organisation of staff members
      * divided into !MFCF vs CSCF 
      * subdivided into 
         * temporary (e.g. co-op, auditor)
         * regular (appear on Staff-List) 
         * special access (access to the user management app)
   * common code base
      * good function abstraction
      * descriptive yet concise commenting
   * role-based permissions
      * as opposed to permission based
      * user's type determines access to restricted applications and information

---++ Adding/Editing/Deleting Users
   The application allowing user update will be solely accessible to users in special access roles (namely Stephen and Lori)
      * Lawrence: I'd like to also allow for some backup administrators (namely Trevor, Bill, me, maybe Dave)

---+++ Adding Users 
   * requires input of !WatIAM, !MFCF vs CSCF, temporary/regular/special, start and expiration date
   * present faculty and employee type as options in drop-down menu
   * automatically generate first and last name corresponding to inputted watIam userid
   * deny access to expired users (ensure expired users stay in database)
---+++ Editing Users
   * only allow editing of user's start and expiration date/faculty and employee type
   * editing of !WatIAM userid not presented as option
      * rather, users with changed names must be re-added 
   * editing accessed from staff list, by clicking on user's name 
---+++ Deleting users
   * "delete user" option placed either directly beside user's name or as button on edit user page
   * confirmation alert when delete option is selected
   * "undo delete" button which automatically re-adds newly deleted user
   * completely delete "deleted users" from database 

---++ Security 
   * authentication is done by web server and verified by application using $REMOTE_USER
   * only special access members permitted access to app
   * automatic logging that keeps track of all changes (see "Logs" below)

---++ Logs
   * automatically generated, kept on server or on main site
   * accessible to special access users
   * short description of all updates that occurred including
      * who/what was updated
      * date and time 
      * who performed the update
---++ Tables and other data
   * SQL tables:
      * three existing tables: "ownerOrganization", "owner", and "queue_acl"
         * snapshot: [[%PUBURLPATH%/%WEB%/%TOPIC%/ST-users.sql][ST-users.sql]]
      * former two tables only required when editing regular users -- rarely used
   * Other Data:
      * data contained in =www.cs:/.software/regional/wwwdata_cs.uwaterloo.ca/data/vhosts/cs/cscf/internal/htaccess/staff-all= for step 4 of STAddingStaffMember
      * !WatIAM lookups (via command-line uwdir tool)

---++ Attachments

Attachments

Topic attachments
I	Attachment	History	Action	Size	Date	Who	Comment
sql	ST-users.sql	r1	manage	12.3 K	2014-01-07 - 10:45	DanielAllen	owner, ownerOrganization, and queue_acl tables and data

Topic revision: r8 - 2014-01-07 - DanielAllen

Information in this area is meant for use by CSCF staff and is not official documentation, but anybody who is interested is welcome to use it if they find it useful.

Other Webs

My links
- People
- CERAS
- WatForm
- Tetherless lab
- Ubuntu Main.HowTo
- eDocs
- RGG NE notes
- RGG
- CS infrastructure
- Grad images

Edit