Here is the documentation for receipt templates. This is based on 2.1, but I will have the 2.2 and 2.3 changes done soon.
Lynn Floyd <mailto:[email protected]> [email protected] Anderson County Library 864-260-4500 x181 <http://www.andersonlibrary.org/> http://www.andersonlibrary.org
Receipt Template Editor ----------------------- All receipts in Evergreen 2.2 follow a basic format of a Header, Line item and Footer. The receipt templates follow full W3C html. http://w3schools.com/html/default.asp. The Receipt Template Editor can be found at: . Admin . Workstation Administration . Receipt Template Editor The Editor can also be found on the default home page of the staff client. Receipts come in various types: Bills, checkout, items, holds, transits and Payments. To edit a Receipt: . Choose the Receipt in the drop down list. . Make edits to the Receipt on the right hand side. . Click off out of the section you are editing to see what your changes will look right on the Left hand side. . Click ' 'Save Locally' ' in the Uppder right hand corner. Receipt templates use macros for various pieces of information coming from the Evergreen database. Macros deal with everything from the Library name to the due date of an item. See list <<macros, Receipt Macros for the macros>>. You can also click on MACROS on the screen to see the macros that are avaialble for a given receipt. IMPORTANT: *Remember:* Not all Macros listed on the pop up screen will work. The listing of macros are drawn from the table that the receipt pulls information from. Some of the tables will not have any data in some of the fields. Example is the %mbts_xact_finish% on the Bills Current Slip, as this is a list of current bills, they would not have a finish date. Exporting and importing Customized Receipts ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ Once you have your receipts set up on one machine you can export your receipts, and then load them on to another machine. Just remember to ' 'Save Locally' ' once you import the receipts on the new machine. Exporting templates ^^^^^^^^^^^^^^^^^^^ As you can only save a template on to the computer you are working on you will need to export the template if you have more than one computer that prints out receipts (i.e., more than one computer on the circulation desk, or another computer in the workroom that you use to checkin items or capture holds with) . Export. . Select the location to save the template to, name the template, and click Save. . Click OK. Importing Templates ^^^^^^^^^^^^^^^^^^^ . Click Import. . Navigate to and select the template that you want to import. Click Open. . Click OK. . Click Save Locally. . Click OK. Receipt Customizations ~~~~~~~~~~~~~~~~~~~~~~ Customizing the receipts is fairly simple once you realize what can be placed in each of the sections of the receipts. One thing to remember when customizing receipts to always ' 'Save Locally' '. Checkouts, Hold Slip, Hold Transit Slip are customized below. TIP: Always remember to ' 'Save Locally' '. Checkout ^^^^^^^^ This is the receipt that prints when items are checked out to individuals. Item you can customize are adding the library logo, adding information about renewals on the bottom of the receipt. If you notice at the end of the Footer the <br/>.<br/>, the allows an auto cut printer a little extra room so it will not cut the phone number off. The period is needed so the extra lines are added. Header [source, html] ------------- <img align="center" src="http://www.library.org/images/logo.jpg";><br/> Welcome to %LIBRARY%!<br/> You checked out the following items:<hr/><ol> ------------- Line Item [source,html] ---------------------------------------------------------------------------------- <li>%title%<br/> By: %author%<br/> Barcode: %barcode%<br/> Due: %due_date% ---------------------------------------------------------------------------------- Footer [source,html] ---------------------------------------------------------------------------------- </ol> <hr /> %SHORTNAME% %TODAY_TRIM%<br/> You were helped by %STAFF_FIRSTNAME%<br/> <br/> <center>If you want to renew your materials please visit<br/> www.library.org<br/> or call us at ###-###-####</center> <br/> <br/> .<br/> ---------------------------------------------------------------------------------- Hold_Slip #1 ^^^^^^^^^^^^^ This is the slip that prints when a hold is fulfilled. Things to customize are the patrons name at the top of the slip, Bold the %hold_for_msg%, among others. Header [source,html] ---------------------------------------------------------------------------------- <font size="6"><b>%PATRON_LASTNAME%, %PATRON_FIRSTNAME%</b> </font><br/><br/><br/><br/> This item needs to be routed to <b>%route_to%</b>:<br/> Barcode: %item_barcode%<br/> Title: %item_title%<br/> <br/> <b>%hold_for_msg%</b><br/> Barcode: %PATRON_BARCODE%<br/> Notify by phone: %notify_by_phone%<br/> Notify by email: %notify_by_email%<br/> ---------------------------------------------------------------------------------- Line Item [source,html] ---------------------------------------------------------------------------------- <em>%formatted_note%</em><br/> ---------------------------------------------------------------------------------- Footer [source,html] ---------------------------------------------------------------------------------- Request date: %request_date%<br/> <br/> Slip Date: %TODAY_D% %TODAY_I%:%TODAY_M%<br/> Printed by %STAFF_FIRSTNAME% at %SHORTNAME%<br/>.<br/> ---------------------------------------------------------------------------------- Hold_Slip #2 ^^^^^^^^^^^^^ This is the slip is when a hold is fulfilled. This slip uses the SUBSTR macro to truncate the Patrons Last name to the first 4 characters and the patron's barcode to the last 5 digits. This slip is designed for libraries that use self serve holds. So, you will notice a lot of information about the hold is left off of the receipt. Header [source,html] ---------------------------------------------------------------------------------- <p style="padding-top:80px; padding-bottom:80px"> <font size="6"><b>%SUBSTR(0,4)%%PATRON_LASTNAME%%SUBSTR_END% %SUBSTR(54)%%PATRON_BARCODE%%SUBSTR_END%</b></font></p> </font><br/><br/><br/><br/> This item needs to be routed to <b>%route_to%</b>:<br/> Barcode: %item_barcode%<br/> Title: %item_title%<br/> <br/> Notify by phone: %notify_by_phone%<br/> ---------------------------------------------------------------------------------- Line Item [source,html] ---------------------------------------------------------------------------------- <em>%formatted_note%</em><br/> ---------------------------------------------------------------------------------- Footer [source,html] ---------------------------------------------------------------------------------- Request date: %request_date%<br/> <hr style="border: 1px dotted"/><br/> Slip Date: %TODAY_TRIM%<br/> Printed by %STAFF_FIRSTNAME% at %SHORTNAME%<br/>.<br/> ---------------------------------------------------------------------------------- Hold_transit_slip ^^^^^^^^^^^^^^^^^^ This is the slip that is printed when an Item is needed at another library for a hold. In this customization, the address of the library is removed, The library's shortname size is increased, and made a little more notable at top, and the patron's phone number and email address is removed from the slip. Header [source,html] ---------------------------------------------------------------------------------- <font size="5">Route to %route_to%</font><br/><br/><br/> This item needs to be routed to <b>%route_to%</b>:<br/> %route_to_org_fullname%<br/><br/> Barcode: %item_barcode%<br/> Title: %item_title%<br/> Author: %item_author%<br><br/> %hold_for_msg%<br/> Barcode: %PATRON_BARCODE%<br/> ---------------------------------------------------------------------------------- Line Item [source,html] ---------------------------------------------------------------------------------- <em>%formatted_note%</em><br/> ---------------------------------------------------------------------------------- Footer [source,html] ---------------------------------------------------------------------------------- <br/>Request date: %request_date%<br/> Slip Date: %TODAY_TRIM%<br/> Printed at %SHORTNAME%<br/> <br/><br/>.<br/> ---------------------------------------------------------------------------------- Receipt Templates ~~~~~~~~~~~~~~~~~ This is a complete list of all the receipts currently in use in Evergreen. item_status:: type::: items description::: listing of items inputed in to Item Status default format::: header:::: The following items have been examined:<hr/><ol> line_item:::: <li>%title%<br/>Barcode: %barcode% footer:::: </ol><hr />%SHORTNAME% %TODAY_TRIM%<br/><br/> transit_list:: type::: transits description::: List of items in transit default format::: header:::: Transits:<hr/><ol> line_item:::: <li>From: %transit_source% To: %transit_dest_lib%<br/>When: %transit_source_send_time%<br />Barcode: %transit_item_barcode% Title: %transit_item_title%<br/> footer:::: </ol><hr />%SHORTNAME% %TODAY_TRIM%<br/><br/> items_out:: type::: items description::: List of items out default format::: header:::: Welcome to %LIBRARY%!<br/>You have the following items:<hr/><ol> line_item:::: <li>%title%<br/>Barcode: %barcode% Due: %due_date% footer:::: </ol><hr />%SHORTNAME% %TODAY_TRIM%<br/>You were helped by %STAFF_FIRSTNAME%<br/><br/> renew:: type::: items description::: List of items that have been renewed using the renew item screen default format::: header:::: Welcome to %LIBRARY%!<br/>You have renewed the following items::<hr/><ol> line_item:::: <li>%title%<br/>Barcode: %barcode% Due: %due_date% footer:::: </ol><hr />%SHORTNAME% %TODAY_TRIM%<br/>You were helped by %STAFF_FIRSTNAME%<br/><br/> checkout:: type::: items description::: list of items currently checked out default format::: header:::: Welcome to %LIBRARY%!<br/>You checked out the following items::<hr/><ol> line_item:::: <li>%title%<br/>Barcode: %barcode% Due: %due_date% footer:::: </ol><hr />%SHORTNAME% %TODAY_TRIM%<br/>You were helped by %STAFF_FIRSTNAME%<br/><br/> offline_checkout:: type::: offline_checkout description::: list of items checked out via the Offline mode. Remember that offline mode does not have access to the database. default format::: header:::: Patron %patron_barcode%<br/>You checked out the following items::<hr/><ol> line_item:::: <li>Barcode: %barcode%<br/>Due: %due_date% footer:::: </ol><hr />%TODAY_TRIM%<br/><br/> checkin:: type::: items description::: List of items that have just been entered in to the checkin screens. default format::: header:::: You checked in the following items:<hr/><ol> line_item:::: <li>%title%<br/>Barcode: %barcode% Call Number: %call_number% footer:::: </ol><hr />%SHORTNAME% %TODAY_TRIM%<br/><br/> bill_payment:: type::: payment description::: Patron payment receipt. default format::: header:::: Welcome to %LIBRARY%!<br/> A receipt of your transaction: <hr/> <table width="100%"> <tr> <td>Original Balance:</td> <td align="right">$%original_balance%</td> </tr> <tr> <td>Payment Method:</td> <td align="right">%payment_type%</td> </tr> <tr> <td>Payment Received:</td> <td align="right">$%payment_received%</td> </tr> <tr> <td>Payment Applied:</td> <td align="right">$%payment_applied%</td> </tr> <tr> <td>Billings Voided:</td> <td align="right">%voided_balance%</td> </tr> <tr> <td>Change Given:</td> <td align="right">$%change_given%</td> </tr> <tr> <td>New Balance:</td> <td align="right">$%new_balance%</td> </tr> </table> <p> Note: %note% </p> <p> Specific bills: <blockquote> line_item:::: Bill #%bill_id% %last_billing_type% Received: $%payment%<br />%barcode% %title%<br /><br /> footer:::: </blockquote> </p> <hr />%SHORTNAME% %TODAY_TRIM%<br/> <br/> bills_historical:: type::: bills description::: listing of bills that have had payments made on the. This is used on the Bill History Transaction screen. default format::: header:::: Welcome to %LIBRARY%!<br/>You had the following bills:<hr/><ol> line_item:::: <dt><b>Bill #%mbts_id%</b> %title% </dt> <dd> <table> <tr valign="top"><td>Date:</td><td>%mbts_xact_start%</td></tr> <tr valign="top"><td>Type:</td><td>%xact_type%</td></tr> <tr valign="top"><td>Last Billing:</td><td>%last_billing_type%<br/>%last_billing_note%</td></tr> <tr valign="top"><td>Total Billed:</td><td>$%total_owed%</td></tr> <tr valign="top"><td>Last Payment:</td><td>%last_payment_type%<br/>%last_payment_note%</td></tr> <tr valign="top"><td>Total Paid:</td><td>$%total_paid%</td></tr> <tr valign="top"><td><b>Balance:</b></td><td><b>$%balance_owed%</b></td></tr> </table><br/> footer:::: </ol><hr />%SHORTNAME% %TODAY_TRIM%<br/><br/> bills_current:: type::: bills description::: Listing of current bills default format::: header:::: Welcome to %LIBRARY%!<br/> You have the following bills:<hr/><ol> line_item:::: <dt><b>Bill #%mbts_id%</b></dt> <dd> <table> <tr valign="top"><td>Date:</td><td>%mbts_xact_start%</td></tr> <tr valign="top"><td>Type:</td><td>%xact_type%</td></tr> <tr valign="top"><td>Last Billing:</td><td>%last_billing_type%<br/>%last_billing_note%</td></tr> <tr valign="top"><td>Total Billed:</td><td>$%total_owed%</td></tr> <tr valign="top"><td>Last Payment:</td><td>%last_payment_type%<br/>%last_payment_note%</td></tr> <tr valign="top"><td>Total Paid:</td><td>$%total_paid%</td></tr> <tr valign="top"><td><b>Balance:</b></td><td><b>$%balance_owed%</b></td></tr> </table><br/> footer:::: </ol><hr />%SHORTNAME% %TODAY_TRIM%<br/><br/> offline_checkin:: type::: offline_checkin description::: list of item checked in via Standalone interface default format::: header:::: You checked in the following items:<hr/><ol> line_item:::: <li>Barcode: %barcode% footer:::: </ol><hr />%TODAY_TRIM%<br/><br/> offline_renew:: type::: offline_renew description::: List of items renewed via Standalone Interface. default format::: header:::: You renewed the following items:<hr/><ol> line_item:::: <li>Barcode: %barcode% footer:::: </ol><hr />%TODAY_TRIM%<br/><br/> offline_inhouse_use:: type::: offline_inhouse_use description::: List of item marked in-house use via Standalone interface default format::: header:::: You marked the following in-house items used:<hr/><ol> line_item:::: <li>Barcode: %barcode%Uses: %count% footer:::: </ol><hr />%TODAY_TRIM%<br/><br/> in_house_use:: type::: items description::: List of items inputted in to the In-house use. default format::: header:::: You marked the following in-house items used:<hr/><ol> line_item:::: <li>Barcode: %barcode%Uses: %uses%<br />%alert_message% footer:::: </ol><hr />%TODAY_TRIM%<br/><br/> holds:: type::: holds description::: Patron payment receipt. default format::: header:::: Welcome to %LIBRARY%!<br/>You have the following titles on hold:<hr/><ol> line_item:::: <li>%title% footer:::: </ol><hr />%SHORTNAME% %TODAY_TRIM%<br/>You were helped by %STAFF_FIRSTNAME%<br/><br/> holds_on_bib:: type::: holds description::: This list is used to print the holds on a title record. This uses the holds receipt. inherit::: holds holds_for_patron:: description::: This list is used to print the holds on a patron record. This uses the holds receipt. type::: holds inherit::: holds holds_shelf:: type::: holds description::: This list is used to print the holds on the holds shelf. This uses the holds receipt. inherit::: holds holds_pull_list:: type::: holds description::: This list is used to print the holds on the holds pull list. This uses the holds receipt. inherit::: holds hold_slip:: type::: holds description::: This is printed when a hold is fullfilled. default format::: header:::: This item needs to be routed to <b>%route_to%</b>:<br/>Barcode: %item_barcode%<br/>Title: %item_title%<br/><br/>%hold_for_msg%<br/>Barcode: %PATRON_BARCODE%<br/>Notify by phone: %notify_by_phone%<br/>Notified by text: %notify_by_text%<br/>Notified by email: %notify_by_email%<br/> line_item:::: %formatted_note%<br/> footer:::: <br/>Request date: %request_date%<br/>Slip Date: %TODAY_TRIM%<br/>Printed by %STAFF_FIRSTNAME% at %SHORTNAME%<br/><br/> transit_slip:: type::: transits description::: This is printed when a item goes into transit. default format::: header:::: This item needs to be routed to <b>%route_to%</b>:<br/>%route_to_org_fullname%<br/> %street1%<br/>%street2%<br/> %city_state_zip%<br/><br/> Barcode: %item_barcode%<br/> Title: %item_title%<br/> Author: %item_author%<br><br/> line_item:::: (Intentially left blank) footer:::: Slip Date: %TODAY_TRIM%<br/>Printed by %STAFF_FIRSTNAME% at %SHORTNAME%<br/><br/> hold_transit_slip:: type::: transits description::: This is printed when a hold goes intransit to another library. default format::: header:::: This item needs to be routed to <b>%route_to%</b>:<br/>%route_to_org_fullname%<br/> %street1%<br/>%street2%<br/>%city_state_zip%<br/><br/> Barcode: %item_barcode%<br/> Title: %item_title%<br/> Author: %item_author%<br><br/> %hold_for_msg%<br/>Barcode: %PATRON_BARCODE%<br/> Notify by phone: %notify_by_phone%<br/> Notified by text: %notify_by_text%<br/> Notified by email: %notify_by_email%<br/> line_item:::: %formatted_note%<br/> footer:::: <br/>Request date: %request_date%<br/>Slip Date: %TODAY_TRIM%<br/>Printed by %STAFF_FIRSTNAME% at %SHORTNAME%<br/><br/> holdings_maintenance:: type::: items description::: This is printed from holding maintenance. default format::: header:::: Title: %title%<br/> Author: %author%<br/> ISBN: %isbn% Edition: %edition% PubDate: %pubdate%<br/> TCN: %tcn_value% Record ID: %mvr_doc_id%<br/> Creator: %creator% Create Date: %create_date%<br/> Editor: %editor% Edit Date: %edit_date%<hr/> line_item:::: %prefix% %tree_location% %suffix% %parts% %acp_status%<br/> footer:::: <hr />%SHORTNAME% %TODAY_TRIM%<br/><br/> [[macros]] Receipt Template Editor Macros ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ Here is a list of the Receipt Template Macros that are in use on the receipts. There are two types of macros General and type specific. General Macros can be used on any of the receipts. Type specific macros are available depending on the type of the receipt. .General Macros %LIBRARY%:: Library full name %SHORTNAME%:: Library Policy Name %STAFF_FIRSTNAME%:: First name of Staff login account %STAFF_LASTNAME%:: Last name of Staff login account %STAFF_BARCODE%:: Barcode of Staff login account %STAFF_PROFILE%:: Profile of Staff login account %PATRON_FIRSTNAME%:: First name of Patron %PATRON_LASTNAME%:: Last name of Patron %PATRON_BARCODE% or %patron_barcode%:: Patron Barcode %TODAY%:: Full Date and time in the format: Wed Sep 21 2011 13:20:44 GMT-0400 (Eastern Daylight Time) %TODAY_TRIM%:: Date and time in a shorted format: 2011-09-21 13:21 %TODAY_m%:: Two digit Month: 09 %TODAY_d%:: Two digit Day: 21 %TODAY_Y%:: Year: 2011 %TODAY_H%:: Hour in 24 hour day: 13 %TODAY_I%:: Hour in 12 hour format: 1 %TODAY_M%:: Minutes of the Hour: 24 %TODAY_D%:: date in standard US format: 09/21/11 %TODAY_F%:: date in International Standard: 2011-09-21 %-TRIM%:: Trims white space before the macro %TRIM-%:: Trims white space after the macro %SUBSTR(#)%...%SUBSTR_END%:: Take substring starting at position # to end of string. If # is negative count backwards from end of string. %SUBSTR(#,#)%...%SUBSTR_END%:: Same as previous, but limit to second provided number characters after start point. If second number is negative, count backwards instead of forwards. TIP: TRIM macros inside of SUBSTR will be replaced first, then SUBSTR, then TRIM outside of SUBSTR. CAUTION: When using The SUBSTR with another macro, the macro cannot be used again. This is current bug on 2.1. Additional Macros for various slip types ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ .Holds %ROUTE_TO%:: It should say Hold Shelf if it is a hold being fulfilled %item_barcode%:: Item Barcode %item_title%:: Item Title %hold_for_msg%:: Hold for Message: this gives the patron's Name %PATRON_BARCODE%:: Patron's Barcode %notify_by_phone%:: Phone number listed in the Hold Database. This may not be the same as what is in the Patron's record, as they can list another number when placing the hold. %notify_by_email%:: Email listed in Hold Database. Same as phone number %request_date%:: The date that the Request was originally placed. %formatted_note%:: Hold Notes (new to 2.1) %notify_by_text%:: SMS contact number (new to 2.2) .Check out %title%:: Title %author%:: Author %barcode%:: Item Barcode %due_date%:: Due Date: formated by the date field in the .Payment %original_balance%:: The original balance the patron owes %payment_received%:: How much was received from the patron %payment_applied%:: How much of the payment was applied %payment_type%:: What type of payment was applied: IE Cash %voided_balance%:: Any Voided balance %change_given%:: How much change was given %new_balance%:: The new balance on the account %note%:: Any notes on the annotated payment %bill_id% or %mbts_id%:: The id for the bill in the bill database %payment%:: How much of the payment that was applied was applied to this title %title%:: Title that the payment was applied to. %last_billing_type%:: The type of bill that was last charged to the patron for this title %last_billing_note%:: Notes on the last bill %last_payment_type%:: The type of payment that was last used to pay the bill %mbts_xact_start%:: The date that the bill was started %last_payment_note%:: Notes on last payment %xact_type%:: Type of Biil %barcode%:: Item barcode %title%:: title of item .Bills %mbts_id%:: The id for the bill in the bill database %title%:: Title that the payment was applied to. %last_billing_type%:: The type of bill that was last charged to the patron for this bill %last_billing_note%:: Notes on the last bill %last_billing_ts%:: The time stamp for the last billing %last_payment_type%:: The type of payment that was last used to pay the bill %last_payment_note%:: Notes on last payment %last_payment_ts%:: The time stamp for the last payment %mbts_xact_start%:: The date that the bill was started (currently not working) %xact_type%:: Type of Biil %title%:: title of item .Transit Transit receipts come into two types, general Transit receipts and Transit slips. Transit receipts are listings of item that are in transits. Transit slips are Slips telling the staff that this item is in transit to another location. .General Transits %transit_item_author%:: Item author %transit_item_barcode%:: Barcode of item in transit %transit_item_callnumber%:: Call number of item in transit %transit_item_title%:: Title of Item intransit %transit_dest_lib%:: Destination Library %transit_source_send_time%:: Time item was sent intransit %transit_source%:: Library that placed the item intransit. .Transit Slip %route_to%:: Library Policy Name that the item is in transit to %route_to_org_fullname%:: Library Full Name that the item is in transit to %street1%:: Library Street address Line 1 that the item is in transit to. %street2%:: Library Street address Line 2 that the item is in transit to. %city_state_zip%:: City, State, Zip of Library the Item is in transit to. %item_barcode%:: Item barcode %item_title%:: Item title %item_author%:: Item Author %hold_for_msg%:: Hold for Message: this gives the patron's name %PATRON_BARCODE%:: Patron's Barcode %notify_by_phone%:: Phone number listed in the Hold Database. This may not be the same as what is in the Patron's record, as they can list another number when placing the hold. %notify_by_email%:: Email listed in Hold Database. Same as phone number %notify_by_text%:: SMS contact number (new to 2.2) %request_date%:: Date that the Request was originally placed
_______________________________________________ OPEN-ILS-DOCUMENTATION mailing list [email protected] http://list.georgialibraries.org/mailman/listinfo/open-ils-documentation
![http://www.library.org/images/logo.jpg"](http://www.library.org/images/logo.jpg"){kind=link}