Sakai Maps Installation

Maps Tool Installation

The Maps Tool comes in binary or source distribution, the source distribution needs to be build from within the Sakai source tree, the binary distribution can be installed an existing Sakai installation directly.

Prerequisites

This manual assumes that you are familiar with installing, building, and running Sakai. You must be familiar with the concepts in the Sakai installation guide, which can be found at:

Of course, you need a Sakai installation to use this Sakai tool.

Installing from binaries

Downloading the binary package

The latest version of the maps tool binary package can be downloaded from the following locations. The packages are tested on sakai 2.2, sakai 2.3, and sakai 2.4.

Sakai

version

Location

2.2/2.3/2.4

0.9.3

mapstool-0.9.3-sakai-2.x.zip

Installing the binary package

The binary version of the tool must be unpacked in the Sakai installation root. We strongly advise you stop Sakai before installing, the tool contains a component that configures at Sakai startup. The maps tool does not require any changes to the Sakai configuration, except for the auto.ddl property enabled on the first run to create the database table, see the #database section for details. Users need to have administrator privileges or the specific Maps Tool administration permissions set to be able to set the Google Maps key in order to use the tool.

Installing from source

Downloading the source

Sakai

Version

Location

The sakai maps tool depends on the edia-sakai-utils, both the maps tool and the dependent util project can be found at the following locations:
(The source will be added to the Sakai SVN soon. For now, you can download the source in a zip file)

project

version

edia-sakai-utils

1.0.2

edia-sakai-maps (repository)

0.9.3

edia-sakai-maps (zip file)

0.9.3

Running the build

Both projects downloaded above must be placed in the source root of Sakai. If you run an entire build on Sakai, it will automatically be part of that build. But if the source tree has already be build, it can be build individually by running a build in the following order:

  1. edia-sakai-utils
  2. edia-sakai-maps

Of course, to do the build the Sakai target needs to be be used:

maven sakai

Maven 1.x and ibiblio

Note: the ibiblio repository has been restructured, and maven 1.x on *nix has trouble understanding the http return code 301 (moved permanently). For that reason, it might be necessary to add the following to the maven.repo.remote property in the build.properties located in the home dir:

http://repo1.maven.org/maven/

Database

Database support

database

status

since version

MySQL 5.0

Tested

0.9.0

MySQL 4.1

Untested

 

Oracle

Untested

 

database installation

The Sakai maps tool makes use of one table, which is mapped by hibernate. Sakai needs to be started with the

auto.ddl=true

set in the sakai.properties on the first run of the maps tool to let hibernate create the required table for you.