Update for 2.4 beta1 release notes
authorBen Shum <bshum@biblio.org>
Tue, 19 Mar 2013 16:32:13 +0000 (12:32 -0400)
committerMike Rylander <mrylander@gmail.com>
Wed, 3 Apr 2013 19:53:45 +0000 (15:53 -0400)
- Move more release notes into 2.4 notes.
- Move notify_csv.txt into TechRef directory.
- Include entry for Linkchecker in 2.4 notes.

Signed-off-by: Ben Shum <bshum@biblio.org>
Signed-off-by: Kathy Lussier <klussier@masslnc.org>
Signed-off-by: Mike Rylander <mrylander@gmail.com>
16 files changed:
docs/RELEASE_NOTES_NEXT/acq-interface-improvements.txt [deleted file]
docs/RELEASE_NOTES_NEXT/acq_default_copy_count.txt [deleted file]
docs/RELEASE_NOTES_NEXT/acq_lineitem_order_ident.txt [deleted file]
docs/RELEASE_NOTES_NEXT/acq_po_detail_view.txt [deleted file]
docs/RELEASE_NOTES_NEXT/marc-import-tag-stripping.txt [deleted file]
docs/RELEASE_NOTES_NEXT/marc21-feeds.txt [deleted file]
docs/RELEASE_NOTES_NEXT/notify_csv.txt [deleted file]
docs/RELEASE_NOTES_NEXT/search-deleted.txt [deleted file]
docs/RELEASE_NOTES_NEXT/search-record-date-filters.txt [deleted file]
docs/RELEASE_NOTES_NEXT/serial_control_embedded_alt_interfaces.txt [deleted file]
docs/RELEASE_NOTES_NEXT/serial_control_special_statuses.txt [deleted file]
docs/RELEASE_NOTES_NEXT/show_holds_on_bib.txt [deleted file]
docs/RELEASE_NOTES_NEXT/tpac_bookbag_callnumbers.txt [deleted file]
docs/RELEASE_NOTES_NEXT/z39_source_credentials.txt [deleted file]
docs/TechRef/notify_csv.txt [new file with mode: 0644]

index 8d72537..5a87848 100644 (file)
@@ -1,12 +1,12 @@
-Evergreen 2.4 Alpha1 Release Notes
+Evergreen 2.4 Beta1 Release Notes
 Upgrade notes
-Custom toolbar permissions
+Custom Toolbar Permissions
 With the addition of more granular permissions for configuring a custom
 toolbars, the ADMIN_TOOLBAR permission alone will not allow users to 
@@ -23,6 +23,75 @@ New features
+Acquisitions Inline Item Detail View
+Acquisitions selection lists and purchase order interfaces contain a new link
+beside each lineitem which, when clicked, creates an inline grid of copies
+linked to the lineitem.  The grid contains the same information that displays
+in the full copy edit grid (from clicking on the Copies(n) link).  However,
+the inline grid is read-only, so it displays much faster and does not require
+the user to change visual contexts.  
+Included along the top of the lineitem table is a new '✓ Expand' link which, 
+when clicked, expands or collapses the inline grid for all visible lineitems.
+Acquisitions Lineitem Order Identifiers
+Staff now have the ability to specify the identifier value to use for
+lineitems when communicating order information to vendors.  This is 
+particularly important when a lineitem has, for example, multiple ISBNs.
+Determining which ISBN is to act as the "order identifier" allows staff
+to provide the most accurate order information to vendors.  
+Supported identifier types include ISBN, ISSN, and UPC.  Order identifier 
+values are relayed to vendors via EDI and print PO.
+Upgrade Notes
+Two new permissions are added for this feature:
+  ** Allows staff to apply order identifiers to lineitems
+  ** Implies that new identifiers shall be added to linked bib records, 
+     when a linkage exists.
+Acquisitions Purchase Order and other Interface Improvements
+Feature Summary
+The following features, which primarily affect the user interface layer,
+improve Acquisitions work flows.
+  * Avoid double-activation of POs
+  * Disable invoice and cancel options for pending POs
+  * Disable zero-copy checkbox for activated POs
+  * Disable new charges for activated POs
+  * Replace "Shelving Location" with Copy Location
+  * Rearranging "actions" drop-down
+    ** More consitency in actions applying to selected lineitems specifically
+    ** Things moved from the per-lineitem dropdown to the main one when
+       sensible.
+    ** Add to PO dialog added
+    ** You can no longer add lineitems to a PO if they're already on one.
+    ** Actions in dropdown now enabled/disabled differently depending on
+       the interface where it appears (PO vs Selection List vs Acq Search etc.)
+  * Batch update for line items
+     ** Apply updates to all copies of all selected line items at once
+     ** Relies on a middle layer method that streams back information that
+        would suit a more asynchronous display in the future (rather than
+        simply reloading the page upon success, which it does now)
+     ** For failure cases, specific information about which line item cannot
+        be updated, and why, is available to the client, although taking
+        best advantage of this information for user-friendly display is left
+        to the future.
 Acquisitions MARC Upload Form Persistence
 Adds a two-layer persistence mechanism for the acquisitions MARC file upload
@@ -31,6 +100,15 @@ for the interface.  Additionally, for each field where no org unit setting
 value is configured, the last-used value will be persisted locally and re-
 used with subsequent loads of the interface.
+Default Number of Acquisistions Copies to Order
+Acquisitions providers have a new "Default # Copies" field.  When the value
+is set, this number of copies will be automatically added to each lineitem
+added to a purchase order for the provider.  This takes place during PO
+creation from a selection list or existing bib record and when a lineitem is 
+added to an existing purchase order.  If a lineitem already has copies 
+attached, no default copies are added.
@@ -55,6 +133,14 @@ primary field content and the attribution statement. To support CSS
 customizations, HTML elements for the graphic fields have the class attribute
 value `graphic880`.
+MARC21 Feeds from OpenSearch
+In addition to the already supported formats, you can now get raw MARC21 from
+OpenSearch feeds, à la:
+    http://<host>/opac/extras/opensearch/1.1/-/marc21?searchTerms=piano
 Search Changes
 A number of changes have been made to search to allow more control and improve
@@ -81,6 +167,43 @@ production environment changes will likely require re-indexing, however.
 The upgrade script could be pre-tweaked to install desired configuration before
 it builds and/or re-builds many of the indexes.
+Searching for deleted records
+Evergreen now supports searching for deleted records via the '#deleted'
+QP modifier.
+In order to support this, sites must enable the
+'ingest.metarecord_mapping.preserve_on_delete' internal flag.  It is off by
+default since the ability to search for deleted records requires keeping
+metarecord mappings around when bibs are deleted, which may not be desirable
+for the typical site.
+Two new QP filters: create_date and edit_date
+These filter on the fields of the same name in biblio.record_entry.
+  * create_date(,2013-02-01)  =>  records created before 2013-02-01
+  * create_date(2013-02-01)   =>  records created since 2013-02-01
+  * create_date(2013-02-01,2013-02-28)  =>  records created in Feb 2013
+  * create_date(yesterday)    =>  records since created yesterday
+Show local call number in TPAC My Lists display
+If an opac-visible call number exists that is owned by an org unit
+relevant to the patron, show the most relevant call number label
+and owning branch name in the My Lists display for each record in
+the list.  Call number is displayed in both saved and temporary lists.
+A call number is considered relevant if its owner is one of:
+physical location library
+preferred library (plib, home, etc.)
+search library
+If no relevant call number is found, no call number is diplayed.
 TPAC Google Books preview
 Setting `ctx.google_books_preview` to `1` in the TPAC `config.tt2`
@@ -116,6 +239,33 @@ UI Changes
+MARC Import Tag Stripping
+Administrators can configure MARC tags which are removed from MARC records 
+imported via Z39.50 and the Vandelay MARC Import/Export UI (ACQ and non-ACQ).  
+Tags are organized into groups.  Groups can be marked as optional or required.
+For each tag, every instance of the tag (including all subfields) are removed 
+from the record.
+MARC fields which are contained within required ('always_apply') tag groups
+are always removed from inbound records.  No action is needed.  Tag groups 
+which are optional will appear in MARC import interfaces (see below) allowing 
+staff to select which groups of tags to strip from incoming records at import 
+Interfaces Affected
+ * Admin UI
+  ** Admin => Server Administration => MARC Import Remove Fields
+ * Z39.50 Import
+  ** Cataloging => Import Record from Z39.50
+  ** Optional groups appear with the other import options
+ * Vandelay
+  ** Cataloging => MARC Import/ExportVandelay
+  ** Acquisistions => Load Order Records
+  ** Optional groups appear with the other import options
 Vandelay Default Match Set
 A new org unit setting to specify a default Record Match Set when 
@@ -154,6 +304,13 @@ TPac the hold patron name is now shown next to the entered barcode. In the event
 that the barcode is not found a notice is displayed and the submit button is
 disabled until a valid barcode is entered or the staff member is switched to.
+Show Holds On Bib Menu Option
+Add direct "Show holds on bibs" menu option from item checkin, item status, 
+and patron hold interfaces. This gives staff a quicker way of viewing who 
+else has holds on an item instead of having to click an option to view the 
+bib record, then clicking into the menus to view holds.
@@ -182,6 +339,78 @@ flexibililty than they have today over holds policy.
 For more information, see the included tech spec documents.
+Generic CVS Notification Generator/Receiver
+New Action/Trigger template and sample event definitions for creating a CSV
+export file for various patron actions, primarily for the purpose of creating
+patron notices via external notification mechanisms.
+The reference implementation for this development is the TalkingTech iTiva
+product, which consumes CSV files for generating phone/text notifications and
+produces CSV results files for informing the ILS of notification statuses.  
+The template and send/receive scripts, however, should be generic enough to 
+create CSV for any type of 3rd-party notification product.
+For more information, see the included tech spec documents.
+Storing Z39.50 Server Credentials
+In the Z39.50 configuration interface, staff now have the option to apply
+z39.50 login credentials to each Z39.50 server at different levels of the 
+org unit hierarchy (similar to org unit settings).  When credentials are set 
+for a Z39 server, searches against the z39 server will used the stored 
+credentials, unless other credentials are provided by the caller, in which 
+case the caller credentials are used.
+For security purposes, passwords may not be retrieved or reported on by staff.  
+Staff can only apply new values for credentials or clear existing ones.
+URL Verification
+In order to support verification of URLs, Evergreen now has several new
+capabilities, and extensions to some existing features.
+A wizard-style interface that walks a staff member through the process of collecting records and URLs to verify, verifying and reviewing the URLs.
+URL validation sessions are built as a whole to support immediate and
+future review of any URLs.  Each session carries a name, an owner, a set
+of record search criteria, a set of tag and subfield combinations describing
+the location of URLs to validate, a record container for tracking individual
+records to verify, and a set of state and data tables for managing the
+processing of individual URLs.
+A set of middle-layer methods provide the business logic required to collect
+records, extract, parse and test the validity of the URLs.
+For more information, see the included tech spec documents.
+Serial Control: Embed Alternate Interfaces
+As another step toward a unified interface, the serial control subscription
+editor now consists of an embedded version of the alternate control. This
+reduces duplication of both code and documentation, and smoothes the eventual
+transition to a single interface.
+In order to not lose any essential features, the following additions were made
+to the new combination editor:
+* note editors on subscriptions and distributions
+* labeled dropdown for distribution summary options ("Add to record entry", "Use record entry only", etc.)
+* legacy record entry linkage setup (Allows one to tie a distribution's information to a particular serial record entry (i.e. a MFHD record))
+Serial Control: Set Special Statuses
+The Serial Control interface prevents direct editing of serial item statuses
+for data integrity reasons. As an alternative to direct control, the interface
+now offers new menu options for setting items to 'claimed', 'not held', and
+'not published'. Note that these statuses are still currently useful for
+reporting and display purposes only.
 Staff Client
@@ -199,6 +428,7 @@ about:memory::
     Get detailed information about the memory usage of the staff
@@ -226,4 +456,3 @@ database schema):
    call numbers, copies, users, and transactions.
 * `--load-concerto-sample`: Loads a subset of sample data that includes just
   100 bibliographic records, and associated call numbers and copies.
diff --git a/docs/RELEASE_NOTES_NEXT/acq-interface-improvements.txt b/docs/RELEASE_NOTES_NEXT/acq-interface-improvements.txt
deleted file mode 100644 (file)
index 303941c..0000000
+++ /dev/null
@@ -1,33 +0,0 @@
-Acquisitions Purchase Order and other Interface Improvements
-Feature Summary
-The following features, which primarily affect the user interface layer,
-improve Acquisitions work flows.
-  * Avoid double-activation of POs
-  * Disable invoice and cancel options for pending POs
-  * Disable zero-copy checkbox for activated POs
-  * Disable new charges for activated POs
-  * Replace "Shelving Location" with Copy Location
-  * Rearranging "actions" drop-down
-    ** More consitency in actions applying to selected lineitems specifically
-    ** Things moved from the per-lineitem dropdown to the main one when
-       sensible.
-    ** Add to PO dialog added
-    ** You can no longer add lineitems to a PO if they're already on one.
-    ** Actions in dropdown now enabled/disabled differently depending on
-       the interface where it appears (PO vs Selection List vs Acq Search etc.)
-  * Batch update for line items
-     ** Apply updates to all copies of all selected line items at once
-     ** Relies on a middle layer method that streams back information that
-        would suit a more asynchronous display in the future (rather than
-        simply reloading the page upon success, which it does now)
-     ** For failure cases, specific information about which line item cannot
-        be updated, and why, is available to the client, although taking
-        best advantage of this information for user-friendly display is left
-        to the future.
diff --git a/docs/RELEASE_NOTES_NEXT/acq_default_copy_count.txt b/docs/RELEASE_NOTES_NEXT/acq_default_copy_count.txt
deleted file mode 100644 (file)
index 4ff5cc4..0000000
+++ /dev/null
@@ -1,8 +0,0 @@
-New Feature: Default Number of Acquisistions Copies to Order
-Acquisitions providers have a new "Default # Copies" field.  When the value
-is set, this number of copies will be automatically added to each lineitem
-added to a purchase order for the provider.  This takes place during PO
-creation from a selection list or existing bib record and when a lineitem is 
-added to an existing purchase order.  If a lineitem already has copies 
-attached, no default copies are added.
diff --git a/docs/RELEASE_NOTES_NEXT/acq_lineitem_order_ident.txt b/docs/RELEASE_NOTES_NEXT/acq_lineitem_order_ident.txt
deleted file mode 100644 (file)
index 9315a3b..0000000
+++ /dev/null
@@ -1,22 +0,0 @@
-Acquisitions Lineitem Order Identifiers
-Staff now have the ability to specify the identifier value to use for
-lineitems when communicating order information to vendors.  This is 
-particularly important when a lineitem has, for example, multiple ISBNs.
-Determining which ISBN is to act as the "order identifier" allows staff
-to provide the most accurate order information to vendors.  
-Supported identifier types include ISBN, ISSN, and UPC.  Order identifier 
-values are relayed to vendors via EDI and print PO.
-Upgrade Notes
-Two new permissions are added for this feature:
-  ** Allows staff to apply order identifiers to lineitems
-  ** Implies that new identifiers shall be added to linked bib records, 
-     when a linkage exists.
diff --git a/docs/RELEASE_NOTES_NEXT/acq_po_detail_view.txt b/docs/RELEASE_NOTES_NEXT/acq_po_detail_view.txt
deleted file mode 100644 (file)
index 0016794..0000000
+++ /dev/null
@@ -1,12 +0,0 @@
-Acquisitions Inline Item Detail View
-Acquisitions selection lists and purchase order interfaces contain a new link
-beside each lineitem which, when clicked, creates an inline grid of copies
-linked to the lineitem.  The grid contains the same information that displays
-in the full copy edit grid (from clicking on the Copies(n) link).  However,
-the inline grid is read-only, so it displays much faster and does not require
-the user to change visual contexts.  
-Included along the top of the lineitem table is a new '✓ Expand' link which, 
-when clicked, expands or collapses the inline grid for all visible lineitems.
diff --git a/docs/RELEASE_NOTES_NEXT/marc-import-tag-stripping.txt b/docs/RELEASE_NOTES_NEXT/marc-import-tag-stripping.txt
deleted file mode 100644 (file)
index 7470dc0..0000000
+++ /dev/null
@@ -1,28 +0,0 @@
-MARC Import Tag Stripping
-Administrators can configure MARC tags which are removed from MARC records 
-imported via Z39.50 and the Vandelay MARC Import/Export UI (ACQ and non-ACQ).  
-Tags are organized into groups.  Groups can be marked as optional or required.
-For each tag, every instance of the tag (including all subfields) are removed 
-from the record.
-MARC fields which are contained within required ('always_apply') tag groups
-are always removed from inbound records.  No action is needed.  Tag groups 
-which are optional will appear in MARC import interfaces (see below) allowing 
-staff to select which groups of tags to strip from incoming records at import 
-Interfaces Affected
- * Admin UI
-  ** Admin => Server Administration => MARC Import Remove Fields
- * Z39.50 Import
-  ** Cataloging => Import Record from Z39.50
-  ** Optional groups appear with the other import options
- * Vandelay
-  ** Cataloging => MARC Import/ExportVandelay
-  ** Acquisistions => Load Order Records
-  ** Optional groups appear with the other import options
diff --git a/docs/RELEASE_NOTES_NEXT/marc21-feeds.txt b/docs/RELEASE_NOTES_NEXT/marc21-feeds.txt
deleted file mode 100644 (file)
index 0b861a9..0000000
+++ /dev/null
@@ -1,8 +0,0 @@
-MARC21 Feeds from OpenSearch
-In addition to the already supported formats, you can now get raw MARC21 from
-OpenSearch feeds, à la:
-    http://<host>/opac/extras/opensearch/1.1/-/marc21?searchTerms=piano
diff --git a/docs/RELEASE_NOTES_NEXT/notify_csv.txt b/docs/RELEASE_NOTES_NEXT/notify_csv.txt
deleted file mode 100644 (file)
index 0529726..0000000
+++ /dev/null
@@ -1,78 +0,0 @@
-New Feature: Generic CVS Notification Generator/Receiver
-New Action/Trigger template and sample event definitions for creating a CSV
-export file for various patron actions, primarily for the purpose of creating
-patron notices via external notification mechanisms.
-The reference implementation for this development is the TalkingTech iTiva
-product, which consumes CSV files for generating phone/text notifications and
-produces CSV results files for informing the ILS of notification statuses.  
-The template and send/receive scripts, however, should be generic enough to 
-create CSV for any type of 3rd-party notification product.
-Action/Trigger Event Definition Configuration
-  * Supported hook core types include *circ*, *ahr*, *ausp*, and *au*
-  * Reactor is *ProcessTemplate*
-Event Environment Requirements
-  * Patron object with card
-  * copy object
-    ** circ.target_copy
-    ** hold.current_copy
-  * Org unit
-    ** circ.circ_lib
-    ** ahr.pickup_lib
-    ** ausp.org_unit
-    ** patron.home_ou
-Not all fields are relevent to all notice types.
-Required Event Parameters
-  * notify_media (e.g. phone)
-  * notify_type  (e.g. overdue)
-  * notify_level (e.g. "1" -- first overdue)
-The set of options for each event parameter is dependent on the 3rd-party
-processing the CSV file.  
-iTiva Event Parameter Options
-  * notify_media
-    ** V (voice)
-    ** T (text)
-  * notify_level
-    ** 1 (1st notice)
-    ** 2 (2nd notice)
-    ** 3 (3rd notice)
-  * notify_type 
-    ** FINES 
-    ** OVERDUE 
-    ** RECALL 
-    ** RESERVE 
-    ** SUSPEND
-Push/Fetch Scripts
-  * action_trigger_aggregator.pl collects event output from requested event 
-    definitions and stitches them together into a single file, which is sent 
-    via (s)FTP to the 3rd party.
-  * Why don't we use the SendFile reactor directly?
-    ** The final file is meant to be a collection of event-def outputs, not
-       the output from a single event def
-    ** The final file may be too large to reasonably store directly in a 
-       single action/trigger event_output row.
-  * csv_notify_fetcher.pl retrieves responses from the 3rd party and applies
-    the statuses to the async_output of each notified event.
diff --git a/docs/RELEASE_NOTES_NEXT/search-deleted.txt b/docs/RELEASE_NOTES_NEXT/search-deleted.txt
deleted file mode 100644 (file)
index 5e1d8a0..0000000
+++ /dev/null
@@ -1,11 +0,0 @@
-Searching for deleted records
-Evergreen now supports searching for deleted records via the '#deleted'
-QP modifier.
-In order to support this, sites must enable the
-'ingest.metarecord_mapping.preserve_on_delete' internal flag.  It is off by
-default since the ability to search for deleted records requires keeping
-metarecord mappings around when bibs are deleted, which may not be desirable
-for the typical site.
diff --git a/docs/RELEASE_NOTES_NEXT/search-record-date-filters.txt b/docs/RELEASE_NOTES_NEXT/search-record-date-filters.txt
deleted file mode 100644 (file)
index 84dea19..0000000
+++ /dev/null
@@ -1,11 +0,0 @@
-Two new QP filters: create_date and edit_date
-These filter on the fields of the same name in biblio.record_entry.
-  * create_date(,2013-02-01)  =>  records created before 2013-02-01
-  * create_date(2013-02-01)   =>  records created since 2013-02-01
-  * create_date(2013-02-01,2013-02-28)  =>  records created in Feb 2013
-  * create_date(yesterday)    =>  records since created yesterday
diff --git a/docs/RELEASE_NOTES_NEXT/serial_control_embedded_alt_interfaces.txt b/docs/RELEASE_NOTES_NEXT/serial_control_embedded_alt_interfaces.txt
deleted file mode 100644 (file)
index f0986fe..0000000
+++ /dev/null
@@ -1,13 +0,0 @@
-Serial Control: Embed Alternate Interfaces
-As another step toward a unified interface, the serial control subscription
-editor now consists of an embedded version of the alternate control. This
-reduces duplication of both code and documentation, and smoothes the eventual
-transition to a single interface.
-In order to not lose any essential features, the following additions were made
-to the new combination editor:
-* note editors on subscriptions and distributions
-* labeled dropdown for distribution summary options ("Add to record entry", "Use record entry only", etc.)
-* legacy record entry linkage setup (Allows one to tie a distribution's information to a particular serial record entry (i.e. a MFHD record))
diff --git a/docs/RELEASE_NOTES_NEXT/serial_control_special_statuses.txt b/docs/RELEASE_NOTES_NEXT/serial_control_special_statuses.txt
deleted file mode 100644 (file)
index 5b4e3c3..0000000
+++ /dev/null
@@ -1,7 +0,0 @@
-Serial Control: Set Special Statuses
-The Serial Control interface prevents direct editing of serial item statuses
-for data integrity reasons. As an alternative to direct control, the interface
-now offers new menu options for setting items to 'claimed', 'not held', and
-'not published'. Note that these statuses are still currently useful for
-reporting and display purposes only.
diff --git a/docs/RELEASE_NOTES_NEXT/show_holds_on_bib.txt b/docs/RELEASE_NOTES_NEXT/show_holds_on_bib.txt
deleted file mode 100644 (file)
index 27b69bd..0000000
+++ /dev/null
@@ -1,7 +0,0 @@
-Show Holds On Bib Menu Option
-Add direct "Show holds on bibs" menu option from item checkin, item status, 
-and patron hold interfaces. This gives staff a quicker way of viewing who 
-else has holds on an item instead of having to click an option to view the 
-bib record, then clicking into the menus to view holds.
diff --git a/docs/RELEASE_NOTES_NEXT/tpac_bookbag_callnumbers.txt b/docs/RELEASE_NOTES_NEXT/tpac_bookbag_callnumbers.txt
deleted file mode 100644 (file)
index a6a53c5..0000000
+++ /dev/null
@@ -1,15 +0,0 @@
-New Feature: Show local call number in TPAC My Lists display
-If an opac-visible call number exists that is owned by an org unit
-relevant to the patron, show the most relevant call number label
-and owning branch name in the My Lists display for each record in
-the list.  Call number is displayed in both saved and temporary lists.
-A call number is considered relevant if its owner is one of:
-physical location library
-preferred library (plib, home, etc.)
-search library
-If no relevant call number is found, no call number is diplayed.
diff --git a/docs/RELEASE_NOTES_NEXT/z39_source_credentials.txt b/docs/RELEASE_NOTES_NEXT/z39_source_credentials.txt
deleted file mode 100644 (file)
index eb74bcc..0000000
+++ /dev/null
@@ -1,13 +0,0 @@
-Storing Z39.50 Server Credentials
-In the Z39.50 configuration interface, staff now have the option to apply
-z39.50 login credentials to each Z39.50 server at different levels of the 
-org unit hierarchy (similar to org unit settings).  When credentials are set 
-for a Z39 server, searches against the z39 server will used the stored 
-credentials, unless other credentials are provided by the caller, in which 
-case the caller credentials are used.
-For security purposes, passwords may not be retrieved or reported on by staff.  
-Staff can only apply new values for credentials or clear existing ones.
diff --git a/docs/TechRef/notify_csv.txt b/docs/TechRef/notify_csv.txt
new file mode 100644 (file)
index 0000000..0529726
--- /dev/null
@@ -0,0 +1,78 @@
+New Feature: Generic CVS Notification Generator/Receiver
+New Action/Trigger template and sample event definitions for creating a CSV
+export file for various patron actions, primarily for the purpose of creating
+patron notices via external notification mechanisms.
+The reference implementation for this development is the TalkingTech iTiva
+product, which consumes CSV files for generating phone/text notifications and
+produces CSV results files for informing the ILS of notification statuses.  
+The template and send/receive scripts, however, should be generic enough to 
+create CSV for any type of 3rd-party notification product.
+Action/Trigger Event Definition Configuration
+  * Supported hook core types include *circ*, *ahr*, *ausp*, and *au*
+  * Reactor is *ProcessTemplate*
+Event Environment Requirements
+  * Patron object with card
+  * copy object
+    ** circ.target_copy
+    ** hold.current_copy
+  * Org unit
+    ** circ.circ_lib
+    ** ahr.pickup_lib
+    ** ausp.org_unit
+    ** patron.home_ou
+Not all fields are relevent to all notice types.
+Required Event Parameters
+  * notify_media (e.g. phone)
+  * notify_type  (e.g. overdue)
+  * notify_level (e.g. "1" -- first overdue)
+The set of options for each event parameter is dependent on the 3rd-party
+processing the CSV file.  
+iTiva Event Parameter Options
+  * notify_media
+    ** V (voice)
+    ** T (text)
+  * notify_level
+    ** 1 (1st notice)
+    ** 2 (2nd notice)
+    ** 3 (3rd notice)
+  * notify_type 
+    ** FINES 
+    ** OVERDUE 
+    ** RECALL 
+    ** RESERVE 
+    ** SUSPEND
+Push/Fetch Scripts
+  * action_trigger_aggregator.pl collects event output from requested event 
+    definitions and stitches them together into a single file, which is sent 
+    via (s)FTP to the 3rd party.
+  * Why don't we use the SendFile reactor directly?
+    ** The final file is meant to be a collection of event-def outputs, not
+       the output from a single event def
+    ** The final file may be too large to reasonably store directly in a 
+       single action/trigger event_output row.
+  * csv_notify_fetcher.pl retrieves responses from the 3rd party and applies
+    the statuses to the async_output of each notified event.