]> git.evergreen-ils.org Git - working/Evergreen.git/blob - docs/RELEASE_NOTES_NEXT/Administration/phonelist.txt
3130c4607875cd80a2badb18091b5544ec7ddee2
[working/Evergreen.git] / docs / RELEASE_NOTES_NEXT / Administration / phonelist.txt
1 Phonelist.pm Module
2 ===================
3
4 PhoneList.pm is a mod_perl module for Apache that works with Evergreen
5 to generate callings lists for patron holds. It outputs a csv file
6 that can be fed into an auto-dialer script to call patrons with little
7 or no staff intervention.  It is accessed and configured via a special
8 URL and passing any parameters as a ``Query String'' on the URL.  The
9 parameters are listed in the table below.
10
11 .Parameters for the phonelist program:
12 |=====================================
13 | user |  Your Evergreen login. Typically your library's circ account. If you leave this off, you will be prompted to login.
14 | passwd | The password for your Evergreen login. If you leave this off you will be prompted to login.
15 | 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.
16 | skipemail | If present, skip patrons with email notification (optional).
17 | addcount | Add a count of items on hold (optional). Only makes sense for holds.
18 | 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.
19 |=====================================
20
21 The URL is
22
23 `https://your.evergreen-server.tld/phonelist`
24
25 A couple of examples follow:
26
27 `https://your.evergreen-server.tld/phonelist?user=circuser&passwd=password&skipemail
28
29 The above example would sign in as user circuser with password of
30 ``password'' and get a list of patrons with holds to call who do not
31 have email notification turned on. It would run at whatever branch is
32 normally associated with circuser.
33
34 `https://your.evergreen-server.tld/phonelist?skipemail`
35
36 The above example would do more or less the same, but you would be
37 prompted by your browser for the user name and password.
38
39 If your browser or download script support it, you may also use
40 conventional HTTP authentication parameters.
41
42 `https://user:password@your.evergreen-server.tld/phonelist?overdue&ws_ou=2`
43
44 The above logs in as ``user'' with ``password'' and runs overdues for location ID 2.
45