VULab Web Component 0.1alpha
========================
Main Project Site:  http://wiki.fluidproject.org/display/fluid/Open+Virtual+Usability+Lab
User Manual:        TBA


VULab Web Component
========================
This component of the VULab project controls all aspects of the VULab project aside from the
video/audio recording.


	Overview
	========================
	This application is designed to offer a remote website usability tool. By providing researchers
	with the ability to create "projects" that contain a pre-survey to be shown before the website
	for testing and a post-survey to be shown after.
	
	Tester Workflow Overview
	========================
	1. Sign-up as a Tester
	2. Researcher assigns tester to project
	3. Tester logs into his/her account and clicks on their associated project.
	4. Tester is shown whatever pre-survey the researcher has assigned
	5. Tester is shown the testing website
	6. Tester clicks on "Survey Complete" and is provided the post-survey
	
	
	
phpESP Aspects still in VULab
========================
The core aspects of the VULab project are still governed by the phpESP system. Any components not
outlined below are written by VULab.
The details of phpESP aspects are outlined below.


	1. Core Workflow Handling
		
		Overview
		========================
		The entire admin/login portion of the website works through manage.php using the
		"Where Inclusion System", this has been explained at:
			http://wiki.fluidproject.org/display/fluid/Where+Inclusion+System+Explained
		
		VULab Changes
		========================
		Minimal changes have occured here, and all are contained within the manage.php file.
		
		These changes include:
			
			* addition of .js inclusions into all pages
			* basic interface switching for tester (user) vs. researcher (admin)
			* some basic object population based on page currently view (populate survey, populate
			  roject, etc)
	
	2. Survey Creation
		
		Overview
		========================
		The survey creation system in terms of creating the surveys the selves, and handling all
		database queries (apart from loading data for other components) is entirely phpESP.
		
		This includes:
			
			* the iFrame included into project creation workflow
			* survey creation queries and question panels creation
			* workflow between survey steps
			* 
		
		VULab Changes
		========================
		There have been minimal changes to the core of the phpESP survey creation system, focusing
		around integration with the VULab project creation component and making information
		available to it.
		
		These changes include:
			
			* The most notable change is the removal of the survey "filename" field, which has been
			  placed with an automated survey naming structure.
			
			* There has been a small change in the update_survey function which controls backend
			  for creation/maintenance of survey
			  
			* There has been a session variable that has been made global so that the project
			  management component knows if the survey has been saved or not as the survey creation
			  tool is included with an iframe.
	
	3. Survey Processing
		
		Overview
		========================
		the phpESP system is entirely responsible for the tracking of surveys being taken and the
		viewing. There has been changes to it with gluecode to control the flow but all tracking
		is from phpESP. Obviously the audio/video recording is part of VULab, and it has been
		integrated between the surveys.
		All of the survey tracking comes from the /public/ folder.
		
		VULab Changes
		========================
		As stated in the overview the most changes came from the gluecode that intregrates our
		video/audio capture and post/pre-survey workflow placement.
		
		These changes include:
			
			* the creation of gluebox.php to call the video/audio recording tool
			
			* the creation of project.php to call the pre/gluebox/post survey files to control
			  survey workflow
	
	4. Survey Reporting
	
		Overview
		========================
		The reporting is directly tied to the survey processing so it is currently entirely in the
		phpESP system, its integration is almost non-existant as the pages used are still phpESP
		where include files.
		
		
		VULab Changes
		========================
		There are no changes to this system directly, although the system is being used by VULab
		code
		
			Integration Notes:
			
				* the reporting links are direct link ins to the phpESP reporting system.
				
				* linking occurs in the project view page
				
				* video reporting links are attached to the post-survey reporting page.
				  
	5. User Management/Login
	
		Overview
		========================
		The user registration and login system is currently all within the control of the phpESP
		system without any changes
		
		VULab Changes
		========================
		There are no changes to this system directly, although the system is being used by VULab
		code
		
			Integration Notes:
			
				* the users are integrated into the project invite system to be able to associate
				  testers for a project's survey
				
				* the table "userprojrel" was created to control assoications between users and
				  projects