Differences

This shows you the differences between two versions of the page.

--- evergreen-admin:sru_and_z39.50 [2009/11/23 14:32] – Give an explicit example for SRU connection dbs
+++ evergreen-admin:sru_and_z39.50 [2025/06/16 12:24] (current) – stompro
@@ Line 1: / Line 1: @@
 ======Evergreen: SRU and Z39.50 server support======
-[[http://www.loc.gov/standards/sru/|Search/Retrieval via URL (SRU)]] is a specification for searching resources that relies on standard Web technology (HTTP, XML) for its implementation. Evergreen 1.4 supports basic SRU access through the /opac/extras/sru service defined in the Apache ''eg_vhost.conf'' configuration file and implemented in the sru_search() method in [[http://svn.open-ils.org/trac/ILS/browser/trunk/Open-ILS/src/perlmods/OpenILS/WWW/SuperCat.pm|Open-ILS/src/perlmods/OpenILS/WWW/SuperCat.pm]].
+[[http://www.loc.gov/standards/sru/|Search/Retrieval via URL (SRU)]] is a specification for searching resources that relies on standard Web technology (HTTP, XML) for its implementation. Evergreen 1.4 supports basic SRU access through the /opac/extras/sru service defined in the Apache ''eg_vhost.conf'' configuration file and implemented in the sru_search() method in [[https://git.evergreen-ils.org/?p=Evergreen.git;a=blob;f=Open-ILS/src/perlmods/lib/OpenILS/WWW/SuperCat.pm|Open-ILS/src/perlmods/lib/OpenILS/WWW/SuperCat.pm]].
+**NOTE:** This documentation is also available in the Evergreen documentation at http://libdog.mohawkcollege.ca/evergreen_documentation/1.6/draft/html/. In github: http://github.com/rsoulliere/Evergreen-DocBook/blob/master/1.6/admin/z3950.xml.
 =====Testing Evergreen SRU with yaz-client=====
@@ Line 53: / Line 56: @@
      <zurl>http://dev.gapines.org/opac/extras/sru</zurl>
      <option name="sru">get</option>
-     <charset>utf8</charset>
+     <charset>marc-8</charset>
      <search>
        <querytype>cql</querytype>
@@ Line 68: / Line 71: @@
 </client>
 </code> You can have multiple **<database>** sections in a single file, each pointing to a different scope of your consortium. The **name** attribute on the **<database>** element is used in your Z39.50 connection string to name the database. The **<zurl>** element must point to ''http://hostname/opac/extras/sru''. As of Evergreen 1.6, you can append an optional organization unit shortname for search scoping purposes, and you can also append **/holdings** if you want to expose the holdings for any returned records. So your zurl could be ''http://dev.gapines.org/opac/extras/sru/BR1/holdings'' to limit the search scope to BR1 and its children, and to expose its holdings.
-  - Then we need to create a configuration file that will tell YAZ how to transform marcxml to binary MARC21.  We will call this one xml2marc-yaz.cfg:<code xml>
+=====Using your z39.50 server to access remote databases=====
+  - Simple2zoom is not concerned if your data is local or remote, so you can use your server to query remote data as well as local holdings.  For instance, to set up a the server to query Evergreen Indiana bibs, you would add the following stanza to your /openils/conf/oils_z3950.xml file:   <code xml>      <database name="egin">
+         <zurl>http://evergreen.lib.in.us/opac/extras/sru/</zurl>
+         <option name="sru">get</option>
+         <charset>marc-8</charset>
+         <search>
+           <querytype>cql</querytype>
+           <map use="4"><index>eg.title</index></map>
+           <map use="7"><index>eg.isbn</index></map>
+           <map use="8"><index>eg.issn</index></map>
+           <map use="21"><index>eg.subject</index></map>
+           <map use="1003"><index>eg.author</index></map>
+           <map use="1018"><index>eg.publisher</index></map>
+           <map use="1035"><index>eg.keyword</index></map>
+           <map use="1016"><index>eg.keyword</index></map>
+         </search>
+     </database>
+  </code>
+    - To query that from the Evergreen staff-client you would add "Evergreen Indiana" to your list of custom z3950 targets with the URL if your own server and the database name of "egin" and the port that your server is listening on, i.e. 210.
+=====Setting up Yaz Configuration=====
+  - We need to create a configuration file that will tell YAZ how to transform marcxml to binary MARC21. Along the way, we force the output character set to be MARC-8, because in the dinosaur world of library technology some major Z39.50 clients such as RefWorks and OCLC VDX still appear to be unable to support Unicode UTF-8 encoding. We will call this one ''xml2marc-yaz.cfg'':
+<code xml>
 <yazgfs>
     <server id="server1">
@@ Line 75: / Line 100: @@
         <retrieval syntax="marc21">
             <backend syntax="xml">
-                <marc inputformat="xml" outputformat="marc" outputcharset="utf-8"/>
+                <marc inputformat="xml" outputformat="marc" inputcharset="utf-8" outputcharset="marc-8"/>
             </backend>
         </retrieval>
@@ Line 82: / Line 107: @@
 </yazgfs>
 </code>
-  - Run simple2ZOOM as a daemon, specifying the configuration files and one or more listener addresses that the Z39.50 server will be accessible on. If you do not specify a port, it will automatically run on port 9999. In the following example, we tell it to listen both to localhost on port 2210, and on dev.gapines.org on port 210:<code bash>
+  - As root, run simple2ZOOM as a daemon, specifying the configuration files and one or more listener addresses that the Z39.50 server will be accessible on. If you do not specify a port, it will automatically run on port 9999. In the following example, we tell it to listen both to localhost on port 2210, and on dev.gapines.org on port 210:<code bash>
-simple2zoom -c dgo.conf -- -f xml2marc-yaz.cfg localhost:2210 dev.gapines.org:210</code>
+simple2zoom -c dgo.conf -- -f xml2marc-yaz.cfg localhost:2210 dev.gapines.org:210 &</code>
+====Testing the Z39.50 server - RPN Searches====
 To test the Z39.50 server, we can use yaz-client again:<code>
@@ Line 96: / Line 123: @@
 Options: search present delSet triggerResourceCtrl scan sort namedResultSets
 Elapsed: 0.010718
-Z> format marcxml
+Z> format xml
-Z> find "dc.title=zone and dc.author=king"
+(Server Default Search, usually keyword)
-Sent searchRequest.
-Received SearchResponse.
-Search was a success.
-Number of hits: 0, setno 4
-records returned: 0
-Elapsed: 0.611432
 Z> find "dead zone"
 Sent searchRequest.
@@ Line 116: / Line 137: @@
 []Record type: XML
 <record xmlns:... (rest of record deliberately truncated)
+(Example using Z39.50 Attribute codes - ISBN Search)
+Z> find @attr 1=7 9781476770383
+Sent searchRequest.
+Received SearchResponse.
+Search was a success.
+Number of hits: 1, setno 6
+records returned: 0
+Elapsed: 0.201841
+</code>
+====Testing the Z39.50 server with CQL Queries====
+You can test out CQL queries against Z39.50 servers with the yaz client, but you need
+to setup a mapping file to convert CQL to RPN queries.
+<code>
+Z> find "dc.title=zone and dc.author=king"
+Sent searchRequest.
+Received SearchResponse.
+Search was a success.
+Number of hits: 0, setno 4
+records returned: 0
+Elapsed: 0.611432
 </code>
+=====Adding an Index for Z39.50 Searching=====
+Example of adding an index.