X-Git-Url: http://git.indexdata.com/?a=blobdiff_plain;f=doc%2Fsru_z3950.xml;h=459987109f4ea18388e576d6c062e488320ceb02;hb=5ab2f171118becf7ee6e9ef5bdddbf889b280b7c;hp=dbe6581e844a5d2d67c4d64216f0d05c3e66f0d2;hpb=3c218907e35bbed20a7fb3d70b55468ab6d81234;p=metaproxy-moved-to-github.git diff --git a/doc/sru_z3950.xml b/doc/sru_z3950.xml index dbe6581..4599871 100644 --- a/doc/sru_z3950.xml +++ b/doc/sru_z3950.xml @@ -1,28 +1,56 @@ - + + %idcommon; ]> - - + + + Metaproxy + Index Data + + sru_z3950 3mp - Metaproxy Module + Metaproxy Module sru_z3950 - transforming SRU webservice requests to Z3950 metaproxy packages + Metaproxy Module transforming SRU web service requests to Z3950 Metaproxy packages DESCRIPTION - The sru_z3950 metaproxy filter transforms valid - SRU/GET or SRU/SOAP requests to Z3950 requests, and wraps the - recieved hit counts and XML records into suitable SRU response messages. + 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. + + + 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. + Notice that explain + records come in SRU and Z39.50 flavors, and this filter requires + the SRU version. See the + ZeeReX Explain + standard pages and the + SRU Explain pages + for more information. + + + All Z39.50 packages and all HTTP packages that do not resolve to + one configured database name are passed unaltered to the next + filters on the route. + + + The SRU explain operation is supported, + returning either the absolute minimum required by the standard, or + a full pre-defined ZeeReX explain record. - It supports only the SRU searchRetrieve operation, which + It supports the SRU searchRetrieve operation, which is transformed into successive Z3950 init, search and present requests. @@ -30,25 +58,78 @@ The SRU scan operation is not supported. - The SRU explain operation is not supported. - A configuration for a full SRU server needs to prepend the - zeerex_explain filter in front of this - sru_z3950 to serve explain requests. This filter - still needs to be implemented. - - This filter does not handle CQL-to-PQF translations. In case that - the backends do not understand CQL, you need to prepend the - cql_pqf metaproxy filter. This filter - still needs to be implemented. - + the backends do not understand CQL, you need to append the + cql_pqf metaproxy filter. + + + This module supports the following SRU extra parameters: + + + x-target + + + Specifies backend Z39.50 target. + + + + + x-max-sockets + + + Specifies maximum number of sockets to use for a Z39.50 backend + client (for one given target host/db). + + + + + 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). + + + + + + SCHEMA + + + + EXAMPLES A typical configuration looks like this: + + + + ... + + + + + ]]> @@ -68,15 +149,7 @@