< back to Configuration Instructions
Table of Contents
1 Choosing an OSID implementation
For Sakai 2.4, the Citations Helper supports the SIRSI SingleSearch and Ex Libris MetaLib metasearch engines. Each of these metasearch engines has a corresponding Repository OSID implementation that the Citations Helper needs to use to properly communicate with the particular product's XML gateway.
To specify which OSID implementation to use, set the following Sakai property:
osidImpl@org.sakaiproject.citation.api.ConfigurationService=edu.indiana.lib.osid.base.repository.http: OSID implementation package to be used with SIRSI SingleSearch.org.sakaibrary.osid.repository.xserver: OSID implementation package to be used with Ex Libris MetaLib.
2 Accessing the Metasearch XML Gateway
Many metasearching products provide an XML gateway to search and retrieve records from a metasearch engine remotely.
A XML gateway user with enough privileges to simultaneously start a search and retrieve records needs to be available for the Citations Helper to use. This user's credentials need to be specified by setting the following Sakai properties:
metasearchBaseUrl@org.sakaiproject.citation.api.ConfigurationService=<base URL of metasearch XML gateway>- TODO: determine what this looks like for Web2Bridge
- For Ex Libris MetaLib, the XML gateway is called the X-Server. The URL to access the X-Server is usually the base address of your MetaLib instance followed by a
/X. For example:http://metasearch.university.edu/X
metasearchUsername@org.sakaiproject.citation.api.ConfigurationService=metasearchPassword@org.sakaiproject.citation.api.ConfigurationService=
3 Defining Search Categories & Databases
Search categories provide organizational structure to the databases that users have access to search through the Citations Helper. Search categories and databases are defined in an XML file called, categories.xml.