sakai.properties Config

Owned by Former user (Deleted)
Last updated: Dec 18, 2006Version comment
2 min read

This page serves as a walkthrough for editing sakai.properties for Sakaibrary configuration and provides a sample file as an example. Jump to the sample below.

Walkthrough

File location

Open (or create) sakai.properties at:

<Tomcat_root>/sakai/sakai.properties

Properties

Add and define the following properties to sakai.properties:

  • osidImpl@org.sakaiproject.citation.api.SearchManager - the package name of the Repository OSID implementation:
    • For the MetaLib X-Server 
      org.sakaibrary.osid.repository.xserver
    • For the Sirsi Web2Bridge 
      edu.indiana.lib.osid.base.repository.http
  • metasearchUsername@org.sakaiproject.citation.api.SearchManager - the username used to access your metasearch engine.
  • metasearchPassword@org.sakaiproject.citation.api.SearchManager - the password used to access your metasearch engine.
  • metasearchBaseUrl@org.sakaiproject.citation.api.SearchManager - the metasearch engine XML gateway base URL.
    • Example for the MetaLib X-Server 
      http://metalib.university.edu/X
    • Example for the Sirsi Web2Bridge
  • openUrlResolverAddress@org.sakaiproject.citation.api.CitationService - the base URL for your institution's OpenURL link resolver.
    • If you do not know this address, or, do not have an OpenURL link resolver, you can use OCLC's OpenURL Gateway. The base URL for this OpenURL resolver is: 
      http://worldcatlibraries.org/registry/gateway
  • openUrlLabel@org.sakaiproject.citation.api.CitationService - the label users see for the OpenURL resolution link to find full-text and other institutional services (i.e. "Find It!", "IU Link", etc.).

Additional Guidelines

  • Your sakai.properties file may define any other Sakai properties (such as database configuration, server identification, etc.)
    • the Sakaibrary-specific properties will not effect other configuration.
    • the Sakaibrary-specific properties are not dependent on other configuration properties.

Sample

I am a library programmer wanting to try out Sakaibrary on my own laptop.

My institution, Tango University, uses MetaLib and we have a license for the MetaLib X-Server. Our instance of MetaLib is called, Tango Research. The X-Server's base address is: 

http://research.tango.edu/X

I have created a special user just for my testing purposes - username=xserver, password=revresx.

We are using SFX at our school, but I am not certain of SFX's base URL at this time. For the time being, I will use OCLC's OpenURL Resovler Gateway. The label that our school is using for OpenURL services is, "Get It".

I am using Tomcat 5.5.17 and it is located at /opt/apache-tomcat-5.5.17.

My sakai.properties (located: /opt/apache-tomcat-5.5.17/sakai/sakai.properties) would contain at least the following lines:

osidImpl@org.sakaiproject.citation.api.SearchManager=org.sakaibrary.osid.repository.xserver

metasearchUsername@org.sakaiproject.citation.api.SearchManager=xserver

metasearchPassword@org.sakaiproject.citation.api.SearchManager=revresx

metasearchBaseUrl@org.sakaiproject.citation.api.SearchManager=http://research.tango.edu/X

openUrlResolverAddress@org.sakaiproject.citation.api.CitationService=http://worldcatlibraries.org/registry/gateway

openUrlLabel@org.sakaiproject.citation.api.CitationService=Get It