koha-tmpl/intranet-tmpl/prog/en/modules/help/tools/letter.tt

   1 [% INCLUDE 'help-top.inc' %]
   2
   3 <h1>Notices & slips</h1>
   4
   5 <p>All notices and circulation receipts (or slips) generated by Koha can be customized using the Notices &amp; Slips Tool. The system comes with several predefined templates that will appear when you first visit this tool.</p>
   6
   7 <p>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. Each notice and slip can be edited on a per library basis, by default you will see the notices for all libraries.</p>
   8
   9 <p>If you have a style you'd like applied to all slips you can point the SlipCSS preference to a stylesheet. The same is true for notices, using the NoticeCSS preference to define a stylesheet.</p>
  10
  11 <h3>Adding Notices & Slips</h3>
  12
  13 <p>To add a new notice or slip</p>
  14
  15 <ul>
  16     <li>Click 'New Notice'</li>
  17     <li>Choose which library this notice or slip is for</li>
  18     <li>Choose the module this notice is related to</li>
  19     <li>The Code is limited to 20 characters
  20 <ul>
  21     <li style="color: #990000;">Important: When working with the overdue notices you want each notice at each branch to have a unique code. Think about using the branch code in front of the notice code for each branch.</li>
  22 </ul>
  23 </li>
  24     <li>Use the name field to expand on your Code
  25 <ul>
  26     <li style="background-color: #ffe599;">Tip: With overdue notices, be sure to put your branch name in the description as well so that it will be visible when setting up your triggers.</li>
  27 </ul>
  28 </li>
  29     <li>Next you can customize the notice for every possible delivery method
  30 <ul>
  31     <li>Every notice should have an Email template set for it</li>
  32     <li>If you're using the TalkingTechItivaPhoneNotification service you can set up a Phone notification</li>
  33     <li>If you plan on printing this notice you can set the Print template next</li>
  34     <li>If you have enabled SMS notices with the SMSSendDriver preference you can set the text for your SMS notices next</li>
  35 </ul>
  36 </li>
  37     <li>Each notice offers you the same options
  38 <ul>
  39     <li>If you plan on writing the notice or slip in HTML check the 'HTML Message' box, otherwise the content will be generated as plain text</li>
  40     <li>Message Subject is what will appear in the subject line of the email</li>
  41     <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.
  42 <ul>
  43     <li><span style="color: #990000;">Important: Overdue notices can use &lt;&lt;items.content&gt;&gt; tags by themselves, or use &lt;item&gt;&lt;/item&gt; to span all of the tags.</span>
  44 <ul>
  45     <li>On overdue notices make sure to use &lt;&lt;items.content&gt;&gt; tags to print out the data related to all items that are overdue.</li>
  46 </ul>
  47 <ul>
  48     <li>The other option, only for overdue notices, is to use the &lt;item&gt;&lt;/item&gt; tags to span the line so that it will print out multiple lines. One example for the &lt;item&gt;&lt;/item&gt; tag option is:&lt;item&gt;"&lt;&lt;biblio.title&gt;&gt;" by
  49 &lt;&lt;biblio.author&gt;&gt;, &lt;&lt;items.itemcallnumber&gt;&gt;,
  50 Barcode: &lt;&lt;items.barcode&gt;&gt; , Checkout date:
  51 &lt;&lt;issues.issuedate&gt;&gt;, Due date:
  52 &lt;&lt;issues.date_due&gt;&gt; Fine: &lt;&lt;items.fine&gt;&gt; Due date:
  53 &lt;&lt;issues.date_due&gt;&gt; &lt;/item&gt;</li>
  54 </ul>
  55 </li>
  56     <li style="color: #990000;">Important: Only the overdue notices take advantage of the &lt;item&gt;&lt;/item&gt; tags, all other notices referencing items need to use &lt;&lt;items.content&gt;&gt;</li>
  57     <li style="background-color: #ffe599;">Tip: To add today's date you can use the &lt;&lt;today&gt;&gt; syntax</li>
  58 </ul>
  59 </li>
  60 </ul>
  61 </li>
  62 </ul>
  63
  64 <h5>Overdue Notice Markup</h5>
  65
  66 <p>When creating your overdue notices there are two tags in addition to the various database fields that you can use in your notices.</p>
  67
  68 <p style="color: #990000;">Important: These new tags only work on the overdue notices, not other circulation related notices at this time.</p>
  69
  70 <p>These tags are &lt;item&gt; and &lt;/item&gt; which should enclose all fields from the biblio, biblioitems, and items tables.</p>
  71
  72 <p>An example of using these tags in a notice template might be like:</p>
  73
  74 <p>The following item(s) is/are currently overdue:</p>
  75
  76 <p>   &lt;item&gt;"&lt;&lt;biblio.title&gt;&gt;" by &lt;&lt;biblio.author&gt;&gt;, &lt;&lt;items.itemcallnumber&gt;&gt;, Barcode: &lt;&lt;items.barcode&gt;&gt; Fine: &lt;&lt;items.fine&gt;&gt;&lt;/item&gt;</p>
  77
  78 <p>Which, assuming two items were overdue, would result in a notice like:</p>
  79
  80 <p>The following item(s) is/are currently overdue:</p>
  81
  82 <p>   "A Short History of Western Civilization" by Harrison, John B, 909.09821 H2451, Barcode: 08030003 Fine: 3.50<br />
  83    "History of Western Civilization" by Hayes, Carlton Joseph Huntley, 909.09821 H3261 v.1, Barcode: 08030004 Fine: 3.50</p>
  84
  85 <h4>Existing Notices &amp; Slips</h4>
  86
  87 <p>Among the default notices are notices for several common actions within Koha. All of these notices can be customized by altering their text via the Notices &amp; Slips tool and their style using the NoticeCSS preference to define a stylesheet. Here are some of what those notices do</p>
  88 <ul>
  89     <li>ACCTDETAILS
  90 <ul>
  91     <li>Sent to patrons when their account is set up if the AutoEmailOPACUser preference is set to 'Send'</li>
  92 </ul>
  93 </li>
  94     <li>ACQCLAIM (Acquisition Claim)
  95 <ul>
  96     <li>Used in the claim acquisition module</li>
  97     <li><em>Get there:</em> More &gt; Acquisitions &gt; Late issues</li>
  98 </ul>
  99 </li>
 100     <li>CHECKIN
 101 <ul>
 102     <li>This notice is sent as the 'Check in' notice for all items that are checked in</li>
 103     <li>This notice is used if two criteria are met:
 104 <ol>
 105     <li>The EnhancedMessagingPreferences is set to 'Allow'</li>
 106     <li>The patron has requested to receive this notice
 107 <ul>
 108     <li><em>Get there: </em>OPAC &gt; Login &gt; my messaging</li>
 109     <li><em>Get there: </em>Staff Client &gt; Patron Record &gt; Notices</li>
 110 </ul>
 111 </li>
 112 </ol>
 113 </li>
 114 </ul>
 115 </li>
 116     <li>CHECKOUT
 117 <ul>
 118     <li>This notice is sent as the 'Check out' notice for all items that are checked out</li>
 119     <li>This notice is used if two criteria are met:
 120 <ol>
 121     <li>The EnhancedMessagingPreferences is set to 'Allow'</li>
 122     <li>The patron has requested to receive this notice
 123 <ul>
 124     <li><em>Get there: </em>OPAC &gt; Login &gt; my messaging</li>
 125     <li><em>Get there: </em>Staff Client &gt; Patron Record &gt; Notices</li>
 126 </ul>
 127 </li>
 128 </ol>
 129 </li>
 130 </ul>
 131 </li>
 132     <li>DUE
 133 <ul>
 134     <li>This notice is sent as the 'Item due' for an item is due</li>
 135     <li>This notice is used if two criteria are met:
 136 <ol>
 137     <li>The EnhancedMessagingPreferences is set to 'Allow'</li>
 138     <li>The patron has requested to receive this notice
 139 <ul>
 140     <li><em>Get there: </em>OPAC &gt; Login &gt; my messaging</li>
 141     <li><em>Get there: </em>Staff Client &gt; Patron Record &gt; Notices</li>
 142 </ul>
 143 </li>
 144 </ol>
 145 </li>
 146 </ul>
 147 </li>
 148     <li>DUEDGST
 149 <ul>
 150     <li>This notice is sent as the 'Item due' for all items that are due</li>
 151     <li>This notice is used if two criteria are met:
 152 <ol>
 153     <li>The EnhancedMessagingPreferences is set to 'Allow'</li>
 154     <li>The patron has requested to receive this notice as a digest
 155 <ul>
 156     <li><em>Get there: </em>OPAC &gt; Login &gt; my messaging</li>
 157     <li><em>Get there: </em>Staff Client &gt; Patron Record &gt; Notices</li>
 158 </ul>
 159 </li>
 160 </ol>
 161 </li>
 162 </ul>
 163 </li>
 164     <li>HOLD (Hold Available for Pickup)
 165 <ul>
 166     <li>This notice is used if two criteria are met:
 167 <ol>
 168     <li>The EnhancedMessagingPreferences is set to 'Allow'</li>
 169     <li>The patron has requested to receive this notice
 170 <ul>
 171     <li><em>Get there: </em>OPAC &gt; Login &gt; my messaging</li>
 172     <li><em>Get there: </em>Staff Client &gt; Patron Record &gt; Notices</li>
 173 </ul>
 174 </li>
 175 </ol>
 176 </li>
 177     <li>When this notice references the branches table it is referring to the pickup branch information.</li>
 178 </ul>
 179 </li>
 180     <li>HOLDPLACED (a notice to the library staff that a hold has been placed)
 181 <ul>
 182     <li>This notice requires the emailLibrarianWhenHoldIsPlaced system preference to be set to 'Enable'</li>
 183     <li>When this notice references the branches table it is referring to the pickup branch information.</li>
 184 </ul>
 185 </li>
 186     <li>ODUE (Overdue Notice)
 187 <ul>
 188     <li>This notice is used to send Overdue Notices to Patrons</li>
 189     <li>Requires that you set Overdue Notice/Status Triggers</li>
 190 </ul>
 191 </li>
 192     <li>PREDUE
 193 <ul>
 194     <li>This notice is sent as the 'Advanced notice' for an item is due</li>
 195     <li>This notice is used if two criteria are met:
 196 <ol>
 197     <li>The EnhancedMessagingPreferences is set to 'Allow'</li>
 198     <li>The patron has requested to receive this notice
 199 <ul>
 200     <li><em>Get there: </em>OPAC &gt; Login &gt; my messaging</li>
 201     <li><em>Get there: </em>Staff Client &gt; Patron Record &gt; Notices</li>
 202 </ul>
 203 </li>
 204 </ol>
 205 </li>
 206 </ul>
 207 </li>
 208     <li>PREDUEDGST
 209 <ul>
 210     <li>This notice is sent as the 'Advanced notice' for all items that are due</li>
 211     <li>This notice is used if two criteria are met:
 212 <ol>
 213     <li>The EnhancedMessagingPreferences is set to 'Allow'</li>
 214     <li>The patron has requested to receive this notice as a digest
 215 <ul>
 216     <li><em>Get there: </em>OPAC &gt; Login &gt; my messaging</li>
 217     <li><em>Get there: </em>Staff Client &gt; Patron Record &gt; Notices</li>
 218 </ul>
 219 </li>
 220 </ol>
 221 </li>
 222 </ul>
 223 </li>
 224     <li>RENEWAL
 225 <ul>
 226     <li>This notice is sent as the 'Check out' notice for all items that are renewed</li>
 227     <li>This notice is used if three criteria are met:
 228 <ol>
 229     <li>The EnhancedMessagingPreferences is set to 'Allow'</li>
 230     <li>The RenewalSendNotice preference is set to 'Send'</li>
 231     <li>The patron has requested to receive the checkout notice
 232 <ul>
 233     <li><em>Get there: </em>OPAC &gt; Login &gt; my messaging</li>
 234     <li><em>Get there: </em>Staff Client &gt; Patron Record &gt; Notices</li>
 235 </ul>
 236 </li>
 237 </ol>
 238 </li>
 239 </ul>
 240 </li>
 241     <li>SERIAL_ALERT (New serial issue)
 242 <ul>
 243     <li>Used in the serials module to notify patrons/staff of new issues of a serial
 244 <ul>
 245     <li><em>Get there:</em> More &gt; Serials &gt; New Subscription</li>
 246 </ul>
 247 </li>
 248     <li>You have the option to select the 'Routing List' notice when creating a new subscription (Choose from the 'Patron notification' drop down).</li>
 249     <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>
 250 </ul>
 251 </li>
 252     <li>SHARE_ACCEPT
 253 <ul>
 254     <li>Used to notify a patron when another patron has accepted their shared list.</li>
 255     <li>Requires that you set OpacAllowSharingPrivateLists to 'Allow'</li>
 256 </ul>
 257 </li>
 258     <li>SHARE_INVITE
 259 <ul>
 260     <li>Used to notify a patron that another patron would like to share a list with them.</li>
 261     <li>Requires that you set OpacAllowSharingPrivateLists to 'Allow'</li>
 262 </ul>
 263 </li>
 264 </ul>
 265
 266 <p>There are also a set of predefined slips (or receipts) listed on this page. All of these slips can be customized by altering their text via the Notices &amp; Slips tool and their style using the SlipCSS preference to define a stylesheet. Here is what those slips are used for:</p>
 267
 268 <ul>
 269     <li>ISSUEQSLIP
 270 <ul>
 271     <li>Used to print the quick slip in circulation</li>
 272     <li>The quick slip only includes items that were checked out today</li>
 273 </ul>
 274 </li>
 275     <li>ISSUESLIP
 276 <ul>
 277     <li>Used to print a full slip in circulation</li>
 278     <li>The slip or receipt will show items checked out today as well as items that are still checked out</li>
 279 </ul>
 280 </li>
 281     <li>HOLD_SLIP
 282 <ul>
 283     <li>Used to print a holds slip</li>
 284     <li>The holds slip is generated when a hold is confirmed</li>
 285 </ul>
 286 </li>
 287     <li>TRANSFERSLIP
 288 <ul>
 289     <li>Used to print a transfer slip</li>
 290     <li>The transfer slip is printed when you confirm a transfer from one branch to another in your system</li>
 291 </ul>
 292 </li>
 293 </ul>
 294
 295 <p><strong>See the full documentation for Notices in the <a href="http://koha-community.org/manual/[% helpVersion %]/html/tools.html#notices-slips">manual</a> (online).</strong></p>
 296
 297 [% INCLUDE 'help-bottom.inc' %]