X-Git-Url: http://sru.miketaylor.org.uk/?a=blobdiff_plain;ds=sidebyside;f=doc%2Fusing.xml;h=c2d09b6464d58e6ca089fb59a7ac4d7c57aaf4a7;hb=e3f299e011974edea3defb185b12cc13676a1734;hp=d6ed178e672dd2360a81272e88394613d0268807;hpb=a654dca0f59fd27228816703c8bb959f2970ca4e;p=yazproxy-moved-to-github.git
diff --git a/doc/using.xml b/doc/using.xml
index d6ed178..c2d09b6 100644
--- a/doc/using.xml
+++ b/doc/using.xml
@@ -5,16 +5,10 @@
This chapter includes a few examples.
- -- All config directives --
- -- SRW/SRU ..
- -- Example config
- -- Mention XSLT conversion
-
-
- The YAZ Proxy is useful for debugging SRW/SRU/Z39.50 software, logging
+ The YAZ Proxy is useful for debugging SRU/Z39.50 software, logging
APDUs, redirecting Z39.50 packages through firewalls, etc.
Furthermore, it offers facilities that often
- boost performance for connectionless Z39.50 clients such
+ boost performance for connection-less Z39.50 clients such
as web gateways.
@@ -127,20 +121,114 @@
-
- Exposing a Z39.50 server behind a firewall
+
+ Using a configuration file
+
+ In the default backend server
+ was specified by a command line option. The same proxy behavior can
+ be achieved by creating a configuration with the following contents:
+
+
+
+ foo.bar.com:18398
+ client-apdu
+
+
+
+
+]]>
+
+
- ..
+ The proxy is started with
+
+
+
+
+ The last target section is used for all servers except foo.
+ Had the the last section been omitted, then
+ only foo could be reached via the proxy.
- Offering SRW/SRU/Z39.50 service
+ Offering SRU/Z39.50 service
+
+ In order to offer SRU service we must be specify sufficient
+ information to allow the proxy to convert from SRU to Z39.50.
+ This involves translating CQL queries
+ to Type-1 (also called RPN/PQF), since most
+ Z39.50 servers do not support CQL. The conversion
+ is specified by the cql2rpn element.
+
+
+ We must also ensure that the
+ server can return at least one kind of XML record (Dublin-Core
+ recommended).
+
+
+ An explain record for the SRU service must also be created.
+
- ..
+ The following is a relatively simple configuration file for
+ such a service. This service lives on indexdata.dk,
+ port 9000. The database is gils. The
+ backend server is also indexdata.dk (port 210) as
+ given by url.
+
+
+ The server may return USMARC/MARC21 (Z39.50/SRU) and
+ MARCXML (SRU only) as specified by the
+ syntax elements.
+
+
+
+
+ indexdata.dk
+ 240
+ 180
+
+
+
+
+
+ marcxml
+
+
+ 0
+
+
+ indexdata.dk
+ 9000
+ gils
+
+
+ pqf.properties
+
+
+]]>
+
+
+ The conversion from CQL to RPN is specified by a file whose name,
+ relative to the working directory, is given in the
+ cql2rpn element.
+ A complete Bath/DC conversion file,
+ pqf.properties is provided as part of the
+ yazproxy distribution in the etc
+ subdirectory.
+
+
+ Explain information is embedded in the configuration file.
+ Note that in this example,only a few mandatory
+ explain elements are specified. A well-behaving server should describe
+ index sets, indexes, record schemas as well.
-