Page Comparison

...

The default value for this property is org.sakaiproject.citation.impl.SampleSiteOsidConfiguration Anchorxmlxml

...

Configuration

...

XML configuration files allow you to provide configuration information for different groups of users. The format of this XML file is very straightforward, simply setting the values of various properties. All of the properties are also Sakai properties that can be set through the sakai.properties file and that you may have already seen elsewhere in the documentation. Properties set in XML configuration files override those that are set through sakai.properties. If you want to use certain values from sakai.properties and override others, only include the properties you would like to override in the XML configuration file.

The following is sample XML configuration file:

...

<?xml version="1.0" encoding="utf-8"?>

<config>

  <!-- Metasearch engine parameters (URL, username and password) -->

  <metasearch-baseurl>http://my-institution.edu/web2/servlet/MuseWeb2</metasearch-baseurl>
  <metasearch-username>my-username</metasearch-username>
  <metasearch-password>my-password</metasearch-password>

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

  <osid-impl>org.sakaibrary.osid.repository.xserver</osid-impl>

  <!-- Google Scholar URL and Sakai server -->

  <google-baseurl>http://scholar.google.com/schhp</google-baseurl>
  <sakai-serverkey>my-institution.sakai-instance.edu</sakai-serverkey>

  <!-- OpenUrl Resolver -->
  <!--    Use your local resolver URL (if you're running a resolver) -->
  <!--    http://worldcatlibraries.org/registry/gateway (if you've registered) -->

  <openurl-resolveraddress>http://my-institution.edu/openurl-resolver</openurl-resolveraddress>

</config>

Note: Property names in the XML above are not syntactically the same as the property names used for sakai.properties. See the Configuration Properties page for a listing of all properties used in sakai.properties. You will find the property names to be the same, just not written in the same way, as the XML document above.

...

To establish a dynamic configuration, changes are made to sakai.properties. In addition, you'll probably need to create multiple sets of XML configuration and search category files.

Anchor
sakaiproperties sakaiproperties

Property Values

In our example scenario, we'll need to provide the names of our configuration and search categories files in sakai.properties. One set is for East Campus, the other is for West Campus.

 
# 
# Cached configuration files (one for each campus) 
# 
configXmlCache@org.sakaiproject.citation.api.ConfigurationService=EAST-config.xml,WEST-config.xml 
databaseXmlCache@org.sakaiproject.citation.api.ConfigurationService=EAST-categories.xml,WEST-categories.xml 

XML Configuration Files

For the example scenario, each campus requires both a configuration file (EAST-config.xml, WEST-config.xml) and a database categories file (EAST-categories.xml, WEST-categories.xml). These files should be located in the Resources area of the Citations Admin site.

When setting up an XML configuration file, it's probably easiest to copy the sample XML configuration file, changing values to reflect your requirements.

To learn more on creating a search category file, refer to the Search Categories & Databases XML document and the example XML configuration file.

You may also want to review the XML editing overview.