This page serves as a walkthrough for editing sakai.properties for Sakaibrary configuration and provides a sample file as an example. Jump to the sample below.
Walkthrough
File location
Open (or create) sakai.properties at:
<Tomcat_root>/sakai/sakai.properties
Properties
Add and define the following properties to sakai.properties
osidImpl@org.sakaiproject.citation.api.SearchManager
metasearchUsername@org.sakaiproject.citation.api.SearchManager
metasearchPassword@org.sakaiproject.citation.api.SearchManager
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:
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