X-Git-Url: http://sru.miketaylor.org.uk/?a=blobdiff_plain;f=doc%2Fzoom.xml;h=d8ae9e25da95db4087369b56807247e15303e7c4;hb=48303fd661d8987d0ad1211180b36cd7c2484d46;hp=a971125a2c9be57f890f0e8cbec144bb1b639b6d;hpb=c03baef23be97fa40de8b65e46a3fdde9469effa;p=metaproxy-moved-to-github.git
diff --git a/doc/zoom.xml b/doc/zoom.xml
index a971125..d8ae9e2 100644
--- a/doc/zoom.xml
+++ b/doc/zoom.xml
@@ -76,9 +76,22 @@
%db of the URL is replaced by the
actual database specified as part of Search.
+
+ The special sequence %realm is replaced by value
+ of attribute realm or by realm DATABASE argument.
+
+ attribute realm
+
+
+ The default realm value. Used for %realm in URL, unless
+ specified in DATABASE argument.
+
+
+
+ attribute proxy
@@ -132,7 +145,7 @@
-
+ fieldmap
The fieldmap may be specified zero or more times and
@@ -158,7 +171,7 @@
-
+ cclmap
The third part of the configuration consists of zero or more
@@ -239,11 +252,14 @@
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).
@@ -262,8 +278,8 @@
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
@@ -284,11 +300,12 @@
- 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 no authentication information is sent.
@@ -296,8 +313,8 @@
-
- cclmap_*
+
+ cclmap_field
This value specifies CCL field (qualifier) definition for some
field. For Z39.50 targets this most likely will specify the
@@ -320,7 +337,7 @@
- cfProxy
+ cfProxy
Specifies HTTP proxy for the target in the form
host:port.
@@ -329,14 +346,14 @@
- cfSubDb
+ cfSubDB
Specifies sub database for a Connector Framework based target.
-
+ contentConnector
Specifies a database for content-based proxy'ing.
@@ -419,15 +436,16 @@
-
- sortmap_
+
+ sortmap_field
- This value the native field for a target.
+ 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:
@@ -452,6 +470,16 @@
+ 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
@@ -471,23 +499,25 @@
-
+ urlRecipe
The value of this field is a string that generates a dynamic link
- based on content. If the resulting string is non-zero in length
+ based on record content. If the resulting string is non-zero in length
a new field, metadata with attribute
- type=generated-url. 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
+ type="generated-url".
+ 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
metadadata element title and converts one or more
spaces to a plus character.
- If the contentConnector setting is defined the resulting value is
- agmented with a session string as well as the content proxy server.
+ If the contentConnector
+ setting also defined, the resulting value is
+ augmented with a session string as well as the content proxy server.
@@ -497,13 +527,101 @@
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 proxy to be for backend. If this parameters is
+ omitted, the proxy will be taken from TARGET profile setting
+
+ cfProxy
+
+ .
+
+
+
+
+ cproxysession
+
+
+ Session ID for content proxy. This parameter is, generally,
+ not used by anything but the content proxy itself.
+
+
+
+
+ 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