< back to Configuration Instructions

...

1 Example Scenario

The following is an example scenario that could use static configuration:

I have created a set of commonly used search categories and databases at my library that I would like all Citations Helper users to use. This set consists of General Interest, Science, Literature, Arts and Engineering categories and their related databases. My institution uses only Ex Libris MetaLib and there is a single username and password that the Citations Helper will use to access MetaLib.

2 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.

...

• 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.

...

3 Accessing the Metasearch XML Gateway

Many metasearching products provide an XML gateway to search and retrieve records from a metasearch engine remotely.

...

• metasearchBaseUrl@org.sakaiproject.citation.api.ConfigurationService=<base URL of metasearch XML gateway>
  • For SIRSI Sirsi SingleSearch, the XML gateway is called the Web2Bridge. HighlightTODO: determine what URL looks like for Web2Bridgethe Web2 Bridge. The URL to access Web2 is often the base address of your SingleSearch instance followed by /web2/servlet/MuseWeb2. For example:

    No Format
    nopanel true
    http://metasearch.university.edu/web2/servlet/MuseWeb2

  • 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:

    No Format
    nopanel true
    http://metasearch.university.edu/X

• metasearchUsername@org.sakaiproject.citation.api.ConfigurationService=<XML gateway username>
• metasearchPassword@org.sakaiproject.citation.api.ConfigurationService=<XML gateway password>

...

4 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. This file should be located within your sakai.home directory, in a directory called org.sakaiproject.citation. Unless you have specifically changed sakai.home, it will be a folder named 'sakai' in your Tomcat root directory . For example: No Format

nopanel	true

(i.e. /opt/apache-tomcat-5.5.23/sakai/org.sakaiproject.citation/categories.xml).

To learn how to build this XML file, please refer to the Search Categories & Databases XML documentation. Since this configuration method uses the unmodified org.sakaiproject.citation.impl.SampleSiteOsidConfiguration, all databases will need to be defined to be in the all database_group (more on this on the Search Categories & Databases XML page).

4 Starting Sakai & Verifying

Once all Sakai properties are set in your sakai.properties file and the categories.xml file is created and placed in proper location, you should be able to start Tomcat normally.Once Sakai is started and you navigate to a worksite with the Citations Helper enabled, you should see the 'Search Library Resources' option available when creating a Citation List. Upon choosing that option, you should see your defined categories and databases appearing in a search form. You should be able to select databases and conduct a search. Highlightmaybe add some screenshots alongside this section

< back to Configuration Instructions