Download

Mneme 2.1.36

Mneme is distributed as source only, and is configured for Sakai 10.1.

  1. Install the Mneme Database
  2. Download Mneme Source And Modify Your Sakai Distribution
  3. Configure Mneme
  4. Use the Mneme Admin Tools to Install Permissions
  5. User Documentation
  6. What’s New in Mneme 2.1.36 (and earlier versions)?
  7. License

1. Install the Mneme Database

Before you start up your Sakai instance with Mneme, you must install Mneme’s tables in your database. Mneme supports Oracle and MySQL – HSQL is not supported.

The easiest way to install Mneme’s tables is to let Sakai’s auto.ddl feature do it for you as your first app server starts up. Make sure that auto.ddl is enabled for the app server, and make sure you start up just a single app server. auto.ddl will run Mneme’s ddl.

Most production environments will prefer to manually run the Mneme ddl, possibly modified for tablespace and other local concerns. There are 4 ddl files to run – the order does not matter. These are found in the source code under mneme/mneme-impl/impl/src/sql/<vendor>, where “<vendor>” is either “mysql” or “oracle”. The 4 files that contain Mneme’s ddl are:

mneme_assessment.sql

mneme_pool.sql

mneme_question.sql

mneme_submission.sql

Updates

To update from a previous version of Mneme, notice the other sql files distributed with Mneme. These take your database up to the current version. You need to run all the updates that you have not yet run, to take your particular version of the database up to the latest. You may need to examine your current Mnene database definition, compare it to the latest Mneme DDL files, and note these update sql files to craft the particular update that works for you.


 

2. Download Mneme Source And Modify Your Sakai Distribution

To add Mneme to your Sakai 10.1, you will need to:

  • Download the Mneme software from SVN, into your Sakai 10.1 source folder:

sakai> svn co https://source.sakaiproject.org/contrib/etudes/etudes-util/tags/1.0.25/ etudes-util

sakai> svn co https://source.sakaiproject.org/contrib/etudes/ltiContact/tags/1.2/ ltiContact

sakai> svn co https://source.sakaiproject.org/contrib/etudes/ambrosia/tags/2.1.35/ ambrosia

sakai> svn co https://source.sakaiproject.org/contrib/etudes/mneme/tags/2.1.36/ mneme

  • Update the Sakai base pom.xml

Add lines to the Sakai root pom.xml build profile section that you are using (the default is the “full” profile). These instruct Maven to include the Mneme sources in the build.

<module>etudes-util</module>
<module>ltiContact</module>
<module>ambrosia</module>
<module>mneme</module>

  • Update the Sakai master pom.xml

Add lines to the Sakai master/pom.xml properties and dependency management section for the Etudes artifacts.

Properties: add to the <properties> section:

<etudes.util.version>1.0.25</etudes.util.version>
<lticontact.version>1.2</lticontact.version>
<ambrosia.version>2.1.35</ambrosia.version>
<mneme.version>2.1.36</mneme.version>

Dependencies: add to the <dependencyManagement><dependencies> section:

<dependency>
<groupId>org.etudes</groupId>
<artifactId>etudes-util-api</artifactId>
<version>${etudes.util.version}</version>
<scope>provided</scope>
</dependency>

<dependency>
<groupId>org.etudes</groupId>
<artifactId>etudes-util-util</artifactId>
<version>${etudes.util.version}</version>
</dependency>

<dependency>
<groupId>org.etudes</groupId>
<artifactId>etudes-lticontact-util</artifactId>
<version>${lticontact.version}</version>
</dependency>

<dependency>
<groupId>org.etudes</groupId>
<artifactId>etudes-ambrosia-api</artifactId>
<version>${ambrosia.version}</version>
<scope>provided</scope>
</dependency>

<dependency>
<groupId>org.etudes</groupId>
<artifactId>etudes-ambrosia-util</artifactId>
<version>${ambrosia.version}</version>
</dependency>

<dependency>
<groupId>org.etudes</groupId>
<artifactId>etudes-mneme-api</artifactId>
<version>${mneme.version}</version>
<scope>provided</scope>
</dependency>

  • Build your Sakai, including etudes-util, ltiContact, ambrosia, and mneme.

When you use maven to build sakai, it will include the sources needed for mneme.

This version is configured to build with Sakai 10.1.  If you are using another Sakai version, you need to make a few changes.

The “10.1” version number is in a few Mneme files, used as the version number for the Sakai base pom.  You need to edit these files to change this to match the version of Sakai you are using:

etudes-util/pom.xml

ltiContact/pom.xml

ambrosia/pom.xml

mneme/pom.xml

 

3. Configure Mneme

To finalize the integration of Mneme into your Sakai installation, you need to make some changes to the Authz Groups that are used as templates when new Sites are created, to enable the proper Mneme permissions. You can do this manually, by using the Admin Realm (Authz Group) editor in Sakai to edit the template authz groups, or use the Mneme Admin tool to do this.

There are five permissions in Mneme:

mneme.manage

mneme.grade

mneme.submit

mneme.guest

mneme.course.eval

You must give the first two permissions (mneme.manage and mneme.grade) to your instructors, teaching assistants, and other “maintain” sorts of roles. NOTE: Do NOT give ‘maintain’ types of roles the mneme.submit permission; they will be able to try out assessments in Mneme using Test Drive without submit permission.

Your students need only the third, mneme.submit permission.

To allow users (typically ‘guest’ roles) to view the assessments defined in a site but not make changes or submissions, use the mneme.guest permission.

In a stock Sakai distribution, there are two Authz Group templates used as new site templates:

!site.template

!site.template.course

You may have additional ones, especially if you have other than “project” and “course” site types. Make sure you modify all the appropriate templates.

​​The templates in a stock Sakai distribution have the following 5 roles:

“maintain” roles:

  • maintain
  • Instructor
  • Teaching Assistant

“access” roles:

  • access
  • Student

You may have added guests, support, and others. Make sure to modify all the appropriate roles.

Mneme entries in sakai.properties

mneme.maintenance.server

To enable the background thread in Mneme’s submission service, add this line to your sakai.properties. We want to run this thread on only a single app server in your cluster, so if you have more than a single app server, select one for this task. Use this app server’s “serverId” setting name in the following line:

mneme.maintenance.server=<serverId>

Without this line, the maintenance thread will not run on any of your app severs; submissions that are timed-out or overdue will not auto-close, and automatic email of results will not happen.

mnemeQTI.import=<name>

Use this property to configure the location to unzip the QTI package. Eg. If you are on unix/linux, and your unzip QTI directory path is /var/mneme/QTI, <name> would be /var/mneme/QTI. Be sure to create this directory with read/write permissions for the tomcat user.

4.  Use the Mneme Admin to Install Permissions

You can use the Mneme admin tool to install the Mneme permissions. The tool also allows you to add Mneme (permissions and tool) to a single site or a batch of sites.

To use the Mneme Admin tool, you must access the tool in your production Sakai instance. If you have the Mercury portal enabled, you can use that to access “sakai.mneme.admin”. Otherwise you can add the tool to your !admin site and use it from there. You must be an admin user to use the tool.

The tool will work with the standard templates and roles. You can configure the tool to use additional or different templates and roles.

To list the unique set of templates used in your Sakai installation for site Authz Group templates, add this to your sakai.properties:

templates@org.etudes.mneme.tool.InstallTemplatesView=!site.template,!site.template.course,!site.template.project

To list the unique set of roles you are using for “maintain” and “access”, add these lines to your sakai.properties:

maintainRoless@org.etudes.mneme.tool.InstallView=maintain,instructor,teaching assistant

accessRoles@org.etudes.mneme.tool.InstallView=access,student

To add the Mneme Admin tool to your Administration Workspace, do the following:

  1. Log in as Sakai Admin
  2. Click on Sites
  3. Click on !admin
  4. Scroll down and click on Pages
  5. Click on “New Page” at the top
  6. Enter “Mneme Admin Tool” in the Title field
  7. Click on Tools (not on Done!)
  8. Click on “New Tool” at the top of the page
  9. Scroll down – find and select “Test Center Admin (sakai.mneme.admin)”
  10. Click on Done at the bottom.
  11. Click on Save on the new page that appears.

When you click on “Administration Workspace,” you will now see Mneme Admin Tool where you can perform a variety of functions, such as adding Mneme permissions or Mneme to sites, etc.                

5. User Documentation

See relevant tutorials in our help pages.

6. What’s New in This Release

See issues addressed in this release and earlier versions / releases.

7. License

Mneme is licensed under the Apache License, Version 2.0

open source certified

Questions?

Contact sakai-dev@collab.sakaiproject.org or dev@etudes.org

Print Friendly, PDF & Email