Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

...

  1. Which Sakai properties need to be overridden for this user?
    • The Java code returns a path to an XML file that describes the parameter values to override. Return null to use the file specified by the following property:
      • configXmlCache@org.sakaiproject.citation.api.ConfigurationService=<XML file location>
        • The default value for this property is config.xml
    • XML configuration files are discussed below.
    • See getConfigurationXml() in SampleSiteOsidConfiguration.
  2. Which databases are available to this user?
    • The Java code returns the path to an XML file that describes the database hierarchy to the Citations Helper. The Search Categories & Databases XML page has documentation on how to build this XML file. Return null to use the file specified by the following property:
      • databaseXmlCache@org.sakaiproject.citation.api.ConfigurationService=<XML file location>
        • The default value for this property is categories.xml
    • The Search Categories & Databases XML page has documentation on how to build this XML file.
    • See getDatabaseHierarchyXml() in SampleSiteOsidConfiguration.
  3. What groups (if any) does this user belong to?
    • Groups can come into play when the Citation Helper decides which portions of the database hierarchy are available to the current user. In the Search Categories & Databases XML documentation, you will see that each defined database can have associated database-groups.
    • See getGroupIds() in SampleSiteOsidConfiguration.

...

The following is sample XML configuration documentfile:

Code Block
xml
xml
borderStylesolid
<?xml version="1.0" encoding="utf-8"?>

<config>

  <!-- Metasearch engine parameters (URL, username and password) -->

  <metasearch-baseurl>http://my-institution.edu/web2/servlet/MuseWeb2</metasearch-baseurl>
  <metasearch-username>my-username</metasearch-username>
  <metasearch-password>my-password</metasearch-password>

  <!-- Repository OSID implementation to use -->
  <!--    edu.indiana.lib.osid.base.repository.http (Sirsi SingleSearch) -->
  <!--    org.sakaibrary.osid.repository.xserver    (Ex Libris MetaLib)  -->

  <osid-impl>org.sakaibrary.osid.repository.xserver</osid-impl>

  <!-- Google Scholar URL and Sakai server -->

  <google-baseurl>http://scholar.google.com/schhp</google-baseurl>
  <sakai-serverkey>my-institution.sakai-instance.edu</sakai-serverkey>

  <!-- OpenUrl Resolver -->
  <!--    Use your local resolver URL (if you're running a resolver) -->
  <!--    http://worldcatlibraries.org/registry/gateway (if you've registered) -->

  <openurl-resolveraddress>http://my-institution.edu/openurl-resolver</openurl-resolveraddress>

</config>

...