X-Git-Url: http://jsfdemo.indexdata.com/?a=blobdiff_plain;f=doc%2Fzoom.xml;h=3f2849a4167284b3f112131d5319ea5b065ab8c4;hb=e4bcecb1d5a29b9dc3c5a674c29956def8fe01a6;hp=9d5ccf19b41746e2234140985b90fb8b3f605843;hpb=f48b9c4a53735ff0328b6775a1818a5de9237270;p=metaproxy-moved-to-github.git
diff --git a/doc/zoom.xml b/doc/zoom.xml
index 9d5ccf1..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 .
@@ -114,6 +114,14 @@
+
+ attribute auth_hostname
+
+
+ Limits IP lookup to a given logical hostname.
+
+
+ attribute realm
@@ -359,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.
@@ -374,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.
@@ -385,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
@@ -420,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
@@ -543,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:
@@ -576,7 +607,7 @@
-
+ sruVersion
Specifies the SRU version to use. It unset, version 1.2 will be
@@ -586,7 +617,7 @@
-
+ transform
Specifies a XSL stylesheet filename to be used if record
@@ -597,7 +628,7 @@
-
+ udb
This value is required and specifies the unique database for
@@ -624,7 +655,7 @@
-
+ zurl
This is setting is mandatory and specifies the ZURL of the
@@ -653,6 +684,9 @@
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:
+ content-password
@@ -665,6 +699,16 @@
+ 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
@@ -698,7 +742,7 @@
Specifies password to be passed to backend. It is also passed
- to cproxy session unless overriden by content-password.
+ to content proxy session unless overriden by content-password.
If this parameter is omitted, the password will be taken from
TARGET profile setting
@@ -734,6 +778,18 @@
+
+ retry
+
+
+ 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).
+
+
+ torus_url
@@ -753,7 +809,7 @@
Specifies user to be passed to backend. It is also passed
- to cproxy session unless overriden by content-user.
+ to content proxy session unless overriden by content-user.
If this parameter is omitted, the user will be taken from TARGET
profile setting