...
Add and define the following properties to sakai.properties:
osidImpl@org.sakaiproject.citation.api.SearchManager
- the package name of the Repository OSID implementation:- For the MetaLib X-Server
No Format org.sakaibrary.osid.repository.xserver
- For the Sirsi Web2Bridge
No Format edu.indiana.lib.osid.base.repository.http
- For the MetaLib X-Server
metasearchUsername@org.sakaiproject.citation.api.SearchManager
- the username used to access your metasearch engine.metasearchPassword@org.sakaiproject.citation.api.SearchManager
- the password used to access your metasearch engine.metasearchBaseUrl@org.sakaiproject.citation.api.SearchManager
*
There are two properties that need to be changed to create a search category:
repository_X_displayName
- the name that users seerepository_X_id
- the id(s) for the search source(s) included in this search category- if there are multiple ids, they should be comma delimited - this will result in all search sources being searched simultaneously when this search category is selected.
The following properties must be left unchanged:
osid_20_Id_Implementation=org.sakaiproject.component.osid.id
repository_X_searchtype_0_authority=sakaibrary
repository_X_searchtype_0_domain=search
repository_X_searchtype_0_keyword=asychMetasearch
repository_X_searchtype_0_typeDescription=Sakaibrary Asynchronous Metasearch
The value of the following properties are currently unused (they should be left in the file, but their values do not matter):
repository_X_description
repository_X_searchtype_0_query
Additional Guidelines
- There should be at least one repository defined (
repository_0_...
). - Search categories should have consecutively increasing repository numbers:
repository_0_...
,repository_1_...
,repository_2_...
, etc. - There is no limit to the number of repositories defined.
Finding Search Source Ids
To determine the ids of your local search sources, you can use the MetaLib Management Interface:
- login to the MetaLib Management Interface at http://<metalib instance root>/M:
No Format http://metalib.mySchool.edu/M
- choose "Find Resource"
- search for the resource
- the results will contain a "Resource ID" column - this is the id to be used
...
- - the metasearch engine XML gateway base URL.
- Example for the MetaLib X-Server
No Format http://metalib.university.edu/X
- Example for the Sirsi Web2Bridge
- Example for the MetaLib X-Server
openUrlResolverAddress@org.sakaiproject.citation.api.CitationService
- the base URL for your institution's OpenURL link resolver.- If you do not know this address, or, do not have an OpenURL link resolver, you can use OCLC's OpenURL Gateway. The base URL for this OpenURL resolver is:
No Format http://worldcatlibraries.org/registry/gateway
- If you do not know this address, or, do not have an OpenURL link resolver, you can use OCLC's OpenURL Gateway. The base URL for this OpenURL resolver is:
openUrlLabel@org.sakaiproject.citation.api.CitationService
- the label users see for the OpenURL resolution link to find full-text and other institutional services (i.e. "Find It!", "IU Link", etc.).
Additional Guidelines
- Your sakai.properties file may define any other Sakai properties (such as database configuration, server identification, etc.)
- the Sakaibrary-specific properties will not effect other configuration.
- the Sakaibrary-specific properties are not dependent on other configuration properties.
Anchor | ||||
---|---|---|---|---|
|
Sample
I am a library programmer wanting to try out Sakaibrary on my own laptop.
My institution, Tango University, uses MetaLib and we have a license for the MetaLib X-Server. Our instance of MetaLib is called, Tango Research. The X-Server's base address is:
No Format |
---|
http://research.tango.edu/X |
I have created a special user just for my testing purposes - username=xserver, password=revresx.
We are using SFX at our school, but I am not certain of SFX's base URL at this time. For the time being, I will use OCLC's OpenURL Resovler Gateway. The label that our school is using for OpenURL services is, "Get It".
I am using Tomcat 5.5.17 and it is located at /opt/apache-tomcat-5.5.17
.
My sakai.properties (located: /opt/apache-tomcat-5.5.17/sakai/sakai.properties
) would contain at least the following lines:
No Format |
---|
osidImpl@org.sakaiproject.citation.api.SearchManager=org.sakaibrary.osid.repository.xserver
metasearchUsername@org.sakaiproject.citation.api.SearchManager=xserver
metasearchPassword@org.sakaiproject.citation.api.SearchManager=revresx
metasearchBaseUrl@org.sakaiproject.citation.api.SearchManager=http://research.tango.edu/X
openUrlResolverAddress@org.sakaiproject.citation.api.CitationService=http://worldcatlibraries.org/registry/gateway
openUrlLabel@org.sakaiproject.citation.api.CitationService=Get It
|