Receipt Template Editor


Concepts

Libraries can customize the data that prints to their transaction reciepts using the Receipt Template Editor. Receipts can be edited by staff using the LIBcirc and LIBtech logins. Each function (Check Out, Check In, etc.) has special receipts that must be customized individually.

Apply all PLS-created default templates

PLS has created a set of default receipt templates that include basic information such as the library's address in the header, and contact information in the footer. These default can be applied to ALL templates in one step.

  1. Open the Receipt Template Editor
  2. Click Default
  3. Click Save Locally
  4. Repeat for each workstation

Edit a receipt template

Libraries can customize their receipts using the editor. To maintain consistent receipts, customizations must be duplicated on ALL library workstations. See instructions to export templates.

  1. From a Portal tab, click Edit Reciept Templates to open the template editor
  2. Select the template to modify
  3. Set the "Force Printer Context"
    • Select "Receipt" for any templates that will print to a receipt printer or "Default" for any templates that will print to a full size printer
    • See PrinterSettingsEditor27 for more detail about printer context
  4. The Preview section displays what the print result will be
  5. The text, macros, and HTML code controlling the receipt display are edited in the Header, Line Item, and Footer sections
    • Text demarcated by %percent signs% are Evergreen macros
    • Text demarcated by <angle brackets> are HTML tags
  6. As you edit the template, click Preview to check the changes
  7. When done, click Save Locally

Formatting Tips

Macros

Macros are shortcuts for pieces of data in Evergreen records - ex: %PATRON_BARCODE%, %due_date%. There are standard macros that can be used in every type of receipt template and receipt type specific templates.

For a full list of macros, see ReceiptTemplateMacros

Tag pairs

HTML tags come in a pairs - the "opening tag" (ie: <i>) starts formatting text as italics and the "closing tag" (ie: </i>) ends the formatting. If a closing tag is missing, the formatting will be wrong.See: BasicHtmlCode for some examples of HTML formatting tags that work in Evergreen

Line Breaks

Please note that you MUST use <br/> to designate the start of a new line with the SP500 series printers, just hitting enter will not start a new line on the receipt

Receipt actions

  • Preview - after editing a template, click Preview to see a draft version of the changes
  • Default - this will automatically revert ALL templates to the system default templates, wiping out any customizations, regardless of the template currently selected, edited, or customized
  • Macros - see a list of general macros and template type-specific macros
  • Save Locally - save all edited templates to the local workstation
  • Export - copy the template code to a text file to save and keep as a template backup
  • Import - upload the exported template file

Export and Import templates

The Export and Import functions allow you to save your templates as a separate file on your computer's memory, or a backup storage device. This is useful because:

  • If you use heavily customized receipts, saving a backup allows you to easily replace the template code if something is accidentally changed
  • Templates are saved to the computer, not the server. If you you have more than one computer that prints out receipts (i.e., more than one computer on the circulation desk, or another computer used to capture holds), you will need to export the template and import it on other workstations.

Export templates

  1. Click on Export
    ReceiptTemplateEditor_Export.jpg
  2. Select the location to save the template to, name the template, and click Save
    ReceiptTemplateEditor_ExportSaveAs.jpg
    • It is a good idea to include the date you are creating the file in the filename as a reference point
  3. Click OK
    ReceiptTemplateEditor_ExporConfirmation.jpg

Import templates

  1. Click Import
  2. Navigate to and select the template that you want to import. Click Open
  3. Click OK
  4. Click Save Locally
  5. Click OK

Template code customizations

  • TransitSlipReceipts - these pages provide instructions for customizing transit and hold transit slips so that they can be printed and used as a packing slip rather than using a handwritten slip.
  • CheckoutItemPriceSumReceipt - this code sums the copy price of all materials checked out and displays that total on the receipt. Libraries can add custom text, such as "You saved $[price sum] at the library today!" [file to be attached].
  • Hold Slip - Truncated Last Name and Barcode - Text file of code used to edit hold slips to display only the first 4 characters of a patrons last name and last 4 digits of their barcode, to be used to identify self-service hold pick ups.

Templates Available

Template Type Print from
item_status items ItemStatus
transit_list items TransitList
items_out items Patron Account > Items Out
renew items RenewItems22
checkout items CheckOutItems
offline_checkout offline_checkout Offline Mode
checkin items CheckInItems
bill_payment payment PayBills
bills_historical bills Patron Account > Bills > Bill History - Transactions or Payments lists
bills_current bills Patron Account > Bills > Current bills lists
offline_checkin offline_checkin Offline Mode
offline_renew offline_renew Offline Mode
offline_inhouse_use offline_inhouse_use Offline Mode
in_house_use items RecordInHouseUse
holds holds Patron Account > Holds
holds_on_bib holds Edits to one hold receipt display in all hold receipts, regardless of template name or holds interface
holds_for_patron holds
holds_shelf holds
holds_pull_list holds
hold_slip holds
transit_slip transits
hold_transit_slip transits
holdings_maintenance items
bills_main_view bills
EvergreenWebForm
Topic Subject Client
Service Evergreen
Documentation type Informational
Year

Includes RT Form? No
Status

Topic revision: r7 - 09 Jun 2016 - 12:06:05 - LindsayStratton
Evergreen.ReceiptTemplateEditor moved from Evergreen.RecieptTemplateEditor on 15 Oct 2014 - 18:48 by LindsayStratton - put it back
 

This site is powered by the TWiki collaboration platformCopyright © by the contributing authors. All material on this collaboration platform is the property of the contributing authors.
Ideas, requests, problems regarding PLUM? Send feedback