Apache redirects for simpler deep links into Primo
Tags: primo
, deep
, links
, search
Last Updated: Apr 01, 2011 18:06
- Description
Using RedirectMatch in Apache allows one to provide a means of constructing simple and concise deep links into Primo based on the dlSearch.do syntax. This document refers to Primo version 2, slight modifications may have to be made for this method to work in Primo v3, although in preliminary test using v3 this technique does work. Also, as work on the API continues by ExLibris, some parameters may no longer be necessary or may change.
For example, in Primo2, ExLibris previously recommended using &scp.scps instead of &loc because &loc was found to be defective.
ExLibris also recommended using &vl(freeText0) in addition to the &query parameter because &query did not populate the search box with the search term.
Both of those issues have been resolved in SP3.0.2.
An important consideration is to use the dlSearch.do function rather than the search.do. Use of the search.do for deep links is not recommended or supported by ExLibris and can cause problems with the Primo application. Some parameters from the search.do syntax may be used with the dlSearch.do syntax. The following parameters should not be used:
&dscnt
&fromLogin - Author: Alexander Jerabek
- Additional author(s):
- Institution: Université du Québec à Montréal
- Year: 2010
- License: BSD style
- Short description: Use, modification and distribution of the code are permitted provided the copyright notice, list of conditions and disclaimer appear in all related material.
- Link to terms: [Detailed license terms]
- Skill required for using this code:
Intermediate
State
Stable
Programming language
Software requirements
Screen captures
Author(s) homepage
Download
apache-redirects-primo-deep-links.txt
Working example
deep link to search all fields for the two words 'presocratic philosophy':
http://virtuose.uqam.ca/tout/presocratic+philosophy
Or for a specific course in course reserves:
http://virtuose.uqam.ca/info-cours/BIO3100
Using the following Ex Libris open interfaces
dlDisplay.do, dlSearch.do
Changes
Version 1.2 ....
Version 1.1
...
.
Release notes
Tested in Primo v2 and v3
Installation instructions
Using RedirectMatch in Apache allows one to provide a means of constructing simple and concise deep links into Primo based on the dsearch.do syntax.
Consider this example:
This allows one to create the following stable link to search all fields for the two words 'presocratic philosophy':
http://virtuose.uqam.ca/tout/presocratic+philosophy
(Spaces in the search expression should be replaced by '+')
TO DO list
Known issues
Note regarding use of 'search.do' syntax for deep links.
ExLibris has cautioned against using both the search.do syntax since it is not supported as a method of deep linking and against modifying httpd.conf to use redirects since this configuration is not supported either. It is possible that using search.do in conjunction with httpd.conf redirects will result in maxthread warnings and an overloaded server.
In an email dated 2010-10-01, ExLibris wrote:
Sacha:
The Primo monitoring system on your FE server has been sending alert messages lately to report the server is “overloaded,” meaning that there is a very high load on the server. The alerts look like this:
Server 'archytas.bib.uqam.ca:132.208.246.23' is overloaded!
All requests are being temporarily blocked until the backlog is reduced.
For more information please look at the maxThread.log log file.
This mechanism is intended to prevent the FE from going down due to extreme loads by temporarily blocking requests. When the load lessens it stops blocking requests and everything returns to normal, but if the overload continues (i.e. if you get multiple alerts within an hour) it’s generally a good idea to restart the FE.
These messages are usually rare, but this month they have appeared with more frequency, and I wanted to make sure you were receiving these alert messages. We think there is a good chance that this is related to the customization you’ve done in Apache to trigger Primo connections. If the overloads continue and the end-users are reporting performance problems then we would probably recommend turning this customization off, at least to see if the performance returns to normal.
Let me know if you have any questions.
Regards,
Brian