-Release Notes for the Phonelist.pm Module
-=========================================
+Phonelist.pm Module
+===================
PhoneList.pm is a mod_perl module for Apache that works with Evergreen
to generate callings lists for patron holds. It outputs a csv file
The above example would sign in as user circuser with password of
``password'' and get a list of patrons with holds to call who do not
have email notification turned on. It would run at whatever branch is
-normally associated with circuser, which would likely be MVC or
-central site. (Note: There is no actual circuser account, it is used
-here for illustration purposes only.)
+normally associated with circuser.
`https://your.evergreen-server.tld/phonelist?skipemail`
The above logs in as ``user'' with ``password'' and runs overdues for location ID 2.
-The following sections provide more information on getting what you want in your output.
-
-Adding Parameters
------------------
-
-If you are not familiar with HTTP/URL query strings, the format is
-quite simple.
-
-You add parameters to the end of the URL, the first parameter is
-separated from the URL page with a question mark (``?'') character. If
-the parameter is to be given an extra value, then that value follows
-the parameter name after an equals sign (``=''). Subsequent parameters
-are separated from the previous parameter by an ampersand (``&'').
-
-Here is an example with 1 parameter that has no value:
-
-`https://your.evergreen-server.tld/phonelist?skipemail`
-
-An example of 1 argument with a value:
-
-`https://your.evergreen-server.tld/phonelist?overdue=21`
-
-An example of 2 arguments, 1 with a value and 1 without:
-
-`https://your.evergreen-server.tld/phonelist?overdue=21&skipemail`
-
-Any misspelled or parameters not listed in the table above will be
-ignored by the program.
-
-Output
-------
-
-On a successful run, the program will return a CSV file named
-phone.csv. Depending on your browser or settings you will alternately
-be prompted to open or save the file. Your browser may also
-automatically save the file in your Downloads or other designated
-folder. You should be able to open this CSV file in Excel, LibreOffice
-Base, any other spread sheet program, or a text editor.
-
-If you have made a mistake and have mistyped your user name or
-password, or if you supply a ws_ou parameter with an ID where your
-user name does not have permission to look up holds or overdue
-information, then you will get an error returned in your browser.
-
-Should your browser appear to do absolutely nothing at all. This is
-normal. When there is no information for you to download, the server
-will return a 200 NO CONTENT message to your browser. Most browsers
-respond to this message by doing nothing at all. It is possible for
-there to be no information for you to retrieve if you added the
-`skipemail` option and all of your notices for that day were sent via
-email, or if you ran this in the morning and then again in the
-afternoon and there was no new information to gather.
-
-The program does indicate that it has already looked at a particular
-hold or overdue and will skip it on later runs. This prevents
-duplicates to the same patron in the same run. It will, however,
-create a ``duplicate'' for the same patron if a different copy is put
-on hold for that patron in between two runs.
-
-The specific content of the CSV file will vary if you are looking at
-holds or overdues. The specific contents are described in the
-appropriate sections below.
-
-Holds
------
-
-The `phonelist` program will return a list of patrons with copies on
-hold by default, so long as you do not use the `overdue`
-parameter. You may optionally get a number of items that patron
-currently has on hold by adding the `addcount` parameter.
-
-As always, you can add the skipemail parameter to skip patrons with
-email notifications of their overdues, [#0.5.Skipping patrons with
-email notification of holds|outline as described below].
-
-.Columns in the holds CSV file:
-|=====================================
-| Name | Patron's name first and last.
-| Phone | Patron's phone number.
-| Barcode | Patron's barcode.
-| Count | Number of copies on hold, if `addcount` parameter is used, otherwise this column is not present in the file.
-|=====================================
-
-Overdues
---------
-
-If you add the `overdue` parameter, you can get a list of patrons with
-overdue copies instead of a list of patrons with copies on the hold
-shelf. By default, this will give you a list of patrons with copies
-that are 14 days overdue. If you'd like to specify a different number
-of days you can add the number after the parameter with an equals
-sign:
-
-`https://your.evergreen-server.tld/phonelist?overdue=21&ws_ou=2`
-
-The above will retrieve a list of patrons who have items that are 21
-days overdue at the location with ID of 2.
-
-The number of days is an exact lookup. This means that the program
-will look only at patrons who have items exactly 14 days or exactly
-the number of days specified overdue. It does not pull up any that are
-less than or greater than the number of days specified.
-
-As always, you can add the skipemail parameter to skip patrons with
-email notifications of their overdues, [#0.5.Skipping patrons with
-email notification of holds|outline as described below].
-
-.Columns in the overdues CSV file:
-|=================================
-| Name | Patron's name first and last.
-| Phone | Patron's phone number.
-| Barcode | Patron's barcode.
-| Titles | A colon-separated list of titles that the patron has overdue.
-|=================================
-
-Skipping patrons with email notification of holds
--------------------------------------------------
-
-Skipping patrons who have email notification for their holds or
-overdues is very simple. You just need to add the `skipemail`
-parameter on the URL query string. Doing so will produce the list
-without the patrons who have email notification for overdues, or for
-all of their holds. Please note that if a patron has multiple holds
-available, and even one of these holds requests a phone-only
-notification, then that patron will still show on the list. For this
-option to exclude a patron from the holds list, the patron must
-request email notification on all of their current holds. In practice,
-we find that this is usually the case.
-
-Using the ws_ou parameter
--------------------------
-
-Generally, you will not need to use the ws_ou parameter when using the
-phonelist program. The phonelist will look up the branch where your
-login account works and use that location when generating the list.
-However, if you are part of a multi-branch systems in a consortium,
-then the ws_ou parameter will be of interest to you. You can use it
-to specify which branch, or the whole system, you wish to search when
-running the program.
-
-Automating the download
------------------------
-
-If you'd like to automate the download of these files, you should be
-able to do so using any HTTP programming toolkit. Your client must
-accept cookies and follow any redirects in order to function.
Floating Groups
===============
-Thomas Berezansky <tsbere@mvlc.org>
-:Date: 2012-04-22
-Before floating groups copies could float or not. If they floated then they floated everywhere, with no restrictions.
+In previous versions of Evergreen, floating group copies could float or not. If they floated, then they floated everywhere with no restrictions.
-After floating groups where a copy will float is defined by what group it has been assigned to.
+This enhancment provides an interface to define where a copy will float by assigning it to a floating group.
-== Floating Groups
-
-Each floating group comes with a name and a manual flag, plus zero or more group members. The name is used solely for selection and display purposes.
-
-The manual flag dictates whether or not the "Manual Floating Active" checkin modifier needs to be active for a copy to float. This allows for greater control over when items float. It also prevents automated checkins via SIP2 from triggering floats.
-
-== Floating Group Members
-
-Each member of a floating group references an org unit and has a stop depth, an optional max depth, and an exclude flag.
-
-=== Org Unit
-
-The org unit and all descendants are included, unless max depth is set, in which case the tree is cut off at the max depth.
-
-=== Stop Depth
-
-The stop depth is the highest point from the current copy circ library to the checkin library for the item that will be traversed. If the item has to go higher than the stop depth on the tree the member rule in question is ignored.
-
-=== Max Depth
-
-As mentioned with the org unit, the max depth is the furthest down on the tree from the org unit that gets included. This is based on the entire tree, not just off of the org unit. So in the default tree a max depth of 1 will stop at the system level no matter if org unit is set to CONS or SYS1.
-
-=== Exclude
-
-Exclude, if set, causes floating to not happen for the member. Excludes always take priority, so you can remove an org unit from floating without having to worry about other rules overriding it.
-
-== Examples
-
-=== Float Everywhere
-
-This is a default floating rule to emulate the previous floating behavior for new installs and upgrades.
-
-One member:
-
-* Org Unit: CONS
-* Stop Depth: 0
-* Max Depth: Unset
-* Exclude: Off
-
-=== Float Within System
-
-This would permit a copy to float anywhere within a system, but would return to the system if it was returned elsewhere.
-
-One member:
-
-* Org Unit: CONS
-* Stop Depth: 1
-* Max Depth: Unset
-* Exclude: Off
-
-=== Float To All Branches
-
-This would permit a copy to float to any branch, but not to sublibraries or bookmobiles.
-
-One member:
-
-* Org Unit: CONS
-* Stop Depth: 0
-* Max Depth: 2
-* Exclude: Off
-
-=== Float To All Branches Within System
-
-This would permit a copy to float to any branch in a system, but not to sublibraries or bookmobiles, and returning to the system if returned elsewhere.
-
-One member:
-
-* Org Unit: CONS
-* Stop Depth: 1
-* Max Depth: 2
-* Exclude: Off
-
-=== Float Between BR1 and BR3
-
-This would permit a copy to float between BR1 and BR3 specifically, excluding sublibraries and bookmobiles.
-
-It would consist of two members, identical other than the org unit:
-
-* Org Unit: BR1 / BR3
-* Stop Depth: 0
-* Max Depth: 2
-* Exclude: Off
-
-=== Float Everywhere Except BM1
-
-This would allow an item to float anywhere except for BM1. It accomplishes this with two members.
-
-The first includes all org units, just like Float Everywhere:
-
-* Org Unit: CONS
-* Stop Depth: 0
-* Max Depth: Unset
-* Exclude: Off
-
-The second excludes BM1:
-
-* Org Unit: BM1
-* Stop Depth: 0
-* Max Depth: Unset
-* Exclude: On
-
-That works because excludes are applied first.
-
-=== Float into, but not out of, BR2
-
-This would allow an item to float into BR2, but once there it would never leave. Why you would want to allow items to float to but not from a single library I dunno, but here it is. This takes advantage of the fact that the rules say where we can float *to*, but outside of stop depth don't care where we are floating *from*.
-
-One member:
-
-* Org Unit: BR2
-* Stop Depth: 0
-* Max Depth: Unset
-* Exclude: Off
--- /dev/null
+Floating Groups
+===============
+
+Before floating groups copies could float or not. If they floated then they floated everywhere, with no restrictions.
+
+After floating groups where a copy will float is defined by what group it has been assigned to.
+
+== Floating Groups
+
+Each floating group comes with a name and a manual flag, plus zero or more group members. The name is used solely for selection and display purposes.
+
+The manual flag dictates whether or not the "Manual Floating Active" checkin modifier needs to be active for a copy to float. This allows for greater control over when items float. It also prevents automated checkins via SIP2 from triggering floats.
+
+== Floating Group Members
+
+Each member of a floating group references an org unit and has a stop depth, an optional max depth, and an exclude flag.
+
+=== Org Unit
+
+The org unit and all descendants are included, unless max depth is set, in which case the tree is cut off at the max depth.
+
+=== Stop Depth
+
+The stop depth is the highest point from the current copy circ library to the checkin library for the item that will be traversed. If the item has to go higher than the stop depth on the tree the member rule in question is ignored.
+
+=== Max Depth
+
+As mentioned with the org unit, the max depth is the furthest down on the tree from the org unit that gets included. This is based on the entire tree, not just off of the org unit. So in the default tree a max depth of 1 will stop at the system level no matter if org unit is set to CONS or SYS1.
+
+=== Exclude
+
+Exclude, if set, causes floating to not happen for the member. Excludes always take priority, so you can remove an org unit from floating without having to worry about other rules overriding it.
+
+== Examples
+
+=== Float Everywhere
+
+This is a default floating rule to emulate the previous floating behavior for new installs and upgrades.
+
+One member:
+
+* Org Unit: CONS
+* Stop Depth: 0
+* Max Depth: Unset
+* Exclude: Off
+
+=== Float Within System
+
+This would permit a copy to float anywhere within a system, but would return to the system if it was returned elsewhere.
+
+One member:
+
+* Org Unit: CONS
+* Stop Depth: 1
+* Max Depth: Unset
+* Exclude: Off
+
+=== Float To All Branches
+
+This would permit a copy to float to any branch, but not to sublibraries or bookmobiles.
+
+One member:
+
+* Org Unit: CONS
+* Stop Depth: 0
+* Max Depth: 2
+* Exclude: Off
+
+=== Float To All Branches Within System
+
+This would permit a copy to float to any branch in a system, but not to sublibraries or bookmobiles, and returning to the system if returned elsewhere.
+
+One member:
+
+* Org Unit: CONS
+* Stop Depth: 1
+* Max Depth: 2
+* Exclude: Off
+
+=== Float Between BR1 and BR3
+
+This would permit a copy to float between BR1 and BR3 specifically, excluding sublibraries and bookmobiles.
+
+It would consist of two members, identical other than the org unit:
+
+* Org Unit: BR1 / BR3
+* Stop Depth: 0
+* Max Depth: 2
+* Exclude: Off
+
+=== Float Everywhere Except BM1
+
+This would allow an item to float anywhere except for BM1. It accomplishes this with two members.
+
+The first includes all org units, just like Float Everywhere:
+
+* Org Unit: CONS
+* Stop Depth: 0
+* Max Depth: Unset
+* Exclude: Off
+
+The second excludes BM1:
+
+* Org Unit: BM1
+* Stop Depth: 0
+* Max Depth: Unset
+* Exclude: On
+
+That works because excludes are applied first.
+
+=== Float into, but not out of, BR2
+
+This would allow an item to float into BR2, but once there it would never leave. Why you would want to allow items to float to but not from a single library I dunno, but here it is. This takes advantage of the fact that the rules say where we can float *to*, but outside of stop depth don't care where we are floating *from*.
+
+One member:
+
+* Org Unit: BR2
+* Stop Depth: 0
+* Max Depth: Unset
+* Exclude: Off
--- /dev/null
+Phonelist.pm Module
+===================
+
+PhoneList.pm is a mod_perl module for Apache that works with Evergreen
+to generate callings lists for patron holds. It outputs a csv file
+that can be fed into an auto-dialer script to call patrons with little
+or no staff intervention. It is accessed and configured via a special
+URL and passing any parameters as a ``Query String'' on the URL. The
+parameters are listed in the table below.
+
+.Parameters for the phonelist program:
+|=====================================
+| user | Your Evergreen login. Typically your library's circ account. If you leave this off, you will be prompted to login.
+| passwd | The password for your Evergreen login. If you leave this off you will be prompted to login.
+| ws_ou | The ID of the system or branch you want to generate the list for (optional). If your account does not have the appropriate permissions for the location whose ID number you have entered, you will get an error.
+| skipemail | If present, skip patrons with email notification (optional).
+| addcount | Add a count of items on hold (optional). Only makes sense for holds.
+| overdue | Makes a list of patrons with overdues instead of holds. If an additional, numeric parameter is supplied, it will be used as the number of days overdue. If no such extra parameter is supplied, then the default of 14 days is used.
+|=====================================
+
+The URL is
+
+`https://your.evergreen-server.tld/phonelist`
+
+A couple of examples follow:
+
+`https://your.evergreen-server.tld/phonelist?user=circuser&passwd=password&skipemail
+
+The above example would sign in as user circuser with password of
+``password'' and get a list of patrons with holds to call who do not
+have email notification turned on. It would run at whatever branch is
+normally associated with circuser.
+
+`https://your.evergreen-server.tld/phonelist?skipemail`
+
+The above example would do more or less the same, but you would be
+prompted by your browser for the user name and password.
+
+If your browser or download script support it, you may also use
+conventional HTTP authentication parameters.
+
+`https://user:password@your.evergreen-server.tld/phonelist?overdue&ws_ou=2`
+
+The above logs in as ``user'' with ``password'' and runs overdues for location ID 2.
+
+The following sections provide more information on getting what you want in your output.
+
+Adding Parameters
+-----------------
+
+If you are not familiar with HTTP/URL query strings, the format is
+quite simple.
+
+You add parameters to the end of the URL, the first parameter is
+separated from the URL page with a question mark (``?'') character. If
+the parameter is to be given an extra value, then that value follows
+the parameter name after an equals sign (``=''). Subsequent parameters
+are separated from the previous parameter by an ampersand (``&'').
+
+Here is an example with 1 parameter that has no value:
+
+`https://your.evergreen-server.tld/phonelist?skipemail`
+
+An example of 1 argument with a value:
+
+`https://your.evergreen-server.tld/phonelist?overdue=21`
+
+An example of 2 arguments, 1 with a value and 1 without:
+
+`https://your.evergreen-server.tld/phonelist?overdue=21&skipemail`
+
+Any misspelled or parameters not listed in the table above will be
+ignored by the program.
+
+Output
+------
+
+On a successful run, the program will return a CSV file named
+phone.csv. Depending on your browser or settings you will alternately
+be prompted to open or save the file. Your browser may also
+automatically save the file in your Downloads or other designated
+folder. You should be able to open this CSV file in Excel, LibreOffice
+Base, any other spread sheet program, or a text editor.
+
+If you have made a mistake and have mistyped your user name or
+password, or if you supply a ws_ou parameter with an ID where your
+user name does not have permission to look up holds or overdue
+information, then you will get an error returned in your browser.
+
+Should your browser appear to do absolutely nothing at all. This is
+normal. When there is no information for you to download, the server
+will return a 200 NO CONTENT message to your browser. Most browsers
+respond to this message by doing nothing at all. It is possible for
+there to be no information for you to retrieve if you added the
+`skipemail` option and all of your notices for that day were sent via
+email, or if you ran this in the morning and then again in the
+afternoon and there was no new information to gather.
+
+The program does indicate that it has already looked at a particular
+hold or overdue and will skip it on later runs. This prevents
+duplicates to the same patron in the same run. It will, however,
+create a ``duplicate'' for the same patron if a different copy is put
+on hold for that patron in between two runs.
+
+The specific content of the CSV file will vary if you are looking at
+holds or overdues. The specific contents are described in the
+appropriate sections below.
+
+Holds
+-----
+
+The `phonelist` program will return a list of patrons with copies on
+hold by default, so long as you do not use the `overdue`
+parameter. You may optionally get a number of items that patron
+currently has on hold by adding the `addcount` parameter.
+
+As always, you can add the skipemail parameter to skip patrons with
+email notifications of their overdues, [#0.5.Skipping patrons with
+email notification of holds|outline as described below].
+
+.Columns in the holds CSV file:
+|=====================================
+| Name | Patron's name first and last.
+| Phone | Patron's phone number.
+| Barcode | Patron's barcode.
+| Count | Number of copies on hold, if `addcount` parameter is used, otherwise this column is not present in the file.
+|=====================================
+
+Overdues
+--------
+
+If you add the `overdue` parameter, you can get a list of patrons with
+overdue copies instead of a list of patrons with copies on the hold
+shelf. By default, this will give you a list of patrons with copies
+that are 14 days overdue. If you'd like to specify a different number
+of days you can add the number after the parameter with an equals
+sign:
+
+`https://your.evergreen-server.tld/phonelist?overdue=21&ws_ou=2`
+
+The above will retrieve a list of patrons who have items that are 21
+days overdue at the location with ID of 2.
+
+The number of days is an exact lookup. This means that the program
+will look only at patrons who have items exactly 14 days or exactly
+the number of days specified overdue. It does not pull up any that are
+less than or greater than the number of days specified.
+
+As always, you can add the skipemail parameter to skip patrons with
+email notifications of their overdues, [#0.5.Skipping patrons with
+email notification of holds|outline as described below].
+
+.Columns in the overdues CSV file:
+|=================================
+| Name | Patron's name first and last.
+| Phone | Patron's phone number.
+| Barcode | Patron's barcode.
+| Titles | A colon-separated list of titles that the patron has overdue.
+|=================================
+
+Skipping patrons with email notification of holds
+-------------------------------------------------
+
+Skipping patrons who have email notification for their holds or
+overdues is very simple. You just need to add the `skipemail`
+parameter on the URL query string. Doing so will produce the list
+without the patrons who have email notification for overdues, or for
+all of their holds. Please note that if a patron has multiple holds
+available, and even one of these holds requests a phone-only
+notification, then that patron will still show on the list. For this
+option to exclude a patron from the holds list, the patron must
+request email notification on all of their current holds. In practice,
+we find that this is usually the case.
+
+Using the ws_ou parameter
+-------------------------
+
+Generally, you will not need to use the ws_ou parameter when using the
+phonelist program. The phonelist will look up the branch where your
+login account works and use that location when generating the list.
+However, if you are part of a multi-branch systems in a consortium,
+then the ws_ou parameter will be of interest to you. You can use it
+to specify which branch, or the whole system, you wish to search when
+running the program.
+
+Automating the download
+-----------------------
+
+If you'd like to automate the download of these files, you should be
+able to do so using any HTTP programming toolkit. Your client must
+accept cookies and follow any redirects in order to function.
include::admin/customize_staff_client.txt[]
+include::admin/phonelist.txt
+
Using the Staff Client
======================
include::admin/booking-admin.txt[]
+include::admin/floating_groups.txt[]
+
include::admin/MARC_Import_Remove_Fields.txt[]
include::admin/Org_Unit_Proximity_Adjustments.txt[]
projects / working / Evergreen.git / commitdiff