searchsource.xml Config

This page serves as a walkthrough for editing searchsource.xml for the Web2 Bridge OSID configuration. Jump to the sample below.

Walkthrough

File location

You'll need to edit the file searchsource.xml:

<sakai_root>/web2bridge-osid/web2bridge-osid-impl/src/bundle/searchsource.xml

Configuration elements

There are several configuration elements you'll need to supply.

A search source is identified by a unique name and id. A description can be
provided as well (the description is essentially a comment).

<source name="Example Source Name">         (displayed to the user)
<id name="Example.Source"/>                 (internal use only, must be unique)
<description name="Example Description"/>   (a comment)

The URL of the Web2 Bridge must be provided, along with Web2 logon
information (this logon information reflects a specific SingleSearch
instance at your site):

<url name="http://example.com/example-path/MuseWeb2">
<parameter name="username" value="example-username"/>
<parameter name="password" value="example-password"/>

The Web2 Bridge requires at least one target (vendor database) to search.
The target name corresponds to a database connector configured for your
Web2 Bridge/SingleSearch instance. When multiple are supplied, separate
each connector name with a space:

<parameter name="targets" value="Blackwell ProjectMuse"/>

Use this search source? (true = search this source, false = hide this source)

<options enabled="true"/>

Each source also requires these "constant" entries (you won't need to
change these):

<queryhandler name="edu.indiana.lib.twinpeaks.search.singlesearch.web2.Web2Query"/>
<responsehandler name="edu.indiana.lib.twinpeaks.search.singlesearch.web2.Web2Response"/>

<authority name="sakaibrary"/>
<domain name="search"/>
<searchtype name="asynchMetasearch"/>
<searchdescription name="Asynchronous SingleSearch"/>

Additional Guidelines

  • There should be at least one search source defined.
  • There is no limit to the number of repositories defined.

Finding Search Source Connector Names

... coming soon ...

Sample

There two search categories to configure:

  1. General Interest - consists of two databases: ProJect Muse and Academic Search Premier.
  2. Blackwell - consists of the single database, Blackwell.
<search>
  <!--
    Global configuration

    Select an ID manager implementation.  The configuration below makes use
    of the standalone id manager provided with the Web2 Repository (it's
    unlikely you'll want to change this value).
  -->
  <osid_20_Id_Implementation name="edu.indiana.lib.osid.component.id"/>
 
  <!-- 
      General Interest list
  -->
  <source name="General Interest">

    <id name="Id.General.Interest"/>
    <description name="General Interest sources via Sirsi SingleSearch"/>

    <url name="http://my-university.edu/my-path/MuseWeb2"/>
    <parameter name="targets" value="ProjectMuse EBSCOASP"/>

    <parameter name="username" value="my-sirsi-username"/>
    <parameter name="password" value="my-sirsi-password"/>

    <options enabled="true"/>

    <!-- The following are constant values (no need to change them) -->

    <queryhandler name="edu.indiana.lib.twinpeaks.search.singlesearch.web2.Web2Query"/>
    <responsehandler name="edu.indiana.lib.twinpeaks.search.singlesearch.web2.Web2Response"/>

    <authority name="sakaibrary"/>
    <domain name="search"/>
    <searchtype name="asynchMetasearch"/>
    <searchdescription name="Asynchronous SingleSearch"/>
  </source>

  <!--
      Blackwell
  -->
  <source name="Blackwell">

    <id name="Id.Blackwell"/>
    <description name="Blackwell via Sirsi SingleSearch"/>

    <url name="http://my-university.edu/my-path/MuseWeb2"/>
    <parameter name="targets" value="Blackwell"/>

    <parameter name="username" value="my-sirsi-username"/>
    <parameter name="password" value="my-sirsi-password"/>

    <options enabled="true"/>

    <!-- The following are constant values (no need to change them) -->

    <queryhandler name="edu.indiana.lib.twinpeaks.search.singlesearch.web2.Web2Query"/>
    <responsehandler name="edu.indiana.lib.twinpeaks.search.singlesearch.web2.Web2Response"/>

    <authority name="sakaibrary"/>
    <domain name="search"/>
    <searchtype name="asynchMetasearch"/>
    <searchdescription name="Asynchronous SingleSearch"/>
  </source>

</search>