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 %SUBSTR(#)%, but limit to second provided number characters after start point. If second number is negative, count backwards instead of forwards.

There are several macros that can carry pre-built contents specific to individual libraries. The contents can be set up in local administration. For details see Library Settings. Though text can be hard-coded in receipt templates, the pre-built contents will be automatically applied to receipts printed from all workstations without editing each template.

  • %INCLUDE(notice_text)%
  • %INCLUDE(alert_text)%
  • %INCLUDE(event_text)%
  • %INCLUDE(footer_text)%%
  • %INCLUDE(header_text)%

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 library settings editor

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.

Table 32.1. 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.


Table 32.2. 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