[open-ils-commits] ***SPAM*** [GIT] Evergreen ILS branch master updated. d86f4706131fa8b6a313535b7d1939ad155f71f7

[Evergreen Git]

This is an automated email from the git hooks/post-receive script. It was
generated because a ref change was pushed to the repository containing
the project "Evergreen ILS".

The branch, master has been updated
       via  d86f4706131fa8b6a313535b7d1939ad155f71f7 (commit)
      from  76ef27b0147c51be8df1cb89661d1fb04a6a5c66 (commit)

Those revisions listed above that are new to this repository have
not appeared on any other notification email; so we list those
revisions in full, below.

- Log -----------------------------------------------------------------
commit d86f4706131fa8b6a313535b7d1939ad155f71f7
Author: Josh Stompro <github at stompro.org>
Date:   Tue Sep 9 15:13:47 2014 -0400

    Docs: update to 'Address Alerts' feature content
    
    Signed-off-by: Josh Stompro <github at stompro.org>
    Signed-off-by: Yamil Suarez <yamil at yamil.com>

diff --git a/docs/admin/lsa-address_alert.txt b/docs/admin/lsa-address_alert.txt
index beae8cf..c05ce5c 100644
--- a/docs/admin/lsa-address_alert.txt
+++ b/docs/admin/lsa-address_alert.txt
@@ -1,32 +1,138 @@
 Address Alert
 -------------
 
-indexterm:[address alert]
+indexterm:[address alerts]
 
 The Address Alert module gives administrators the ability to notify staff with a custom message when 
 addresses with certain patterns are entered in patron records. 
 
 This feature only serves to provide pertinent information to your library system's circulation staff during the registration process. An alert will not prevent the new patron account from being registered and the information will not be permanently associated with the patron account.
 
-To access the Address Alert module, select *Admin* -> *Local Administration* -> *Address Alert*.
+To access the Address Alert module, select *Admin* -> *Local Administration* -> *Address Alerts*.
 
 [NOTE]
 ==========
-You must have Local Administrator permissions to access the Address Alert module.
+You must have Local Administrator permissions or ADMIN_ADDRESS_ALERT permission to access the Address Alert module.
 ==========
 
 General Usage Examples
 ~~~~~~~~~~~~~~~~~~~~~~
 
-. Alert staff when an address for a large apartment is entered to prompt them to ask for unit number.
-. Alert staff when the address of a hotel or other temporary housing is entered.
-. Alert staff when an address for a different country is entered.
-. Alert staff when a specific city or zip code is entered if that city or zip code needs to be handled in a special way.  If you have a neighboring city that you don't have a reciprocal relationship with, you could notify staff that a fee card is required for this customer.
+- Alert staff when an address for a large apartment is entered to prompt them to ask for unit number.
+- Alert staff when the address of a hotel or other temporary housing is entered.
+- Alert staff when an address for a different country is entered.
+- Alert staff when a specific city or zip code is entered if that city or zip code needs to be handled in a special way.  If you have a neighboring city that you don't have a reciprocal relationship with, you could notify staff that a fee card is required for this customer.
 
 Access Control and Scoping
 ~~~~~~~~~~~~~~~~~~~~~~~~~~
 
-Each address alert is tied to an Org Unit and will only be matched against that Org Unit and its children.
+Each address alert is tied to an Org Unit and will only be matched against staff client instances of that Org Unit and its children.
 
-When viewing the address alerts you will only see the alerts associated with the specific org unit selected in the "Contex Org Unit" selection box.  You won't see alerts associated with parent org units, so the list of alerts isn't a list of all alerts that may effect your org unit, only of the ones that you can edit.
+When viewing the address alerts you will only see the alerts associated with the specific org unit selected in the *"Context Org Unit"* selection box.  You won't see alerts associated with parent org units, so the list of alerts isn't a list of all alerts that may effect your org unit, only of the ones that you can edit.
 
+The specific permission that controls access to configuring this feature is ADMIN_ADDRESS_ALERT.  Local Administrator level users will already have this permission.  It is possible for the Local Administrator to grant this permission to other staff.
+
+Adding a new Address Alert
+~~~~~~~~~~~~~~~~~~~~~~~~~~
+
+How to add an address to the alert list:
+
+. Log into the Evergreen Staff Client using a Local Administrator account or another account that has been granted the proper permission.
+. Click on Admin -> Local Administration -> Address Alerts.
+. Click "New Address Alert."
+. A form will open with the following fields to fill out:
++
+.New Address Alert Fields 
+|===
+|*Field*               |*Description*
+| Owner                |Which Org Unit owns this alert.  Set this to your system or branch.
+| Active               |Check-box that controls if the alert is active or not.  Inactive alerts are not processed.
+| Match All Fields     |Check-box that controls if all the fields need to match to trigger the alert(checked), or only at least one field needs to match(unchecked). 
+| Alert Message        |Message that will be displayed to staff when this alert is triggered.
+| Street (1)           |Street 1 field regular expression.
+| Street (2)           |Street 2 field regular expression.
+| City                 |City regular expression.
+| County               |County regular expression.
+| State                |State regular expression.
+| Country              |County regular expression.
+| Postal Code          |Postal Code regular expression.
+| Address Alert ID     |Displays the internal database id for alert after the alert has been saved.
+| Billing Address      |Check-box that specifies that the alert will only match a billing address if checked.
+| Mailing Address      |Check-box that specifies that the alert will only match a mailing address if checked. 
+|===
++
+. Click save once you have finished.
+
+Editing an Address Alert
+~~~~~~~~~~~~~~~~~~~~~~~~
+
+To make changes to an existing alert, double click on the alert in the list.  The editing form will appear, make your changes and click save or cancel when you are done.
+
+If you don't see your alerts, make sure the *"Context Org Unit"* selection box has the correct Org Unit selected.
+
+Deleting an Address Alert
+~~~~~~~~~~~~~~~~~~~~~~~~~
+
+To delete an alert or many alerts, click the selection check-box for all alerts you would like to delete.  Then click the "Delete Selected" button at the top of the screen.
+
+Staff View of Address Alerts
+~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+
+When an Address Alert is triggered by a matching address the staff will see the address block highlighted with a red dashed line, along with an *"Address Alert"* block which contains the alert message.
+
+Here is an example of what staff would see.
+
+image::media/lsa-address_alert_staff_view.png[Address Alert Staff View] 
+
+Regular Expressions / Wildcards
+~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+
+All of the patterns entered to match the various address fields are evaluated as case-insensitive regular expressions by default.
+
+[NOTE]
+==========
+Address Alerts use POSIX Regular Expressions included in the PostgreSQL database engine.  See the PostgreSQL documentation for full details. 
+==========
+
+If you want to do a case-sensitive match you need to prepend the pattern with "(?c)"
+
+The simplest regular expression that acts as a wildcard is ".*", that matches any type of character zero or more times.
+
+Examples
+~~~~~~~~
+
+.Apartment address
+Match an apartment address to prompt for unit number.
+
+. Choose *Owner* Org Unit.
+. Active = Checked
+. Match All Fields = Checked
+. Alert Message = "This is a large apartment building, Please ask customer for unit number."
+. Street (1) = "1212 Evergreen Lane.*"
+. City = "mytown"
+
+.All addresses on street
+Match all addresses on a certain street.  Matches ave and avenue because of ending wildcard.
+
+. Choose *Owner* Org Unit.
+. Active = Checked
+. Match All Fields = Checked
+. Alert Message = "This street is in a different county, please setup reciprocal card."
+. Street (1) = ".* Evergreen Ave.*"
+. City = "mytown"
+
+.Match list of cities
+Match several different cities with one alert.  Could be used if certain cities don't have reciprocal agreements.  Note the use of parentheses and the | character to separate the different options. 
+
+. Choose *Owner* Org Unit.
+. Active = Checked
+. Match All Fields = Checked
+. Alert Message = "Customer must purchase a Fee card."
+. City = "(Emeryville|San Jose|San Francisco)"
+
+Development
+~~~~~~~~~~~
+
+Links to resources with more information on how and why this feature was developed and where the various source files are located.
+
+- Launchpad ticket for the feature request and development of address alerts - https://bugs.launchpad.net/evergreen/+bug/898248  
diff --git a/docs/media/lsa-address_alert_staff_view.png b/docs/media/lsa-address_alert_staff_view.png
new file mode 100644
index 0000000..4e5e19e
Binary files /dev/null and b/docs/media/lsa-address_alert_staff_view.png differ

-----------------------------------------------------------------------

Summary of changes:
 docs/admin/lsa-address_alert.txt            |  124 +++++++++++++++++++++++++--
 docs/media/lsa-address_alert_staff_view.png |  Bin 0 -> 31335 bytes
 2 files changed, 115 insertions(+), 9 deletions(-)
 create mode 100644 docs/media/lsa-address_alert_staff_view.png


hooks/post-receive
-- 
Evergreen ILS