X-Git-Url: http://git.indexdata.com/?a=blobdiff_plain;f=doc%2Fsru_z3950.xml;h=f9bc2563c3e383a37ff0647e25068ed4a7422a64;hb=6692b8d5ffb2da3cd727a66c479d91a0218dba4e;hp=16cf570ec7ae154d6624fd3114104c8689a33b8f;hpb=e5901333c8011101505ee1a283df326663637a7e;p=metaproxy-moved-to-github.git diff --git a/doc/sru_z3950.xml b/doc/sru_z3950.xml index 16cf570..f9bc256 100644 --- a/doc/sru_z3950.xml +++ b/doc/sru_z3950.xml @@ -1,58 +1,147 @@ - + + %idcommon; ]> - - + + + Metaproxy + Index Data + + sru_z3950 3mp - Metaproxy Module + Metaproxy Module - + sru_z3950 - 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. + The sru_z3950 Metaproxy filter transforms valid + SRU GET/POST/SOAP requests to Z39.50 requests, and wraps the + received hit counts and XML records into suitable SRU response messages. - It supports only the SRU searchRetrieve operation, which - is transformed into successive Z3950 init, - search and present requests. + 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. - The SRU scan operation is not supported. + Optionally the default stylesheet may be specified. If the client + do not specify a stylesheet, the CDATA of element + stylesheet is used. + + + 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 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. + 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 the SRU searchRetrieve operation, which + is transformed into successive Z39.50 init, + search and present requests. + + + The SRU scan operation is not supported. 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: + + /my.xsl + + + ... + + + + + ]]> - - + + SEE ALSO @@ -61,21 +150,13 @@ - + ©right;