X-Git-Url: http://git.indexdata.com/?a=blobdiff_plain;f=doc%2Fzoom.xml;h=3f2849a4167284b3f112131d5319ea5b065ab8c4;hb=39fe3f90ff2cf99ec39053df3c0835ab87b0deba;hp=6b2e4806e1a83c97d3a54acdbe7d40b63c638923;hpb=0e3e8a44c4be9640180a4dc0670a82284c848b5e;p=metaproxy-moved-to-github.git diff --git a/doc/zoom.xml b/doc/zoom.xml index 6b2e480..3f2849a 100644 --- a/doc/zoom.xml +++ b/doc/zoom.xml @@ -27,7 +27,7 @@ This filter implements a generic client based on ZOOM of YAZ. The client implements the protocols that ZOOM C does: Z39.50, SRU - (GET, POST, SOAP) and SOLR . + (GET, POST, SOAP) and Solr . @@ -102,12 +102,32 @@ + + attribute auth_url + + + URL of Web service to be used to for auth/IP lookup. If this + defined, all access is granted or denied as part of Z39.50 Init + by the ZOOM module and the use of database parameters realm and + torus_url is not allowed. If this setting is not defined, + all access is allowed and realm and/or torus_url may be used. + + + + + attribute auth_hostname + + + Limits IP lookup to a given logical hostname. + + + attribute realm The default realm value. Used for %realm in URL, unless - specified in DATABASE argument. + specified in DATABASE parameter. @@ -347,7 +367,8 @@ Step 1: for CCL, the query is converted to RPN via - cclmap elements part of + cclmap + elements part of the target profile as well as base CCL maps. @@ -362,7 +383,7 @@ Step 2: If the target is Z39.50-based, it is passed verbatim (RPN). If the target is SRU-based, the RPN will be converted to CQL. - If the target is SOLR-based, the RPN will be converted to SOLR's query + If the target is Solr-based, the RPN will be converted to Solr's query type. @@ -373,8 +394,12 @@ 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: - sortStrategy - and sortmap_field. + + sortStrategy + + and + sortmap_field + . If a sort field that does not have an equivalent @@ -408,7 +433,25 @@ - + + authenticationMode + + Specifies how authentication parameters are passed to server + for SRU. Possible values are: url + and basic. For the url mode username and password + are carried in URL arguments x-username and x-password. + For the basic mode, HTTP basic authentication is used. + The settings only takes effect + if authentication + is set. + + + If this value is omitted HTTP basic authencation is used. + + + + + cclmap_field This value specifies CCL field (qualifier) definition for some @@ -531,16 +574,16 @@ - + sortmap_field This value the native field for a target. The form of the value is - given by sortStrategy. + given by sortStrategy. - + sortStrategy Specifies sort strategy for a target. One of: @@ -564,7 +607,7 @@ - + sruVersion Specifies the SRU version to use. It unset, version 1.2 will be @@ -574,7 +617,7 @@ - + transform Specifies a XSL stylesheet filename to be used if record @@ -585,7 +628,7 @@ - + udb This value is required and specifies the unique database for @@ -612,7 +655,7 @@ - + zurl This is setting is mandatory and specifies the ZURL of the @@ -641,17 +684,56 @@ is a comma rather than a question mark. What follows question mark are HTTP arguments (in this case SRU arguments). + + The database parameters, in alphabetical order, are: + - user + content-password - Specifies user to be passed to backend. If this parameter is - omitted, the user will be taken from TARGET profile setting - - authentication - - . + The password to be used for content proxy session. If this parameter + is not given, value of parameter password is passed + to content proxy session. + + + + + content-proxy + + + Specifies proxy to be used for content proxy session. If this parameter + is not given, value of parameter proxy is passed + to content proxy session. + + + + + content-user + + + The user to be used for content proxy session. If this parameter + is not given, value of parameter user is passed + to content proxy session. + + + + + cproxysession + + + Specifies the session ID for content proxy. This parameter is, generally, + not used by anything but the content proxy itself when invoking + Metaproxy via SRU. + + + + + nocproxy + + + If this parameter is specified, content-proxying is disabled + for the search. @@ -659,8 +741,10 @@ password - Specifies password to be passed to backend. If this parameters is - omitted, the password will be taken from TARGET profile setting + Specifies password to be passed to backend. It is also passed + to content proxy session unless overriden by content-password. + If this parameter is omitted, the password will be taken from + TARGET profile setting authentication @@ -682,30 +766,56 @@ - cproxysession + realm - Session ID for content proxy. This parameter is, generally, - not used by anything but the content proxy itself. + Session realm to be used for this target, changed the resulting + URL to be used for getting a target profile, by changing the + value that gets substituted for the %realm string. This parameter + is not allowed if access is controlled by + auth_url + in configuration. - nocproxy + retry - If this parameter is specified, content-proyxing is disabled - for the search. + Optional paramater. If the value is 0, retry on failure is + disabled for the ZOOM module. Any other value enables retry + on failure. If this parameter is omitted, then the value of + retryOnFailure + from the Torus record is used (same values). + - realm + torus_url - Session realm to be used for this target, changed the resulting - URL to be used for getting a target profile, by changing the - value that gets substituted for the %realm string. + Sets the URL to be used for Torus records fetch - overriding value + of url attribute of element torus + in zoom configuration. This parameter is not allowed if access is + controlled by + auth_url in configuration. + + + + + + user + + + Specifies user to be passed to backend. It is also passed + to content proxy session unless overriden by content-user. + If this parameter is omitted, the user will be taken from TARGET + profile setting + + authentication + + .