From: Adam Dickmeiss Date: Mon, 17 Oct 2011 09:06:01 +0000 (+0200) Subject: Reformat X-Git-Tag: v1.3.12~17 X-Git-Url: http://sru.miketaylor.org.uk/cgi-bin?a=commitdiff_plain;h=c9a3938f6ac03698cff3942dd2a54e5261e79b36;p=metaproxy-moved-to-github.git Reformat --- diff --git a/doc/zoom.xml b/doc/zoom.xml index 92ce42e..ead2029 100644 --- a/doc/zoom.xml +++ b/doc/zoom.xml @@ -9,7 +9,7 @@ Metaproxy Index Data - + zoom 3mp @@ -21,14 +21,15 @@ Metaproxy ZOOM Module - DESCRIPTION + + DESCRIPTION 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 . - + This filter only deals with Z39.50 on input. The following services are supported: init, search, present and close. The backend target @@ -52,322 +53,331 @@ - CONFIGURATION - - The configuration consists of four parts: torus, - fieldmap, cclmap - and log. - - torus + + CONFIGURATION + + The configuration consists of four parts: torus, + fieldmap, cclmap + and log. + + torus + + The torus element specifies target profiles + and takes the following content: + + + + attribute url + - The torus element specifies target profiles - and takes the following content: + 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. - - - 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. - - - - - attribute proxy - - - HTTP proxy to bse used for fetching target profiles. - - - - - attribute xsldir - - - Directory that is searched for XSL stylesheets. Stylesheets - are specified in the target profile by the - transform element. - - - - - attribute element_transform - - - Specifies the element that triggers retrieval and transform using - the parameters elementSet, recordEncoding, requestSyntax, transform - from the target profile. Default value - is "pz2", due to the fact that for historical reasons the - common format is that used in Pazpar2. - - - - - attribute element_raw - - - Specifies an element that triggers retrieval using the - parameters elementSet, recordEncoding, requestSyntax from the - target profile. Same actions as for element_transform, but without - the XSL transform. Useful for debugging. - The default value is "raw". - - - - - element records - - - Local target profiles. This element may includes zero or - more record elements (one per target - profile). See section TARGET PROFILE. - - - - - - fieldmap + + + + attribute proxy + - The fieldmap may be specified zero or more times and - specifies the map from CQL fields to CCL fields and takes the - following content: + HTTP proxy to bse used for fetching target profiles. - - - attribute cql - - - CQL field that we are mapping "from". - - - - - attribute ccl - - - CCL field that we are mapping "to". - - - - - - cclmap + + + + attribute xsldir + - The third part of the configuration consists of zero or more - cclmap elements that specifies - base CCL profile to be used for all targets. - This configuration, thus, will be combined with cclmap-definitions - from the target profile. + Directory that is searched for XSL stylesheets. Stylesheets + are specified in the target profile by the + transform element. - - log + + + + attribute element_transform + - The log element controls logging for the - ZOOM filter. + Specifies the element that triggers retrieval and transform using + the parameters elementSet, recordEncoding, requestSyntax, transform + from the target profile. Default value + is "pz2", due to the fact that for historical reasons the + common format is that used in Pazpar2. - - - attribute apdu - - - If the value of apdu is "true", then protocol packages - (APDUs and HTTP packages) from the ZOOM filter will be - logged to the yaz_log system. A value of "false" will - not perform logging of protocol packages (the default - behavior). - - - - - - - QUERY HANDLING - - The ZOOM filter accepts three query types: RPN(Type-1), CCL and - CQL. - - - Queries are converted in two separate steps. In the first step - the input query is converted to RPN/Type-1. This is always - the common internal format between step 1 and step 2. - In step 2 the query is converted to the native query type of the target. - - - Step 1: for RPN, the query is passed unmodified to the target. - - - Step 1: for CCL, the query is converted to RPN via - cclmap elements part of the target profile. - + + + + attribute element_raw + + + Specifies an element that triggers retrieval using the + parameters elementSet, recordEncoding, requestSyntax from the + target profile. Same actions as for element_transform, but without + the XSL transform. Useful for debugging. + The default value is "raw". + + + + + element records + + + Local target profiles. This element may includes zero or + more record elements (one per target + profile). See section TARGET PROFILE. + + + + + + + fieldmap - Step 1: For CQL, the query is converted to CCL. The mappings of - CQL fields to CCL fields are handled by fieldmap - elements as part of the target profile. The resulting query, CCL, - is the converted to RPN using the schema mentioned earlier (via - cclmap). + The fieldmap may be specified zero or more times and + specifies the map from CQL fields to CCL fields and takes the + following content: + + + attribute cql + + + CQL field that we are mapping "from". + + + + + attribute ccl + + + CCL field that we are mapping "to". + + + + + + + cclmap - 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 - type. + The third part of the configuration consists of zero or more + cclmap elements that specifies + base CCL profile to be used for all targets. + This configuration, thus, will be combined with cclmap-definitions + from the target profile. + + + log + + The log element controls logging for the + ZOOM filter. + + + + attribute apdu + + + If the value of apdu is "true", then protocol packages + (APDUs and HTTP packages) from the ZOOM filter will be + logged to the yaz_log system. A value of "false" will + not perform logging of protocol packages (the default + behavior). + + + + + - - SORTING + + QUERY HANDLING - + The ZOOM filter accepts three query types: RPN(Type-1), CCL and + CQL. + + + Queries are converted in two separate steps. In the first step + the input query is converted to RPN/Type-1. This is always + the common internal format between step 1 and step 2. + In step 2 the query is converted to the native query type of the target. + + + Step 1: for RPN, the query is passed unmodified to the target. + + + Step 1: for CCL, the query is converted to RPN via + cclmap elements part of the target profile. + + + Step 1: For CQL, the query is converted to CCL. The mappings of + CQL fields to CCL fields are handled by fieldmap + elements as part of the target profile. The resulting query, CCL, + is the converted to RPN using the schema mentioned earlier (via + cclmap). + + + 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 + type. - TARGET PROFILE - - The following elements are honored by the ZOOM module of Metaproxy. - Note that unknown elements are silently ignored. There are several - elements in use that makes no sense to the ZOOM module. - - - - authentication - - Authentication parameters to be sent to the target. For - Z39.50 targets, this will be sent as part of the - Init Request. - - - If this value is omitted or empty, not authentication information - is simply omitted. - - - - - - piggyback - - A value of 1/true is a hint to the ZOOM module that this Z39.50 - target supports piggyback searches, ie Search Response with - records. Any other value (false) will prevent the ZOOM module - to make use of piggyback (all records part of Present Response). - - - - - - queryEncoding - - If this value is defined, all queries will be converted - to this encoding. This should be used for all Z39.50 targets that - do not use UTF-8 for query terms. - - - - - - udb - - This value is required and specifies the unique database for - this profile . All target profiles should hold a unique database. - - - - - - cclmap_* - - This value specifies CCL field (qualifier) definition for some - field. For Z39.50 targets this most likely will specify the - mapping to a numeric use attribute + a structure attribute. - For SRU targets, the use attribute should be string based, in - order to make the RPN to CQL conversion work properly (step 2). - - - - - - elementSet - - Specifies the elementSet to be sent to the target if record - transform is enabled (not to be confused' with the record_transform - module). The record transform is enabled only if the client uses - record syntax = XML and a element set determined by - the element_transform / - element_raw from the configuration. - By default that is the element sets pz2 - and raw. - If record transform is not enabled, this setting is - not used and the element set specified by the client - is passed verbatim. - - - + + SORTING + + + + + + + TARGET PROFILE + + The following elements are honored by the ZOOM module of Metaproxy. + Note that unknown elements are silently ignored. There are several + elements in use that makes no sense to the ZOOM module. + + + + authentication + + Authentication parameters to be sent to the target. For + Z39.50 targets, this will be sent as part of the + Init Request. + + + If this value is omitted or empty, not authentication information + is simply omitted. + + + + + + piggyback + + A value of 1/true is a hint to the ZOOM module that this Z39.50 + target supports piggyback searches, ie Search Response with + records. Any other value (false) will prevent the ZOOM module + to make use of piggyback (all records part of Present Response). + + + + + + queryEncoding + + If this value is defined, all queries will be converted + to this encoding. This should be used for all Z39.50 targets that + do not use UTF-8 for query terms. + + + + + + udb + + This value is required and specifies the unique database for + this profile . All target profiles should hold a unique database. + + + + + + cclmap_* + + This value specifies CCL field (qualifier) definition for some + field. For Z39.50 targets this most likely will specify the + mapping to a numeric use attribute + a structure attribute. + For SRU targets, the use attribute should be string based, in + order to make the RPN to CQL conversion work properly (step 2). + + + + + + elementSet + + Specifies the elementSet to be sent to the target if record + transform is enabled (not to be confused' with the record_transform + module). The record transform is enabled only if the client uses + record syntax = XML and a element set determined by + the element_transform / + element_raw from the configuration. + By default that is the element sets pz2 + and raw. + If record transform is not enabled, this setting is + not used and the element set specified by the client + is passed verbatim. + + + - - recordEncoding - - Specifies the character encoding of records that are returned - by the target. This is primarily used for targets were records - are not UTF-8 encoded already. This setting is only used - if the record transform is enabled (see description of elementSet). - - - + + recordEncoding + + Specifies the character encoding of records that are returned + by the target. This is primarily used for targets were records + are not UTF-8 encoded already. This setting is only used + if the record transform is enabled (see description of elementSet). + + + - - requestSyntax - - Specifies the record syntax to be specified for the target - if record transform is enabled; see description of elementSet. - If record transform is not enabled, the record syntax of the - client is passed verbatim to the target. - - - + + requestSyntax + + Specifies the record syntax to be specified for the target + if record transform is enabled; see description of elementSet. + If record transform is not enabled, the record syntax of the + client is passed verbatim to the target. + + + - - sru - - If this setting is set, it specifies that the target is web service - based and must be one of : get, - post, soap - or solr. - - - + + sru + + If this setting is set, it specifies that the target is web service + based and must be one of : get, + post, soap + or solr. + + + - - transform - - Specifies a XSL stylesheet filename to be used if record - transform is anabled; see desciprion of elementSet. - The XSL transform is only used if the element set is set to the - value of element_transform in the configuration. - - - + + transform + + Specifies a XSL stylesheet filename to be used if record + transform is anabled; see desciprion of elementSet. + The XSL transform is only used if the element set is set to the + value of element_transform in the configuration. + + + - - zurl - - This is setting is mandatory and specifies the ZURL of the - target in the form of host/database. The HTTP method should - not be provide as this is guessed from the "sru" attribute value. - - - - + + zurl + + This is setting is mandatory and specifies the ZURL of the + target in the form of host/database. The HTTP method should + not be provide as this is guessed from the "sru" attribute value. + + + + - SCHEMA - - + + SCHEMA + + - EXAMPLES + + EXAMPLES The following configuration illustrates most of the facilities: @@ -394,10 +404,11 @@ ]]> - + - SEE ALSO + + SEE ALSO metaproxy