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 the name of XML file that describes the proper configuration – return null to use the file specified by the following property:
    • configXmlCache@org.sakaiproject.citation.api.ConfigurationService=<XML file>
      • 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 name of an XML file that describes the database hierarchy – return null to use the file specified by the following property: databaseXmlCache@org.sakaiproject.citation.api.ConfigurationService=<XML file> The default value for this property is categories. xml
  3. The Search Categories & Databases XML page has documentation on how to build this XML file.
  4. See getDatabaseHierarchyXml() in SampleSiteOsidConfiguration.

  5. What groups (if any) does this user belong to?

    Groups can come into play when allow the Citation Helper decides to decide 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 for a simple implementation.

Custom Implementation

A custom (or site specific) SiteOsidConfiguration implementation needs to make the same three decisions outlined above.

...