[SAK-14322] Add preferred URL configuration option for Sirsi SingleSearch Web2, 360 Search and ExLibris MetaLib OSID implementation Created: 27-Aug-2008  Updated: 15-Feb-2016  Resolved: 19-Sep-2008

Status: Closed
Project: Sakai
Component/s: Citations
Affects Version/s: 2.6.0
Fix Version/s: 2.6.0

Type: Task Priority: Major
Reporter: Jon Dunn Assignee: Steve Smail (Inactive)
Resolution: Fixed Votes: 0
Labels: None
Σ Remaining Estimate: Not Specified Remaining Estimate: Not Specified
Σ Time Spent: Not Specified Time Spent: Not Specified
Σ Original Estimate: Not Specified Original Estimate: Not Specified

Issue Links:
Depend
depends on SAK-13441 Title link URLs returned by the OSID ... Closed
Relate
relates to SAK-14323 Add preferred URL configuration optio... Closed
is related to SAK-14821 The Sakai administrator cannot associ... Closed
Sub-Tasks:
Key
Summary
Type
Status
Assignee
SAK-14352 Update Web2 Bridge OSID to return "pr... Sub-task Closed Steve Smail  
SAK-14353 Update 360 Search OSID to return "pre... Sub-task Closed Steve Smail  
SAK-14355 Update Xserver OSID to return "prefer... Sub-task Closed Steve Smail  

 Description   

Add a configuration option for the Sirsi SingleSearch Web2, Serials Solutions 360 Search, and ExLibris MetaLib OSID implementations to enable returning preferred URLs via the mechanism implemented in SAK-13441.

Details:

This option modifies the behavior of the Citations Helper when handling search results provided by the "Search Library Resources" OSID components.

The option itself is provided in the site specific XML configuration file for the Citations Helper:

<provide-preferred-url> true | false </provide-preferred-url>

If the <provide-preferred-url> option is not present in the configuration file, the feature is disabled (as if "false" had been supplied in the configuration file).

The changes required to implement this are largley confined to BaseConfigurationService.java and BaseCitationService.java.

However, minor updates to the Web2 Bridge and 360 Search components are required as well; these are addressed as sub-tasks.



 Comments   
Comment by Steve Smail (Inactive) [ 29-Aug-2008 ]

The "Search Library Resources" component of the Citations Helper must be correctly configured to test this change. Once that is done:

  • Update your XML configuration file (found in the Citations Admin project) to add or modify the newconfiguration directive (set the value to true):

<provide-preferred-url>true</provide-preferred-url>

Once that's done, here's a sample test scenerio:

  • From Resources, start the Citations Helper via the "Add Citation List" pulldown option.
  • Select "Search Library Resources".
  • Click "Search Library Resources" to begin the search process
  • Select one (or more) databases to search
  • Enter a search term and click "Search" - you'll see the search results page.

Each search result displays the item title as a link. Verify that one (or more) of these title links leads directly to vendor supplied result information.

  • Click "Cancel Citation List" to discard the citation list

Variations:

1) Disable the use of preferred URLs:

<provide-preferred-url>false</provide-preferred-url>

Verify that each search result title link is an OpenURL (the link should take you page provided by your institutions link resolver - this page will display options for accessing the desired content)

2) Remove the <provide-preferred-url> configuration item. Again, the title links should all be OpenURLs.

Comment by Steve Smail (Inactive) [ 29-Aug-2008 ]

I also want to note that this feature has been requested by several campuses during their evaluation of the "Search Library Resources" feature.

The shared belief is that direct URLs provided by (at least some) metasearch engines will successfully find content more reliably than will the campus OpenURL resolver.

Comment by Steve Smail (Inactive) [ 17-Sep-2008 ]

I've made a minor (and obvious) change to the functionality we're adding. Here's the new description:

Add a configuration option for the Sirsi SingleSearch Web2, Serials Solutions 360 Search, and ExLibris MetaLib OSID implementations to enable returning preferred URLs via the mechanism implemented in SAK-13441.

Details:

This option modifies the behavior of the Citations Helper when handling search results provided by the "Search Library Resources" OSID components.

The option itself is provided in the site specific XML configuration file for the Citations Helper:

<provide-direct-url> false | related-link | title-link </provide-direct-url>

– "false" tells us to not to use the direct URL at all
(this is the current Citations behavior)

– "related-url" tells us to provide the direct URL as a secondary, related link
(the tite link is still an OpenURL)

– "title-link" tells us to provide the direct URL as the title link

If the <provide-direct-url> option is not present in the configuration file, the feature is disabled (as if "false" had been supplied in the configuration file).

The changes required to implement this are largley confined to BaseConfigurationService.java and BaseCitationService.java.

Comment by Steve Smail (Inactive) [ 17-Sep-2008 ]

Due to change described in my previous comment, here's an updated test plan:

The "Search Library Resources" component of the Citations Helper must be correctly configured to test this change. Once that is done:

  • Update your XML configuration file (found in the Citations Admin project) to add or modify the new configuration directive (set the value to title-link):

<provide-direct-url>title-link</provide-direct-url>

Here's a sample test scenerio:

  • From Resources, start the Citations Helper via the "Add Citation List" pulldown option.
  • Select "Search Library Resources".
  • Click "Search Library Resources" to begin the search process
  • Select one (or more) databases to search
  • Enter a search term and click "Search" - you'll see the search results page.

Each search result displays the item title as a direct link. Verify that one (or more) of these title links leads directly to vendor supplied result information.

  • Click "Cancel Citation List" to discard the citation list

Variations:

1) Disable the use of direct URLs:

<provide-direct-url>false</provide-direct-url>

Verify that each search result title link is an OpenURL (the link should take you page provided by your institutions link resolver - this page will display options for accessing the desired content)

2) Remove the <provide-direct-url> configuration item. Again, the title links should all be OpenURLs.

3) Use the direct URL as a related link:

<provide-direct-url>related-link</provide-direct-url>

– Click "Add" to save a few search results to your Citation List
– Click "Review Citations" to return to the Edit Citation List page

Verify that the title links are OpenURLs, and that the Related Link is a direct, vendor URL. There won't be a related link if no direct URL was available.

Comment by Steve Smail (Inactive) [ 19-Sep-2008 ]

The changes required for this new functionality have been tested and checked in.

Comment by Anthony Whyte [ 17-Aug-2009 ]

Both r 52001 and 52403 are in 2.6.0.

Comment by Steve Smail (Inactive) [ 18-Aug-2009 ]

This work was done as a new feature for Sakai 2.6.0, and it's included in that release.

We've never intended to move this into the 2.5.x Citations code, so I've removed the various 2.5 versions from the "affects" list.

Anthony - if there's a better way to handle this, just let me know.

Comment by Steve Smail (Inactive) [ 19-Aug-2009 ]

This work is included in the 2.6.0 release. It seems ok to close the issue now.

Generated at Mon Dec 10 12:24:23 CST 2018 using JIRA 7.5.0#75005-sha1:fd8c849d4e278dd8bbaccc61e707a716ad697024.