X-Git-Url: http://git.indexdata.com/?a=blobdiff_plain;f=doc%2Fzoom.xml;h=c6a09e942cceb033e88995dca9a7d54a07095d08;hb=b3acb59a189d35972417558297963d8db3bdcd35;hp=db062422b2380f4c56e4f6efc6523c0016246be9;hpb=ce5802c21024c8eb2b9cd55fe6c2864b33fc3fda;p=metaproxy-moved-to-github.git
diff --git a/doc/zoom.xml b/doc/zoom.xml
index db06242..c6a09e9 100644
--- a/doc/zoom.xml
+++ b/doc/zoom.xml
@@ -54,62 +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.
-
-
-
- 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.
-
-
-
- attribute ccl
- CCL field.
-
-
-
-
-
- The final part of the configuration consists of zero or more
- cclmap elements that specifies a 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.
@@ -209,11 +284,15 @@
elementSet
Specifies the elementSet to be sent to the target if record
- transform is enabled (not to be used with the record_transform
+ 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 element set =
- pz2. If record transform is not enabled, this
- setting is not used and the element set specified by the client
+ 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.
@@ -257,6 +336,8 @@
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.
@@ -265,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.
@@ -287,7 +369,7 @@
@@ -301,6 +383,7 @@
+
]]>