X-Git-Url: http://jsfdemo.indexdata.com/?a=blobdiff_plain;f=doc%2Fzoom.xml;h=6b2e4806e1a83c97d3a54acdbe7d40b63c638923;hb=453ef6af83ca65ce67454e77764fd382162f8813;hp=09c8afe2f8b37608798b2347daa016105c919c26;hpb=7a5fb5eb34cc8f0d976259a4c90a448de29a3d3c;p=metaproxy-moved-to-github.git

diff --git a/doc/zoom.xml b/doc/zoom.xml
index 09c8afe..6b2e480 100644
--- a/doc/zoom.xml
+++ b/doc/zoom.xml
@@ -1,4 +1,4 @@
-<!DOCTYPE refentry PUBLIC "-//OASIS//DTD DocBook V4.4//EN" 
+<!DOCTYPE refentry PUBLIC "-//OASIS//DTD DocBook V4.4//EN"
     "http://www.oasis-open.org/docbook/xml/4.4/docbookx.dtd" [
  <!ENTITY copyright SYSTEM "copyright.xml">
  <!ENTITY % idcommon SYSTEM "common/common.ent">
@@ -9,18 +9,18 @@
   <productname>Metaproxy</productname>
   <info><orgname>Index Data</orgname></info>
  </refentryinfo>
- 
+
  <refmeta>
   <refentrytitle>zoom</refentrytitle>
   <manvolnum>3mp</manvolnum>
   <refmiscinfo class="manual">Metaproxy Module</refmiscinfo>
  </refmeta>
- 
+
  <refnamediv>
   <refname>zoom</refname>
   <refpurpose>Metaproxy ZOOM Module</refpurpose>
  </refnamediv>
- 
+
  <refsect1>
   <title>DESCRIPTION</title>
   <para>
@@ -29,7 +29,7 @@
    The client implements the protocols that ZOOM C does: Z39.50, SRU
    (GET, POST, SOAP) and SOLR .
   </para>
-  
+
   <para>
    This filter only deals with Z39.50 on input. The following services
    are supported: init, search, present and close. The backend target
@@ -170,6 +170,10 @@
        Specifies a stylesheet that converts retrieval records after
        transform/literal operations.
       </para>
+      <para>
+       When Metaproxy creates a content proxy session, the XSL parameter
+       <literal>cproxyhost</literal> is passed to the transform.
+      </para>
      </listitem>
     </varlistentry>
     <varlistentry>
@@ -229,6 +233,17 @@
    </para>
    <variablelist>
     <varlistentry>
+     <term>attribute <literal>config_file</literal></term>
+     <listitem>
+      <para>
+       Specifies the file that configures the cf-proxy system. Metaproxy
+       uses setting <literal>sessiondir</literal> and
+       <literal>proxyhostname</literal> from that file to configure
+       name of proxy host and directory of parameter files for the cf-proxy.
+      </para>
+     </listitem>
+    </varlistentry>
+    <varlistentry>
      <term>attribute <literal>server</literal></term>
      <listitem>
       <para>
@@ -236,6 +251,12 @@
        host[:port]. That is without a method (such as HTTP) and optional
        port number.
       </para>
+      <note>
+       <para>
+	This setting is deprecated. Use the config_file (above)
+	to inform about the proxy server.
+       </para>
+      </note>
      </listitem>
     </varlistentry>
     <varlistentry>
@@ -248,6 +269,12 @@
        using the mkstemp(3) system call. The default value of this
        setting is <literal>/tmp/cf.XXXXXX.p</literal>.
       </para>
+      <note>
+       <para>
+	This setting is deprecated. Use the config_file (above)
+	to inform about the session file area.
+       </para>
+      </note>
      </listitem>
     </varlistentry>
    </variablelist>
@@ -290,6 +317,15 @@
       </para>
      </listitem>
     </varlistentry>
+    <varlistentry>
+     <term>attribute <literal>proxy_timeout</literal></term>
+     <listitem>
+      <para>
+       Is an integer that specifies, in seconds, how long an operation
+       a proxy check will wait before giving up. Default value is 1.
+      </para>
+     </listitem>
+    </varlistentry>
    </variablelist>
   </refsect2>
 
@@ -312,7 +348,7 @@
   <para>
    Step 1: for CCL, the query is converted to RPN via
    <link linkend="cclmap"><literal>cclmap</literal></link> elements part of
-   the target profile as well as 
+   the target profile as well as
    <link linkend="cclmap_base">base CCL maps</link>.
   </para>
   <para>
@@ -330,13 +366,13 @@
    type.
   </para>
  </refsect1>
- 
+
  <refsect1>
   <title>SORTING</title>
   <para>
    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: 
+   to native sort for some target is driven by the two parameters:
    <link linkend="sortStrategy"><literal>sortStrategy</literal></link>
    and <link linkend="sortmap"><literal>sortmap_</literal><replaceable>field</replaceable></link>.
   </para>
@@ -346,7 +382,7 @@
    conversion. It doesn't throw a diagnostic.
   </para>
  </refsect1>
- 
+
  <refsect1>
   <title>TARGET PROFILE</title>
   <para>
@@ -371,7 +407,7 @@
     </para>
    </listitem>
    </varlistentry>
-   
+
    <varlistentry id="cclmap">
     <term>cclmap_<replaceable>field</replaceable></term><listitem>
     <para>
@@ -383,7 +419,7 @@
     </para>
    </listitem>
    </varlistentry>
-   
+
    <varlistentry>
     <term>cfAuth</term><listitem>
     <para>
@@ -431,7 +467,7 @@
      <literal>element_raw</literal> from the configuration.
      By default that is the element sets <literal>pz2</literal>
      and <literal>raw</literal>.
-     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.
     </para>
@@ -451,7 +487,7 @@
     </para>
    </listitem>
    </varlistentry>
-   
+
    <varlistentry>
     <term>piggyback</term><listitem>
     <para>
@@ -462,7 +498,7 @@
     </para>
    </listitem>
    </varlistentry>
-   
+
    <varlistentry>
     <term>queryEncoding</term><listitem>
     <para>
@@ -472,7 +508,7 @@
     </para>
    </listitem>
    </varlistentry>
-   
+
    <varlistentry>
     <term>recordEncoding</term><listitem>
     <para>
@@ -503,7 +539,7 @@
     </para>
    </listitem>
    </varlistentry>
-   
+
    <varlistentry id="sortStrategy">
     <term>sortStrategy</term><listitem>
     <para>
@@ -516,7 +552,7 @@
     </para>
    </listitem>
    </varlistentry>
-   
+
    <varlistentry>
     <term>sru</term><listitem>
     <para>
@@ -563,7 +599,7 @@
     <para>
      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, <literal>metadata</literal> with attribute 
+     a new field, <literal>metadata</literal> with attribute
      <literal>type="generated-url"</literal> 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
@@ -573,15 +609,9 @@
      metadata element <literal>title</literal> and converts one or more
      spaces to a plus character.
     </para>
-    <para>
-     If the <link linkend="zoom-torus-contentConnector">contentConnector</link>
-     setting also defined, the resulting value is
-     augmented with a session string as well as host name of the
-     content proxy server.
-    </para>
    </listitem>
    </varlistentry>
-   
+
    <varlistentry>
     <term>zurl</term><listitem>
     <para>
@@ -611,7 +641,7 @@
    is a comma rather than a question mark. What follows question mark are
    HTTP arguments (in this case SRU arguments).
   </para>
-  <variablelist>  
+  <variablelist>
    <varlistentry>
     <term>user</term>
     <listitem>
@@ -688,22 +718,26 @@
      </para>
     </listitem>
    </varlistentry>
-  </variablelist>  
+  </variablelist>
  </refsect1>
  <refsect1>
   <title>SCHEMA</title>
   <literallayout><xi:include
   xi:href="../xml/schema/filter_zoom.rnc"
-  xi:parse="text"  
+  xi:parse="text"
   xmlns:xi="http://www.w3.org/2001/XInclude" />
   </literallayout>
  </refsect1>
- 
+
  <refsect1>
   <title>EXAMPLES</title>
   <para>
-   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.
    <screen><![CDATA[
     <filter type="zoom">
       <torus
@@ -715,7 +749,7 @@
       <fieldmap cql="dc.creator" ccl="au"/>
       <fieldmap cql="dc.title" ccl="ti"/>
       <fieldmap cql="dc.subject" ccl="su"/>
-      
+
       <cclmap>
         <qual name="ocn">
           <attr type="u" value="12"/>
@@ -728,9 +762,38 @@
 ]]>
    </screen>
   </para>
-  
- </refsect1> 
- 
+
+  <para>
+   Here is another example with two locally defined targets: A
+   Solr target and a Z39.50 target.
+   <screen><![CDATA[
+      </filter>
+      <filter type="zoom">
+        <torus>
+          <records>
+            <record>
+              <udb>ocs-test</udb>
+              <cclmap_term>t=z</cclmap_term>
+              <cclmap_ti>u=title t=z</cclmap_ti>
+              <sru>solr</sru>
+              <zurl>ocs-test.indexdata.com/solr/select</zurl>
+            </record>
+            <record>
+              <udb>loc</udb>
+              <cclmap_term>t=l,r</cclmap_term>
+              <cclmap_ti>u=4 t=l,r</cclmap_ti>
+              <zurl>z3950.loc.gov:7090/voyager</zurl>
+            </record>
+          </records>
+        </torus>
+        <fieldmap cql="cql.serverChoice"/>
+        <fieldmap cql="dc.title" ccl="ti"/>
+      </filter>
+]]>
+   </screen>
+  </para>
+ </refsect1>
+
  <refsect1>
   <title>SEE ALSO</title>
   <para>
@@ -746,7 +809,7 @@
    </citerefentry>
   </para>
  </refsect1>
- 
+
  &copyright;
 </refentry>