From: Adam Dickmeiss Date: Fri, 12 Aug 2011 08:57:13 +0000 (+0200) Subject: zoom doc: describe log, proxy X-Git-Tag: v1.3.5~1 X-Git-Url: http://git.indexdata.com/?a=commitdiff_plain;h=eb2f36fbec12a2063183d5ae4a9568c55e28acdc;p=metaproxy-moved-to-github.git zoom doc: describe log, proxy --- diff --git a/doc/zoom.xml b/doc/zoom.xml index cbda07e..c6a09e9 100644 --- a/doc/zoom.xml +++ b/doc/zoom.xml @@ -54,95 +54,137 @@ CONFIGURATION - The configuration consists of three parts: torus, - fieldmap and cclmap. - - - The torus element specifies target profiles - and takes the following content: - - - - 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 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. - - - - - - 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". - - - - - - The final 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. + 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 + + + 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 + + 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 + + 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). + + + + + - QUERIES + QUERY HANDLING The ZOOM filter accepts three query types: RPN(Type-1), CCL and CQL. @@ -304,7 +346,8 @@ zurl This is setting is mandatory and specifies the ZURL of the - targetin the form of host/database. + target in the form of host/database. The HTTP method should + not be provide as this is guessed from the "sru" attribute value. @@ -326,7 +369,7 @@ @@ -340,6 +383,7 @@ + ]]>