d43e74438f834c7845c8aa8c621811d5ae31f8f7
[working/Evergreen.git] / docs / admin / SMS_messaging.txt
1 SMS Text Messaging
2 ------------------
3
4 The SMS Text Messaging feature enables users to receive hold notices via text message.  Users can opt-in to this hold notification as their default setting for all holds, or they 
5 can receive specific hold notifications via text message.    Users can also send call numbers and copy locations via text message.
6
7 Administrative Setup
8 ~~~~~~~~~~~~~~~~~~~~
9
10 You cannot receive text messages from Evergreen by default.  You must enable this feature to receive hold notices and copy information from Evergreen via text message.
11
12 Enable Text Messages
13 ^^^^^^^^^^^^^^^^^^^^
14
15 . Click *Admin* -> *Local Admin* -> *Library Settings Editor.*
16 . Select the setting, *Enable features that send SMS text messages.*
17 . Set the value to *True,* and click *Update Setting.*
18
19 image::media/SMS_Text_Messaging1.jpg[SMS_Text_Messaging1]
20
21 Authenticate Patrons
22 ^^^^^^^^^^^^^^^^^^^^
23
24 By default, you must be logged into your OPAC account to send a text message from Evergreen.  However, if you disable this setting, you can text message copy information without having 
25 to login to your OPAC account.
26
27 To disable the patron login requirement:
28
29 . Click *Admin* -> *Local Administration* -> *Library Settings Editor.*
30 . Select the setting, *Disable auth requirement for texting call numbers*.
31 . Set the value to *True,* and click *Update Setting.*
32
33 image::media/SMS_Text_Messaging2.jpg[SMS_Text_Messaging2]
34
35 Configure SMS Carriers
36 ^^^^^^^^^^^^^^^^^^^^^^
37
38 A list of SMS carriers that can transmit text messages to users is available in the staff client.  Library staff can edit this list, or add new carriers.
39
40 To add or edit SMS carriers:
41
42 . Click *Admin* -> *Server Administration* -> *SMS Carriers*.
43 . To add a new carrier, click the *New Carrier* button in the top right corner of the screen.  To edit an existing carrier, double click in any white space in the carrier's row.
44 +
45 image::media/SMS_Text_Messaging3.jpg[SMS_Text_Messaging3] 
46 +
47 . Enter a (geographical) *Region*.
48 . Enter the carrier's *Name*.
49 . Enter an *Email Gateway.*  The SMS carrier can provide you with the content for this field.  The $number field is converted to the user's phone number when the text message is generated.
50 . Check the *Active* box to use this SMS Carrier.
51
52 image::media/SMS_Text_Messaging4.jpg[SMS_Text_Messaging4]
53
54 Configure Text Message Templates
55 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
56
57 Library staff control the content and format of text messages through the templates in Notifications/Action Triggers.  Patrons cannot add free text to their text messages.
58
59 To configure the text of the SMS text message:
60
61 . Click *Admin* -> *Local Administration* -> *Notifications/Action Triggers.*
62 . Create a new A/T and template, or use or modify an existing template.  For example, a default template, "Hold Ready for Pickup SMS Notification," notifies users that the hold is ready for pickup.  
63 +
64 image::media/SMS_Text_Messaging5.jpg[SMS_Text_Messaging5]
65 +
66 . You can use the  default template, or you can edit the template and add content specific to your library.  Click the hyperlinked name to view and/or edit the hold notice.
67
68 image::media/SMS_Text_Messaging6.jpg[SMS_Text_Messaging6]
69
70 Receiving Holds Notices via Text Message
71 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
72
73 You can receive notification that your hold is ready for pickup from a text message that is sent to your mobile phone.
74
75 . Login to your account.
76 +
77 image::media/SMS_Text_Messaging12.jpg[SMS_Text_Messaging12]
78 +
79 . Search the catalog.
80 . Retrieve a record, and click the *Place Hold* link.
81 . Select the option to retrieve hold notification via text message.
82 . Choose an SMS Carrier from the drop down menu.  NOTE: You can enter your SMS carrier and phone number into your *Account Preferences* to skip steps five and six.
83 . Enter a phone number.
84 . Click *Submit.*
85
86 image::media/SMS_Text_Messaging13.jpg[SMS_Text_Messaging13]
87
88 Sending Copy Locations via Text Message
89 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
90
91
92 You can search the catalog for an item, and, after retrieving results for the item, click a hyperlink to send the copy location in a text message.
93
94 . Login to your account in the OPAC.  NOTE: If you have disabled the setting that requires patron login, then you do not have to login to their accounts to send text messages.  
95 See *Administrative Setup* for more information.
96 +
97 image::media/SMS_Text_Messaging7.jpg[SMS_Text_Messaging7]
98 +
99 . Search the catalog, and retrieve a title with copies.
100 . Click the *Text* link adjacent to the call number.
101 +
102 image::media/SMS_Text_Messaging8.jpg[SMS_Text_Messaging8]
103 +
104 . The text of the SMS Text Message appears.
105 +
106 image::media/SMS_Text_Messaging9.jpg[SMS_Text_Messaging9]
107 +
108 . Choose an SMS Carrier from the drop down menu.  NOTE: You can enter your SMS carrier and phone number into your *Account Preferences* to skip steps five and six. 
109 . Enter a phone number. 
110 +
111 image::media/SMS_Text_Messaging10.jpg[SMS_Text_Messaging10]
112 +
113 . Click *Submit*.
114 . The number and carrier are converted to an email address, and the text message is sent to your mobile phone.
115
116 image::media/SMS_Text_Messaging11.jpg[SMS_Text_Messaging11]
117
118 *Permissions to use this Feature*
119
120 ADMIN_SMS_CARRIER - Enables users to add/create/delete SMS Carrier entries.
121
122