From 838ff8b5a5d9fc8e482fef6c3d3d55130a3f452d Mon Sep 17 00:00:00 2001
From: Dan Scott <dscott@laurentian.ca>
Date: Thu, 8 Mar 2012 11:33:20 -0500
Subject: [PATCH] Remove Z39.50 server definitions from opensrf.xml.example

Point to the Release Notes for a description of how to map old entries
to the database tables. Maybe later someone enterprising will write up a
script that parses the XML and generates reasonable default entries in
the database tables.

Signed-off-by: Dan Scott <dscott@laurentian.ca>
Signed-off-by: Ben Shum <bshum@biblio.org>
---
 Open-ILS/examples/opensrf.xml.example | 88 ++---------------------------------
 docs/RELEASE_NOTES_2_2.txt            | 35 ++++++++++++++
 2 files changed, 40 insertions(+), 83 deletions(-)

diff --git a/Open-ILS/examples/opensrf.xml.example b/Open-ILS/examples/opensrf.xml.example
index eabd6fcd5a..325b4c2c70 100644
--- a/Open-ILS/examples/opensrf.xml.example
+++ b/Open-ILS/examples/opensrf.xml.example
@@ -195,89 +195,11 @@ vim:et:ts=4:sw=4:
             </allowed_services>
         </xml-rpc>
 
-
-        <z3950>
-            <default>biblios</default>
-            <services>
-                <biblios>
-                    <!-- biblios does not require username/password -->
-                    <name>‡biblios.net</name>
-                    <host>z3950.biblios.net</host>
-                    <port>210</port>
-                    <db>bibliographic</db>
-                    <!-- fetch the full record with no holdings. FI is the most common choice -->
-                    <record_format>FI</record_format> 
-
-                    <!-- Record transmission format from the server.  Supported -->
-                    <!-- formats include usmarc and xml (for marcxml).         -->
-                    <transmission_format>usmarc</transmission_format> 
-
-                    <attrs>
-                        <tcn><code>12</code><format>1</format></tcn>
-                        <isbn><code>7</code><format>6</format></isbn>
-                        <lccn><code>9</code><format>1</format></lccn>
-                        <author><code>1003</code><format>6</format></author>
-                        <title><code>4</code><format>6</format></title>
-                        <issn><code>8</code><format>1</format></issn>
-                        <publisher><code>1018</code><format>6</format></publisher>
-                        <pubdate><code>31</code><format>1</format></pubdate>
-                        <item_type><code>1001</code><format>1</format></item_type>
-                    </attrs>
-                </biblios>
-
-                <loc>
-                    <!-- LoC does not require username/password -->
-                    <name>loc</name>
-                    <host>z3950.loc.gov</host>
-                    <port>7090</port>
-                    <db>Voyager</db>
-                    <!-- fetch the full record with no holdings. FI is the most common choice -->
-                    <record_format>FI</record_format> 
-
-                    <!-- Record transmission format from the server.  Supported -->
-                    <!-- formats include usmarc and xml (for marcxml).         -->
-                    <transmission_format>usmarc</transmission_format> 
-
-                    <attrs>
-                        <tcn><code>12</code><format>1</format></tcn>
-                        <isbn><code>7</code><format>6</format></isbn>
-                        <lccn><code>9</code><format>1</format></lccn>
-                        <author><code>1003</code><format>6</format></author>
-                        <title><code>4</code><format>6</format></title>
-                        <issn><code>8</code><format>1</format></issn>
-                        <publisher><code>1018</code><format>6</format></publisher>
-                        <pubdate><code>31</code><format>1</format></pubdate>
-                        <item_type><code>1001</code><format>1</format></item_type>
-                    </attrs>
-                </loc>
-
-                <oclc>
-                    <!-- Z3950 settings for OCLC.  Note that OCLC requires username/password -->
-                    <host>zcat.oclc.org</host>
-                    <port>210</port>
-                    <db>OLUCWorldCat</db>
-                    <attrs>
-                        <!--
-                        These are directly from the Bib-1 Attribute Set
-                        http://www.loc.gov/z3950/agency/defns/bib1.html
-                        <code> is the "use attribute", <format> is the "structure attribute"
-                        This just puts some friendly names on the data.
-                        -->
-                        <tcn><code>12</code><format>1</format></tcn>
-                        <isbn><code>7</code><format>6</format></isbn>
-                        <lccn><code>9</code><format>1</format></lccn>
-                        <author><code>1003</code><format>6</format></author>
-                        <title><code>4</code><format>6</format></title>
-                        <issn><code>8</code><format>1</format></issn>
-                        <publisher><code>1018</code><format>6</format></publisher>
-                        <pubdate><code>31</code><format>1</format></pubdate>
-                        <item_type><code>1001</code><format>1</format></item_type>
-                    </attrs>
-                </oclc>
-
-            </services>
-        </z3950>
-
+        <!--
+        Once upon a time, Z39.50 servers were defined here. As of Evergreen 2.2,
+        they are now defined in the database. See the Release Notes for
+        instructions on mapping the old XML entries to database tables.
+        -->
 
         <added_content>
             <!-- load the OpenLibrary added content module -->
diff --git a/docs/RELEASE_NOTES_2_2.txt b/docs/RELEASE_NOTES_2_2.txt
index 3ad4ace29c..036eef9173 100644
--- a/docs/RELEASE_NOTES_2_2.txt
+++ b/docs/RELEASE_NOTES_2_2.txt
@@ -35,6 +35,41 @@ UPDATE biblio.record_entry
 ;
 ------------------------------------------------------------------------------
 
+Z39.50 server definitions
+~~~~~~~~~~~~~~~~~~~~~~~~~
+Z39.50 server target definitions have been removed from the sample
+`opensrf.xml.example` file. To migrate existing settings from your
+`opensrf.xml` configuration file to the database, peform the
+following steps:
+
+    1. First, set up your custom Z39.50 sources in the database. For
+      each entry in `z3950/services`, map the following XML paths to the
+      corresponding `config.z3950_source` table column as follows:
++
+      ** `z3950/services/<entry>` = name
+      ** `//<entry>/name` = label
+      ** `//<entry>/host` = host
+      ** `//<entry>/port` = port
+      ** `//<entry>/db` = db
+      ** `//<entry>/record_format` = record_format
+      ** `//<entry>/transmission_format` = transmission_format
++
+    2. Then, for each attribute defined in the `<attrs>` element for
+       a given service, map the following XML paths to the corresponding
+       `config.z3950_attr` table column as follows:
++
+      ** `z3950/services/<entry>` = source
+      ** `//<entry>/attrs/<attr>` = name
+      ** `//<entry>/attrs/<attr>/code` = code
+      ** `//<entry>/attrs/<attr>/format` = format
++
+    3. After adding the new Z39.50 sources and corresponding attributes,
+       you will need to log out of the staff client and log back into the
+       staff client to retrieve the new entry values. If a given Z39.50
+       server does not work for a given attribute, pay attention to the
+       `truncation` column for the attribute.
+
+
 New features
 ------------
 
-- 
2.11.0