X-Git-Url: http://lists.indexdata.com/cgi-bin?a=blobdiff_plain;f=doc%2Fzoom.xml;h=1355d762ca4073c5bad734ae3bf4e2f3c5cf4371;hb=4f606f0faf502a0aa4d05d3b84caca247759c806;hp=50a468221cd25ac7aec0ea7b39a1569887d8e04b;hpb=bf6a5858e2c8839a5f8a4bdf087bcb94c54084bb;p=metaproxy-moved-to-github.git diff --git a/doc/zoom.xml b/doc/zoom.xml index 50a4682..1355d76 100644 --- a/doc/zoom.xml +++ b/doc/zoom.xml @@ -1,4 +1,4 @@ - @@ -9,18 +9,18 @@ Metaproxy Index Data - + zoom 3mp Metaproxy Module - + zoom Metaproxy ZOOM Module - + DESCRIPTION @@ -29,7 +29,7 @@ The client implements the protocols that ZOOM C does: Z39.50, SRU (GET, POST, SOAP) and SOLR . - + This filter only deals with Z39.50 on input. The following services are supported: init, search, present and close. The backend target @@ -56,9 +56,10 @@ CONFIGURATION - The configuration consists of five parts: torus, + The configuration consists of six parts: torus, fieldmap, cclmap, - contentProxy and log. + contentProxy, log + and zoom. torus @@ -71,15 +72,34 @@ attribute url - URL of Web service to be used to fetch target profile - for a given database (udb). The special sequence - %db of the URL is replaced by the - actual database specified as part of Search. + URL of Web service to be used when fetch target profiles from + a remote service (Torus normally). + + + The sequence %query is replaced with a CQL + query for the Torus search. The special sequence %realm is replaced by value of attribute realm or by realm DATABASE argument. + + The special sequence %db is replaced with + a single database while searching. Note that this sequence + is no longer needed, because the %query can already + query for a single database by using CQL query + udb==.... + + + + + attribute content_url + + + URL of Web service to be used to fetch target profile + for a given database (udb) of type content. Semantics otherwise like + url attribute above. + @@ -134,6 +154,29 @@ + attribute explain_xsl + + + Specifies a stylesheet that converts one or more Torus records + to ZeeExplain records. The content of recordData is assumed to be + holding each Explain record. + + + + + attribute record_xsl + + + Specifies a stylesheet that converts retrieval records after + transform/literal operations. + + + When Metaproxy creates a content proxy session, the XSL parameter + cproxyhost is passed to the transform. + + + + element records @@ -190,6 +233,17 @@ + attribute config_file + + + Specifies the file that configures the cf-proxy system. Metaproxy + uses setting sessiondir and + proxyhostname from that file to configure + name of proxy host and directory of parameter files for the cf-proxy. + + + + attribute server @@ -197,6 +251,12 @@ host[:port]. That is without a method (such as HTTP) and optional port number. + + + This setting is deprecated. Use the config_file (above) + to inform about the proxy server. + + @@ -209,6 +269,12 @@ using the mkstemp(3) system call. The default value of this setting is /tmp/cf.XXXXXX.p. + + + This setting is deprecated. Use the config_file (above) + to inform about the session file area. + + @@ -234,6 +300,35 @@ + + + zoom + + The zoom element controls settings for the + ZOOM. + + + + attribute timeout + + + Is an integer that specifies, in seconds, how long an operation + may take before ZOOM gives up. Default value is 40. + + + + + attribute proxy_timeout + + + Is an integer that specifies, in seconds, how long an operation + a proxy check will wait before giving up. Default value is 1. + + + + + + QUERY HANDLING @@ -253,7 +348,7 @@ Step 1: for CCL, the query is converted to RPN via cclmap elements part of - the target profile as well as + the target profile as well as base CCL maps. @@ -271,13 +366,13 @@ type. - + SORTING The ZOOM module actively handle CQL sorting - using the SORTBY parameter which was introduced in SRU version 1.2. The conversion from SORTBY clause - to native sort for some target is driven by the two parameters: + to native sort for some target is driven by the two parameters: sortStrategy and sortmap_field. @@ -287,7 +382,7 @@ conversion. It doesn't throw a diagnostic. - + TARGET PROFILE @@ -312,7 +407,7 @@ - + cclmap_field @@ -324,7 +419,7 @@ - + cfAuth @@ -372,7 +467,7 @@ element_raw from the configuration. By default that is the element sets pz2 and raw. - If record transform is not enabled, this setting is + If record transform is not enabled, this setting is not used and the element set specified by the client is passed verbatim. @@ -392,7 +487,7 @@ - + piggyback @@ -403,7 +498,7 @@ - + queryEncoding @@ -413,7 +508,7 @@ - + recordEncoding @@ -444,7 +539,7 @@ - + sortStrategy @@ -457,7 +552,7 @@ - + sru @@ -504,7 +599,7 @@ The value of this field is a string that generates a dynamic link based on record content. If the resulting string is non-zero in length - a new field, metadata with attribute + a new field, metadata with attribute type="generated-url" is generated. The contents of this field is the result of the URL recipe conversion. The urlRecipe value may refer to an existing metadata element by @@ -514,15 +609,9 @@ metadata element title and converts one or more spaces to a plus character. - - If the contentConnector - setting also defined, the resulting value is - augmented with a session string as well as host name of the - content proxy server. - - + zurl @@ -552,7 +641,7 @@ is a comma rather than a question mark. What follows question mark are HTTP arguments (in this case SRU arguments). - + user @@ -583,12 +672,12 @@ proxy - Specifies proxy to be for backend. If this parameters is + Specifies one or more proxies for backend. If this parameter is omitted, the proxy will be taken from TARGET profile setting - cfProxy - - . + cfProxy. + The parameter is a list of comma-separated host:port entries. + Bost host and port must be given for each proxy. @@ -602,6 +691,15 @@ + nocproxy + + + If this parameter is specified, content-proyxing is disabled + for the search. + + + + realm @@ -620,17 +718,17 @@ - + SCHEMA - + EXAMPLES @@ -639,7 +737,7 @@ @@ -647,7 +745,7 @@ - + @@ -655,13 +753,14 @@ + ]]> - - - + + + SEE ALSO @@ -677,7 +776,7 @@ - + ©right;