Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

...

  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/
    • If you are upgrading to version 1.2 there are significant DB changes that will require the evaluation tables to be dropped and recreated,
      see the notes below for the commands to drop the tables (we do not have a migration script at this time)
    • If you want trunk then use the trunk directory instead and checkout with subclipse or use this command:
      svn co https://source.sakaiproject.org/contrib/evaluation/trunk evaluation
  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)
    • NOTE: This is only required if you are on a version of Sakai older than 2.4.x, newer
      versions of Sakai include this already, version must be a custom branch called aaronz_2-4-x
    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 evaluationfolder evaluation folder
    • The evaluation project can be built and deployed with Sakai 2.5.x, 2.6.x, 2.7.x, 2.8.x., or 2.9.x. This is enabled by use of maven profiles. For example, to do a full build of evaluation with Sakai 2.9, you might enter the following maven command on the command line: 

      No Format
      mvn clean install -D sakai2.9
    • This will download all needed jars and compile the source code
    • Maven 1 users: You may need to add the following repositories to your maven 1 build.properties to get all needed jars:
      1. http://source.sakaiproject.org/maven/
      2. http://www2.caret.cam.ac.uk/maven
      3. http://repo1.maven.org/maven/
    • For example: Your build.properties should have this line (or something like it)

      No Format
      maven.repo.remote = http://source.sakaiproject.org/maven/,http://www2.caret.cam.ac.uk/maven/,http://repo1.maven.org/maven/
      
  6. Start tomcat and check the log for errors, there should be none if all jars were downloaded and installed correctly

    Info

    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

...