X-Git-Url: http://git.indexdata.com/?a=blobdiff_plain;f=doc%2Fzoom.xml;h=e86924d2a14a2a9a97d95c402c3b8c80b8e12a19;hb=5ab2f171118becf7ee6e9ef5bdddbf889b280b7c;hp=ead20290cbf9af193954aa477e1c3d635826447e;hpb=c9a3938f6ac03698cff3942dd2a54e5261e79b36;p=metaproxy-moved-to-github.git
diff --git a/doc/zoom.xml b/doc/zoom.xml
index ead2029..e86924d 100644
--- a/doc/zoom.xml
+++ b/doc/zoom.xml
@@ -56,82 +56,126 @@
CONFIGURATION
- The configuration consists of four parts: torus,
- fieldmap, cclmap
- and log.
+ The configuration consists of six parts: torus,
+ fieldmap, cclmap,
+ contentProxy, log
+ and zoom.
- 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.
-
-
-
-
-
+ torus
+
+ The torus element specifies target profiles
+ and takes the following content:
+
+
+
+ attribute url
+
+
+ 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.
+
+
+
+
+ attribute realm
+
+
+ The default realm value. Used for %realm in URL, unless
+ specified in DATABASE argument.
+
+
+
+
+ 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".
+
+
+
+
+ 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.
+
+
+
+
+ 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
@@ -157,7 +201,7 @@
-
+ cclmap
The third part of the configuration consists of zero or more
@@ -166,28 +210,80 @@
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).
-
-
-
-
-
+
+
+ contentProxy
+
+ The contentProxy element controls content proxy'in.
+ This section
+ is optional and must only be defined if content proxy'ing is enabled.
+
+
+
+ attribute server
+
+
+ Specifies the content proxy host. The host is of the form
+ host[:port]. That is without a method (such as HTTP) and optional
+ port number.
+
+
+
+
+ attribute tmp_file
+
+
+ Specifies a filename of a session file for content proxy'ing. The
+ file should be an absolute filename that includes
+ XXXXXX which is replaced by a unique filename
+ using the mkstemp(3) system call. The default value of this
+ setting is /tmp/cf.XXXXXX.p.
+
+
+
+
+
+
+ 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).
+
+
+
+
+
+
+
+ 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.
+
+
+
+
+
+
QUERY HANDLING
@@ -202,15 +298,18 @@
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 RPN, the query is passed un-modified to the target.
Step 1: for CCL, the query is converted to RPN via
- cclmap elements part of the target profile.
+ cclmap elements part of
+ the target profile as well as
+ base CCL maps.
Step 1: For CQL, the query is converted to CCL. The mappings of
- CQL fields to CCL fields are handled by fieldmap
+ 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).
@@ -226,74 +325,92 @@
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:
+ sortStrategy
+ and sortmap_field.
+
+
+ If a sort field that does not have an equivalent
+ sortmap_-mapping is passed un-modified through the
+ conversion. It doesn't throw a diagnostic.
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.
+ The ZOOM module is driven by a number of settings that specifies how
+ to handle each target.
+ Note that unknown elements are silently ignored.
+
+
+ The elements, in alphabetical order, are:
- authentication
+ authentication
Authentication parameters to be sent to the target. For
Z39.50 targets, this will be sent as part of the
- Init Request.
+ Init Request. Authentication consists of two components: username
+ and password, separated by a slash.
- If this value is omitted or empty, not authentication information
- is simply omitted.
+ If this value is omitted or empty no authentication information is sent.
-
- piggyback
+
+ cclmap_field
- 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).
+ 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).
- queryEncoding
+ cfAuth
- 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.
+ When cfAuth is defined, its value will be used as authentication
+ to backend target and authentication setting will be specified
+ as part of a database. This is like a "proxy" for authentication and
+ is used for Connector Framework based targets.
-
+
- udb
+ cfProxy
- This value is required and specifies the unique database for
- this profile . All target profiles should hold a unique database.
+ Specifies HTTP proxy for the target in the form
+ host:port.
-
+
- cclmap_*
+ cfSubDB
- 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).
+ Specifies sub database for a Connector Framework based target.
-
+
+
+ contentConnector
+
+ Specifies a database for content-based proxy'ing.
+
+
+
+
elementSet
@@ -313,6 +430,41 @@
+ literalTransform
+
+ Specifies a XSL stylesheet to be used if record
+ transform is anabled; see description of elementSet.
+ The XSL transform is only used if the element set is set to the
+ value of element_transform in the configuration.
+
+
+ The value of literalTransform is the XSL - string encoded.
+
+
+
+
+
+ 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.
+
+
+
+
+ recordEncoding
Specifies the character encoding of records that are returned
@@ -334,6 +486,28 @@
+
+ sortmap_field
+
+ This value the native field for a target. The form of the value is
+ given by sortStrategy.
+
+
+
+
+
+ sortStrategy
+
+ Specifies sort strategy for a target. One of:
+ z3950, type7,
+ cql, sru11 or
+ embed. The embed chooses type-7
+ or CQL sortby depending on whether Type-1 or CQL is
+ actually sent to the target.
+
+
+
+
sru
@@ -346,10 +520,20 @@
+ sruVersion
+
+ Specifies the SRU version to use. It unset, version 1.2 will be
+ used. Some servers do not support this version, in which case
+ version 1.1 or even 1.0 could be set it.
+
+
+
+
+ transform
Specifies a XSL stylesheet filename to be used if record
- transform is anabled; see desciprion of elementSet.
+ transform is anabled; see description of elementSet.
The XSL transform is only used if the element set is set to the
value of element_transform in the configuration.
@@ -357,17 +541,147 @@
+ udb
+
+ This value is required and specifies the unique database for
+ this profile . All target profiles should hold a unique database.
+
+
+
+
+
+ urlRecipe
+
+ 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
+ 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
+ ${field[pattern/result/flags]}, which will take content
+ of field and perform a regular expression conversion using the pattern
+ given. For example: ${md-title[\s+/+/g]} takes
+ 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
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.
+ not be provided as this is guessed from the "sru" attribute value.
+ DATABASE parameters
+
+ Extra information may be carried in the Z39.50 Database or SRU path,
+ such as authentication to be passed to backend etc. Some of
+ the parameters override TARGET profile values. The format is
+
+
+ udb,parm1=value1&parm2=value2&...
+
+
+ Where udb is the unique database recognised by the backend and parm1,
+ value1, .. are parameters to be passed. The following describes the
+ supported parameters. Like form values in HTTP the parameters and
+ values are URL encoded. The separator, though, between udb and parameters
+ is a comma rather than a question mark. What follows question mark are
+ HTTP arguments (in this case SRU arguments).
+
+
+
+ user
+
+
+ Specifies user to be passed to backend. If this parameter is
+ omitted, the user will be taken from TARGET profile setting
+
+ authentication
+
+ .
+
+
+
+
+ password
+
+
+ Specifies password to be passed to backend. If this parameters is
+ omitted, the password will be taken from TARGET profile setting
+
+ authentication
+
+ .
+
+
+
+
+ proxy
+
+
+ Specifies one or more proxies for backend. If this parameter is
+ omitted, the proxy will be taken from TARGET profile setting
+
+ cfProxy.
+ The parameter is a list of comma-separated host:port entries.
+ Bost host and port must be given for each proxy.
+
+
+
+
+ cproxysession
+
+
+ Session ID for content proxy. This parameter is, generally,
+ not used by anything but the content proxy itself.
+
+
+
+
+ nocproxy
+
+
+ If this parameter is specified, content-proyxing is disabled
+ for the search.
+
+
+
+
+ realm
+
+
+ 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.
+
+
+
+
+ x-parm
+
+
+ All parameters that has prefix x, dash are passed verbatim
+ to the backend.
+
+
+
+
+
+ SCHEMA
+
]]>