X-Git-Url: http://jsfdemo.indexdata.com/?a=blobdiff_plain;f=doc%2Fzoom.xml;h=4221f2ea181247307d853e9409ec502ffdd90a82;hb=03e8dbd1c27b7ac1540e1710becc7d4ecf7fdb95;hp=768773629974817fec2e196d001ddea5a40b1cbe;hpb=518797519fea5741e4fa45f36c97eb9c4a18640b;p=metaproxy-moved-to-github.git
diff --git a/doc/zoom.xml b/doc/zoom.xml
index 7687736..4221f2e 100644
--- a/doc/zoom.xml
+++ b/doc/zoom.xml
@@ -1,4 +1,4 @@
-
@@ -9,27 +9,27 @@
Metaproxy
Index Data
-
+
zoom
3mp
Metaproxy Module
-
+
zoom
Metaproxy ZOOM Module
-
+
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 .
+ (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
@@ -102,12 +102,24 @@
+
+ attribute auth_url
+
+
+ URL of Web service to be used to for auth/IP lookup. If this
+ defined, all access is granted or denied as part of Z39.50 Init
+ by the ZOOM module and the use of database parameters realm and
+ torus_url is not allowed. If this setting is not defined,
+ all access is allowed and realm and/or torus_url may be used.
+
+
+
attribute realm
The default realm value. Used for %realm in URL, unless
- specified in DATABASE argument.
+ specified in DATABASE parameter.
@@ -172,7 +184,7 @@
When Metaproxy creates a content proxy session, the XSL parameter
- cproxyhost is passed to the transform.
+ cproxyhost is passed to the transform.
@@ -347,8 +359,9 @@
Step 1: for CCL, the query is converted to RPN via
- cclmap elements part of
- the target profile as well as
+ cclmap
+ elements part of
+ the target profile as well as
base CCL maps.
@@ -362,19 +375,23 @@
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.
-
+
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.
+ 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
@@ -382,7 +399,7 @@
conversion. It doesn't throw a diagnostic.
-
+
TARGET PROFILE
@@ -407,8 +424,26 @@
-
-
+
+
+ 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
@@ -419,7 +454,7 @@
-
+
cfAuth
@@ -467,7 +502,7 @@
element_raw from the configuration.
By default that is the element sets pz2
and raw.
- If record transform is not enabled, this setting is
+ If record transform is not enabled, this setting is
not used and the element set specified by the client
is passed verbatim.
@@ -487,7 +522,7 @@
-
+
piggyback
@@ -498,7 +533,7 @@
-
+
queryEncoding
@@ -508,7 +543,7 @@
-
+
recordEncoding
@@ -531,16 +566,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:
@@ -552,7 +587,7 @@
-
+
sru
@@ -564,7 +599,7 @@
-
+
sruVersion
Specifies the SRU version to use. It unset, version 1.2 will be
@@ -574,7 +609,7 @@
-
+
transform
Specifies a XSL stylesheet filename to be used if record
@@ -585,7 +620,7 @@
-
+
udb
This value is required and specifies the unique database for
@@ -599,7 +634,7 @@
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
+ 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
@@ -611,8 +646,8 @@
-
-
+
+
zurl
This is setting is mandatory and specifies the ZURL of the
@@ -641,17 +676,53 @@
is a comma rather than a question mark. What follows question mark are
HTTP arguments (in this case SRU arguments).
-
+
- user
+ content-password
- Specifies user to be passed to backend. If this parameter is
- omitted, the user will be taken from TARGET profile setting
-
- authentication
-
- .
+ The password to be used for content proxy session. If this parameter
+ is not given, value of parameter password is passed
+ to content proxy session.
+
+
+
+
+ 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
+
+
+ The user to be used for content proxy session. If this parameter
+ is not given, value of parameter user is passed
+ to content proxy session.
+
+
+
+
+ cproxysession
+
+
+ Specifies the session ID for content proxy. This parameter is, generally,
+ not used by anything but the content proxy itself when invoking
+ Metaproxy via SRU.
+
+
+
+
+ nocproxy
+
+
+ If this parameter is specified, content-proxying is disabled
+ for the search.
@@ -659,8 +730,10 @@
password
- Specifies password to be passed to backend. If this parameters is
- omitted, the password will be taken from TARGET profile setting
+ Specifies password to be passed to backend. It is also passed
+ to content proxy session unless overriden by content-password.
+ If this parameter is omitted, the password will be taken from
+ TARGET profile setting
authentication
@@ -682,30 +755,44 @@
- cproxysession
+ realm
- Session ID for content proxy. This parameter is, generally,
- not used by anything but the content proxy itself.
+ 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. This parameter
+ is not allowed if access is controlled by
+ auth_url
+ in configuration.
+
- nocproxy
+ torus_url
- If this parameter is specified, content-proyxing is disabled
- for the search.
+ Sets the URL to be used for Torus records fetch - overriding value
+ of url attribute of element torus
+ in zoom configuration. This parameter is not allowed if access is
+ controlled by
+ auth_url in configuration.
+
- realm
+ user
- 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.
+ Specifies user to be passed to backend. It is also passed
+ to content proxy session unless overriden by content-user.
+ If this parameter is omitted, the user will be taken from TARGET
+ profile setting
+
+ authentication
+
+ .
@@ -718,22 +805,26 @@
-
+
SCHEMA
-
+
EXAMPLES
- The following configuration illustrates most of the
- facilities:
+ In example below Target definitions (Torus records) are fetched
+ from a web service via a proxy. A CQL profile is configured which
+ maps to a set of CCL fields ("no field", au, tu and su). Presumably
+ the target definitions fetched maps the CCL to their native RPN.
+ A CCL "ocn" is mapped for all targets. Logging of APDUs are enabled,
+ and a timeout is given.
-
+
@@ -758,9 +849,38 @@
]]>
-
-
-
+
+
+ Here is another example with two locally defined targets: A
+ Solr target and a Z39.50 target.
+
+
+
+
+
+ ocs-test
+ t=z
+ u=title t=z
+ solr
+ ocs-test.indexdata.com/solr/select
+
+
+ loc
+ t=l,r
+ u=4 t=l,r
+ z3950.loc.gov:7090/voyager
+
+
+
+
+
+
+]]>
+
+
+
+
SEE ALSO
@@ -776,7 +896,7 @@
-
+
©right;