Child pages
  • post-2.4 Configuration Instructions
Skip to end of metadata
Go to start of metadata

Table of Contents

Comparison to 2.4 Configuration

Citations configuration in Sakai 2.5 and Citations Helper post-2.4 is the same and is largely compatible with the older 2.4.x release. Common values in sakai.properties and the XML configuration files continue to have the same meanings - you can use your existing 2.4 XML files with 2.5.

Given that, much of the Citations Helper 2.4 configuration documentation on the Sakaibrary wiki is still valid.

What's new?

  1. In Sakai 2.5, the Citations functionality is enabled by default. Citations can be "turned off" using the XML or sakai.properties mechanisms shown below.
  2. The XML configuration files are stored in the Resources area of a dedicated "Citations Admin" site. Previously these were maintained in the file system.
  3. Additional configuration elements can be controlled using the XML configuration files.

XML configuration files for 2.5

Handling the XML configuration files as standard Sakai resources has several benefits:

  1. You can update your Citations configuration on-the-fly, without restarting Tomcat. If you're running a cluster, the updated configuration is available cluster-wide.
  2. An administrator can delegate responsibility for maintaining the Citations configuration.
  3. In this new scheme, configuration content is cached, and the cache is updated only when new configuration files become available.

Setting up the new administration site

In sakai.properties you'll specify a "citations administration" site ID and a folder to house your configuration files:

  • adminSiteName@org.sakaiproject.citation.api.ConfigurationService=LibraryAdmin
  • configFolder@org.sakaiproject.citation.api.ConfigurationService=config

You also specify one or two configuration files:

  • configXmlCache@org.sakaiproject.citation.api.ConfigurationService=config.xml
  • databaseXmlCache@org.sakaiproject.citation.api.ConfigurationService=categories.xml

This example reflects the default, out-of-the-box names for these files. The categories.xml file isn't required if you don't use the "library search" feature.

At startup time, the administration site will be created, if it doesn't already exist. The admin site will have the title "Citations Admin".

Initial setup

To initially set up the Citations Helper:

  1. Login as admin
  2. Go to the "Citations Admin" site
  3. Create a folder to hold your configuration files ("config" in our case)
  4. Go to "config" and upload your "config.xml" and "categories.xml" files.

New XML configuration elements

<!-- Enable/disable the Citations Helper system wide -->
<citations-enabled-by-default>true</citations-enabled-by-default>

<!-- Can Citations be enabled/disabled on a per-site basis? -->
<citations-enabled-site-by-site>true</citations-enabled-site-by-site>

<!-- Enable/disable the Search Library Resources feature -->
<library-search-enabled>true</library-search-enabled>

<!-- Enable/disable Google Scholar search -->
<google-scholar-enabled>true</google-scholar-enabled>

Adding these to your config.xml file is optional. As in Sakai 2.4.x, these can all be controlled using property values in sakai.properties. If you do provide these values in config.xml, the XML values take precedence.

Sakai Properties

Template sakai.properties and config.xml files are shown below:
Sample sakai.properties definitions (minimal, more could be added)

#
# Enable the Citation Helper and allow site-by-site control
#
citationsEnabledByDefault@org.sakaiproject.citation.api.ConfigurationService=true
allowSiteBySiteOverride@org.sakaiproject.citation.api.ConfigurationService=true

#
# Citation Helper configuration
#
# Citations administrative site ID, configuration file directory
#
adminSiteName@org.sakaiproject.citation.api.ConfigurationService=LibraryAdmin
configFolder@org.sakaiproject.citation.api.ConfigurationService=config

#
# Cached configuration files (these are the default names)
#
configXmlCache@org.sakaiproject.citation.api.ConfigurationService=config.xml
databaseXmlCache@org.sakaiproject.citation.api.ConfigurationService=categories.xml

Sample config.xml file

The following file illustrates all of the configuration elements for the post-24 and 2.5 releases.

<config>

  <!-- Sample Citations configuration (Sakai 2.5.x) -->

  <!-- Enable Citations system wide and site-by-site -->

  <citations-enabled-by-default>true</citations-enabled-by-default>
  <citations-enabled-site-by-site>true</citations-enabled-site-by-site>

  <!-- Library Search (disabled) -->
  <!--    Replace "example.com" with the URL for your metasearch -->
  <!--    server and supply the apporpriate username and password -->

  <library-search-enabled>false</library-search-enabled>

  <metasearch-baseurl>http://example.com</metasearch-baseurl>
  <metasearch-username>none</metasearch-username>
  <metasearch-password>none</metasearch-password>

  <!-- Select the Repository OSID implementation to use -->
  <!--    edu.indiana.lib.osid.base.repository.http (Sirsi SingleSearch) -->
  <!--    org.sakaibrary.osid.repository.xserver    (Ex Libris MetaLib)  -->

  <osid-impl>edu.indiana.lib.osid.base.repository.http</osid-impl>

  <!-- Google Scholar (enabled) -->
  <!--    Replace "sakai-instance-name" with the name of your Sakai instance -->

  <google-scholar-enabled>true</google-scholar-enabled>

  <google-baseurl>http://scholar.google.com/schhp</google-baseurl>
  <sakai-serverkey>sakai-instance-name</sakai-serverkey>

  <!-- OpenUrl Resolver to use, label for OpenURL link -->
  <!--    Supply your resolver URL (if you're running a resolver) -->
  <!--    or http://worldcatlibraries.org/registry/gateway (if you've registered) -->

  <openurl-resolveraddress>http://worldcatlibraries.org/registry/gateway</openurl-resolveraddress>
  <openurl-label>Find It!</openurl-label>

</config>

  • No labels