Information

This explains the process involved with installing and getting started using the Evaluation System tool.

Installation

The EvalSys group is currently at work on a QA effort for a new release of the EvalSys tool. Those who are interested in evaluating the tool may want to check out trunk until the next QA release candidate is available.

  1. Download the source code from Subversion (choose the most recent tag in most circumstances):
    Tags available here: https://source.sakaiproject.org/contrib/evaluation/tags/
  2. Put the source code into your sakai source directory in a folder called evaluation
  3. Add jobscheduler project if on a version of Sakai older than 2.4.x (required)
    1. Checkout jobscheduler into your sakai source directory (use subclipse or the command below)
      svn co https://source.sakaiproject.org/svn/jobscheduler/branches/aaronz_2-4-x jobscheduler
    2. Build job scheduler using maven (mvn clean install sakai:deploy / maven sakai) from within the jobscheduler folder
      See notes below related to the polling job.
  1. Add entity broker project (required for Sakai versions older than 2.6, otherwise, you already have it)
    1. Checkout entity broker 1.3.3+ into your sakai source directory (use subclipse or the command below)
      svn co https://source.sakaiproject.org/svn/entitybroker/tags/entitybroker-1.3.6/ entity-broker
    2. Build entity broker using maven (mvn clean install sakai:deploy / maven sakai) from within the entity-broker folder
  2. Add hierarchy project (required for trunk and eval 1.2+)
    1. Checkout hierarchy into your sakai source directory (use subclipse or the command below)
      svn co https://source.sakaiproject.org/contrib/caret/hierarchy/tags/hierarchy-1.2.4/ hierarchy
    2. Build hierarchy using maven (mvn clean install sakai:deploy / maven sakai) from within the hierarchy folder
    3. (maybe not necessary, but works for Sakai 2.6.2 and hierarchy 1.2.4) Adapt the parent version tag in hierarchy/pom.xml to your current Sakai version.
  3. If using trunk revision <= 67204 (maybe even for higher revisions) and Sakai 2.6.2. Do this also if you get some strange "dependencies.dependency.version missing" errors.
    1. Run the Kernel K1 conversion scripts from the evaluation directory: http://confluence.sakaiproject.org/display/DOC/Sakai+2.6+Contrib+Tool+Migration+Tips
    2. (maybe not necessary) Adapt the master and parent version tags in evaluation/pom.xml to 2.6.2 (or your current 2.6 version)
      1. evaluation/pom.xml: <sakai.version>2.6.2</sakai.version>
      2. evaluation/pom.xml: <version>2.6.2</version>
  4. As the evaluation system currently depends on Sakai 2.5.4, you may need to update the pom.xml files to reflect the sakai version you are using.
  5. Run maven sakai from within the evaluation folder
  6. Start tomcat and check the log for errors, there should be none if all jars were downloaded and installed correctly

    N.B. When installing the Evaluation System in a clustered environment, be sure to start the servers up one at a time to avoid EVALSYS-957 (which would prevent some servers from starting up)!

Upgrading

If you are upgrading from 1.1 to 1.2.0 then you will need to update your table structure. Running with auto.ddl on will update the tables to the correct structure, however, there will be columns which are nullable which you will need to ensure have no nulls. Running this script will take care of them.
eval-1.2.0-migrate.sql

Getting started

  1. The tool should be added to all My Workspacesfor all users
  2. Set the tool permissions for the maintain role (create_template, begin_evaluation, be_evaluated)
    1. Click Realm
    2. Click !site.template
    3. Click Role Id - maintain
    4. Check the following boxes
      • eval.assign.evaluation
      • eval.be.evaluated
      • eval.write.template
    5. Click the Done Button
  3. Set the tool permissions for the access role (take_evaluation)
    1. Click Realm
    2. Click !site.template
    3. Click Role Id - access
    4. Check the following box
      • eval.take.evaluation
    5. Click the Done Button
  1. #* Note: you will need to set the permissions for all existing sites and it is a good idea to set these permissions for the site.template so they will be inherited in any existing sites
  2. To grant users admin privileges (to make someone a super admin)
    1. Click Realm
    2. Click /site/!admin
    3. Click Grant Ability at top menu
    4. Enter user id
    5. Select role - admin
    6. Click the Save Button

Notes

set FOREIGN_KEY_CHECKS=1;