X-Git-Url: http://jsfdemo.indexdata.com/?a=blobdiff_plain;f=doc%2Fsru_z3950.xml;h=df973ed0786bdb8ad4111b9bd9841500343d54d7;hb=3f5b658748a32db22137659bc51b1ac2dcfcf1d6;hp=2e149460bb9f0d5fac6ac86277ac5131c92701b6;hpb=6ce31309381822f3fe2a5364be1cd73a7472d62f;p=metaproxy-moved-to-github.git
diff --git a/doc/sru_z3950.xml b/doc/sru_z3950.xml
index 2e14946..df973ed 100644
--- a/doc/sru_z3950.xml
+++ b/doc/sru_z3950.xml
@@ -1,4 +1,4 @@
-
@@ -15,29 +15,30 @@
3mp
Metaproxy Module
-
+
sru_z3950
- Metaproxy Module transforming SRU web service requests to Z3950 Metaproxy packages
+ Metaproxy Module transforming SRU web service requests to
+ Z39.50 Metaproxy packages
-
+
DESCRIPTION
The sru_z3950 Metaproxy filter transforms valid
- SRU GET/POST/SOAP requests to Z3950 requests, and wraps the
- received hit counts and XML records into suitable SRU response messages.
+ SRU GET/POST/SOAP requests to Z39.50 requests, and wraps the
+ received hit counts and XML records into suitable SRU response messages.
Multiple database elements defining the names of the accepted
databases are allowed in the configuration file. Each
- of them must contain their own explain record, or must be empty.
+ of them must contain their own explain record, or must be empty.
Notice that explain
records come in SRU and Z39.50 flavors, and this filter requires
- the SRU version. See the
+ the SRU version. See the
ZeeReX Explain
- standard pages and the
+ standard pages and the
SRU Explain pages
- for more information.
+ for more information.
All Z39.50 packages and all HTTP packages that do not resolve to
@@ -45,14 +46,14 @@
filters on the route.
- The SRU explain operation is supported,
+ The SRU explain operation is supported,
returning either the absolute minimum required by the standard, or
- a full pre-defined ZeeReX explain record.
+ a full pre-defined ZeeReX explain record.
It supports the SRU searchRetrieve operation, which
- is transformed into successive Z3950 init,
- search and present requests.
+ is transformed into successive Z39.50 init,
+ search and present requests.
The SRU scan operation is not supported.
@@ -82,6 +83,29 @@
+
+ x-session-id
+
+
+ Allow a user-defined session ID to be attached to filter
+ log that follows sru_z3950. The ID is present in the
+ log files and not available to the SRU webservice. In order
+ to log material out via SRU, the x-log-enable may be used
+ instead.
+
+
+
+
+ x-log-enable
+
+
+ Controls whether log is to be collected for filters that
+ sru_z3950. Log data is extra response data's log element.
+ A value of 1 enables logging; other value disables
+ logging (default).
+
+
+
@@ -89,11 +113,11 @@
SCHEMA
-
+
EXAMPLES
A typical configuration looks like this:
@@ -110,8 +134,8 @@
]]>
-
-
+
+
SEE ALSO
@@ -120,7 +144,7 @@
-
+
©right;