Read Me

README and INSTALLAION

Change Log:
Version 1.01
  - the files 
      settings.php
      smarty/templates/std__header.tpl
      smarty/templates/std__footer.tpl
    were removed from the distribution and replaced by *-sample files. This makes it easier to
    update to a new version of the case study tool without overwriting the cusomized files.
  - TinyMCE updated to version 3.2.2

Version 1.00 - Jan 2009



Case Study Tool Configuration
-----------------------------


SOAP/WSDL Configuration
-----------------------
In the file wslib.php edit $wsdl_root (and probably all the other $wsdl_* variables) to point to the webservices of your Vista server. Notice that in order to work with the PHP5 SOAP library, the wsdl files must not contain any comment tags ("<documentation>", "<wsdl:documentation>", <annotation>)


Content Editor Configuration
----------------------------
TinyMCE
http://tinymce.moxiecode.com/





Technical Concepts
------------------

Page Workflow:
- A user enters the case study tool via one of the pages webct_auth.php / moodle_auth.php / standalone_auth.php , depending on what environment the case study tool is associated to.

- In the *_auth.php pages the later required parameters (user name, case study ID, etc. ) is extracted from cookies, get-parameters, post-parameters, soap-sessions etc. and written to a common set of session variables.

- Then casestudy.php is included. All further processing (form-actions, links) is handled in casestudy.php



Session Variables:
  userID*           unique ID in class. The id may only consist of characters
                    that can be part of a filename (i.e. md5 hash value of
                    the user name).
  userFirstName     first name of current user.
  userLastName      last  name of current user.
  isTeacher*        integer set to "1" if the current user is a teacher. 
                    "0" otherwise.
  studentList*      array of all students of a class.
                    The student list is only needed if the current user is
                    a teacher (userIsTeacher==1)
                    structure:
                      array of 
                        assciative array with 
                          {'ID','firstName','lastName'}
  courseID*         unique course ID. The id may only consist of characters
                    that can be part of a filename (i.e. a hash value).
  courseTitle       optional course title.
  casestudyID*      unique case study ID. The id may only consist of characters
                    that can be part of a filename (i.e. hash value of case
                    study title).
  casestudyTitle    optional case study title.
  

  Note 1: variables marked with '*' are mandatory.
  
  Note 2: courseID concatenated with casestudyID must be overall unique. If 
  they are not, different classes will be working on the same case study.