1 [% INCLUDE 'help-top.inc' %]
4 All notices sent by Koha can be customized using the Notices Tool. The system comes with several predefined templates that will appear when you first visit the Notices Tool
6 Each notice can be edited, but only a few can be deleted, this is to prevent system errors should a message try to send without a template.
7 <h2>Adding Notices</h2>
9 <li>To add a new notice
11 <li>Click 'New Notice'</li>
12 <li>Choose the module this notice is related to</li>
13 <li>The Code is limited to 20 characters</li>
14 <li>Use the name field to expand on your Code</li>
15 <li>Message Subject is what will appear in the subject line of the email</li>
16 <li>In the message body feel free to type whatever message you feel is best, use the fields on the left hand side to enter individualized data from the from database.
18 <li style="color: #ff0000;">Important: On overdue notices make sure to use <<items.content>> to print out the data related to all items that are overdue. The other option is to use the <item></item> tags to span the line so that it will print out multiple lines</li>
19 <li style="color: #ff0000;">Important: Only the overdue notices take advantage of the <item></item> tags, all other notices referencing items need to use <<items.content>></li>
25 <h3>Notice Markup</h3>
26 When creating your overdue notices there are two tags in addition to the various database fields that you can use in your notices.
27 <p style="color: #ff0000;">Important: These new tags only work on the overdue notices, not other circulation related notices at this time.</p>
30 <li><item></item> which should enclose all fields from the biblio, biblioitems, and items tables.</li>
31 <li><fine></fine> which should be enclosed by the item tag and should enclose a currency identifier per ISO 4217. If this tag is present with a proper identifier, the fine for that item will be displayed in the proper currency format.
33 <li>Note: ISO 4217 changes from time to time therefore all currencies may not be supported. If you find one that is not supported, please file a bug with the Locale::Currency::Format author Tan D Nguyen <tnguyen at cpan doe org>.</li>
37 An example of using these two tags in a notice template might be like:
38 <pre>The following item(s) is/are currently overdue:
40 <item>"<<biblio.title>>" by <<biblio.author>>, <<items.itemcallnumber>>, Barcode: <<items.barcode>> Fine: <fine>GBP</fine></item></pre>
41 Which, assuming two items were overdue, would result in a notice like:
42 <pre>The following item(s) is/are currently overdue:
44 "A Short History of Western Civilization" by Harrison, John B, 909.09821 H2451, Barcode: 08030003 Fine: £3.50
45 "History of Western Civilization" by Hayes, Carlton Joseph Huntley, 909.09821 H3261 v.1, Barcode: 08030004 Fine: £3.50</pre>
46 <h2>Existing Notices</h2>
47 Among the default notices are notices for several common actions within Koha, here are some of what those notices do
51 <li>Sent to patrons when their account is set up if the AutoEmailOPACUser preference is set to 'Send'</li>
54 <li>ACQCLAIM (Acquisition Claim)
56 <li>Used in the claim acquisition module</li>
57 <li>Get there: More > Acquisitions > Late issues</li>
60 <li>HOLD (Hold Available for Pickup)
62 <li>This notice is used if two criteria are met:
64 <li>The EnhancedMessagingPreferences is set to 'Allow'</li>
65 <li>The patron has requested to receive this notice
67 <li>Get there: OPAC > Login > my messaging</li>
68 <li>Get there: Staff Client > Patron Record > Messaging</li>
75 <li>HOLDPLACED (a notice to the library staff that a hold has been placed)
77 <li>This notice requires the emailLibrarianWhenHoldIsPlaced system preference to be set to 'Enable'</li>
80 <li>HOLD_PRINT (Printed notice when hold available for pickup)
82 <li>This notice is used for hold confirmation notices that are sent out in print format. This will not effect what the email notice looks like.</li>
85 <li>ODUE (Overdue Notice)
87 <li>This notice is used to send Overdue Notices to Patrons</li>
88 <li>See a Sample Overdue Notice</li>
89 <li>Requires that you set Overdue Notice/Status Triggers</li>
92 <li>RLIST (Routing List)
94 <li>Used in the serials module to notify patrons/staff of new issues of a serial
96 <li>Get there: More > Serials > New Subscription</li>
99 <li>You have the option to select the 'Routing List' notice when creating a new subscription (Choose from the 'Patron notification' drop down).</li>
100 <li style="background-color: #ffe599;">Tip: Notice also that if you'd like to notify patrons of new serial issues, you can click on 'define a notice' which will take you to the 'Notices' tool</li>
104 [% INCLUDE 'help-bottom.inc' %]