PINES Documentation

User Tools

Site Tools

You are here: home » admin » workstations » receipts
admin:workstations:receipts

Differences

This shows you the differences between two versions of the page.

Link to this comparison view

Both sides previous revisionPrevious revision
Next revision		Previous revision
circ:workstations:receipts [2018/02/27 17:51] – [Export / Import Customized Templates] tmccannaadmin:workstations:receipts [2023/11/07 20:43] (current) – tmccanna
Line 3: Line 3:
 Most of the receipts that print from the Evergreen staff client software are managed via the Print Template Editor (Administration > Workstation > Print Templates) and can be customized on an individual workstation basis. Typically, library systems will set up the receipts the way they want them to print out on one workstation at a branch, then export the settings as a file and import that file to each of the other workstations at that branch. Some library systems choose to set up different types of workstations (Circulation versus Technical Services, for example) differently depending on the type of work that needs to be done. Most of the receipts that print from the Evergreen staff client software are managed via the Print Template Editor (Administration > Workstation > Print Templates) and can be customized on an individual workstation basis. Typically, library systems will set up the receipts the way they want them to print out on one workstation at a branch, then export the settings as a file and import that file to each of the other workstations at that branch. Some library systems choose to set up different types of workstations (Circulation versus Technical Services, for example) differently depending on the type of work that needs to be done.
  
-If Hatch is installed receipts can be forced to use a specific printer settings (Administration > Workstation > Printer Settings).+If Hatch is installed, receipts can be forced to use specific printer settings (Administration > Workstation > Printer Settings).
  
 <note>There are a few receipts, such as the Evergreen self-checkout receipts, that are controlled through Notification Action Triggers rather than through Print Templates. Changes to the notification action triggers are set on a PINES-wide basis and restricted to PINES staff. Any requests for changes will need to be reviewed for suitability for all PINES libraries.</note> <note>There are a few receipts, such as the Evergreen self-checkout receipts, that are controlled through Notification Action Triggers rather than through Print Templates. Changes to the notification action triggers are set on a PINES-wide basis and restricted to PINES staff. Any requests for changes will need to be reviewed for suitability for all PINES libraries.</note>
Line 10: Line 10:
  
   * **Bills, Current:** Listing of current bills on an account.\\   * **Bills, Current:** Listing of current bills on an account.\\
-  * **Bills, Historic:** Listing of bills that have had payments made on them. This used on the Bill History Transaction screen.\\+  * **Bills, Historic:** Listing of bills that have had payments made on them. This is used on the Bill History Transaction screen.\\
   * **Bills, Payment:** Patron payment receipt.\\   * **Bills, Payment:** Patron payment receipt.\\
   * **Checkin:** List of items that have been entered in to the check-in screen.\\   * **Checkin:** List of items that have been entered in to the check-in screen.\\
Line 19: Line 19:
   * **Holds for Patron:** Prints a list of holds on a patron record.\\   * **Holds for Patron:** Prints a list of holds on a patron record.\\
   * **Hold Pull List:** Prints the Holds Pull List.\\   * **Hold Pull List:** Prints the Holds Pull List.\\
-  * **Hold Shelf List:** Prints a list of hold that are waiting to be picked up.\\+  * **Hold Shelf List:** Prints a list of holds that are waiting to be picked up.\\
   * **In-House Use List:** Prints a list of items imputed into In-house use.\\   * **In-House Use List:** Prints a list of items imputed into In-house use.\\
   * **Item Status:** Prints a list of items imputed into Item Status.\\   * **Item Status:** Prints a list of items imputed into Item Status.\\
   * **Items Out:** Prints the list of items a patron has checked out.\\   * **Items Out:** Prints the list of items a patron has checked out.\\
-  * **Patron Address:** Prints the current patrons address.\\+  * **Patron Address:** Prints the current patron's address.\\ 
 +  * **Patron Data:** Prints from the patron edit screen.\\
   * **Patron Note:** Prints a note on a patron's record.\\   * **Patron Note:** Prints a note on a patron's record.\\
   * **Renew:** List of items that have been renewed using the Renew Item Screen.\\   * **Renew:** List of items that have been renewed using the Renew Item Screen.\\
Line 45: Line 46:
   - Click Save Locally.   - Click Save Locally.
  
-{{ :circ:workstations:print-templates.png?600 |}}+[{{ :circ:workstations:print-templates.png?600 |Print Template Editor}}]
  
 ==== Content / Data ==== ==== Content / Data ====
Line 51: Line 52:
 The various pieces of data that can be printed on a receipt are limited, and vary by receipt type. The various pieces of data that can be printed on a receipt are limited, and vary by receipt type.
  
-  * See: **[[circ:workstations:receipt-content|Receipt Content Reference]]**+  * See: **[[admin:workstations:receipt-content|Receipt Content Reference]]**
 ==== Formatting ==== ==== Formatting ====
  
Line 79: Line 80:
 | Capitalize   | circulation  | %%<span style="text-transform:capitalize;">circulation</span>%%  | Circulation  | | Capitalize   | circulation  | %%<span style="text-transform:capitalize;">circulation</span>%%  | Circulation  |
 | Currency     | 1            | %%{{1 | currency}}%%                                             | $1.00        | | Currency     | 1            | %%{{1 | currency}}%%                                             | $1.00        |
 +| Italics | hello | %%<i>hello</i>%%  | //hello// |
 +| Underline | hello | %%<u>hello</u>%% | __hello__ |
 +| Line Break | hello there | %%hello<br/>there%% | hello\\ there |
 +
 +**Horizontal Line**
 +
 +If you want to create a horizontal line going across your entire receipt, you can use the %%<hr/>%% (Horizontal Rule) tag which creates a line similar to this:
 +
 +----
 +
 +**Text Blocks with Outlines**
 +
 +If you want to create a box on your receipt that has an outline (solid, dotted, or dashed), you can use CSS code to do so. For example:
 +
 +This code creates a box with a solid, thin (1px) line:
 +%%<div style="border:1px solid #000">Hello</div>%%
 +
 +{{ :circ:workstations:box1.jpg?direct&400 |}}
 +
 +This code creates the same box, but centers the text that is inside the box:
 +%%<div style="border:1px solid #000;text-align:center;">Hello</div>%%
 +
 +{{ :circ:workstations:box2.jpg?direct&400 |}}
 +
 +You can change the solid line to a dotted line and make it thicker (3px):
 +%%<div style="border:3px dotted #000;text-align:center;">Hello</div>%%
 +
 +{{ :circ:workstations:box3.jpg?direct&400 |}}
 +
 +You can also create dashed lines:
 +%%<div style="border:2px dashed #000;text-align:center;">Hello</div>%%
 +
 +{{ :circ:workstations:box4.jpg?direct&400 |}}
  
 ==== Date Formatting ==== ==== Date Formatting ====
Line 87: Line 121:
 | %%{{today}}%%  | 2017-08-01T14:18:51.445Z  | | %%{{today}}%%  | 2017-08-01T14:18:51.445Z  |
 | %%{{today | date:'short'}}%%  | 8/1/17 10:18 AM  | | %%{{today | date:'short'}}%%  | 8/1/17 10:18 AM  |
-| %%{{today | date:'M/d/yyyy'}}%%  | 8/1/2017  |+| %%{{today | date:'M/d/yyyy'}}%%  | 8/1/2017  |  
 +| %%{{today | date:'longDate'}}%% | August 1, 2017|
  
 +[[https://angular.io/api/common/DatePipe|Reference for additional date formats]]
 ==== Currency Formatting ==== ==== Currency Formatting ====
  
Line 103: Line 139:
 You can use Angular JS to only print a line if the data matches. For example: You can use Angular JS to only print a line if the data matches. For example:
  
-<nowiki><div ng-if="hold.email_notify == 't'">Notify by email: {{patron.email}}</div></nowiki>+**Example: Only show email if email notification is selected**
  
 This will only print the "Notify by email:" line if email notification is enabled for that hold. This will only print the "Notify by email:" line if email notification is enabled for that hold.
  
 +<nowiki><div ng-if="hold.email_notify == 't'">Notify by email: {{patron.email}}</div></nowiki>
 +
 +
 +**Example: Only show balance if amount is owed**
 +
 +This example for the checkout print template will only print the amount a patron owes if there is a balance:
 +
 +<nowiki><span ng-if="patron_money.balance_owed">You owe the library $<nowiki>{{patron_money.balance_owed}}</nowiki></span></nowiki>
 +
 +**Example: Show note based on circulation modifier**
 +
 +This example is used on the checkout print template by libraries using fines-free circulation modifiers and shows a note when an item is //not// fines-free.
 +
 +<nowiki><div ng-if="!checkout.copy.circ_modifier.name.includes('-ff')"><b>This item is subject to fines.</b></div></nowiki>
 +
 +A slight variation is necessary to display the same note on the Items Out template.
 +
 +<nowiki><div ng-if="!checkout.copy.circ_modifier.includes('-ff')"><b>This item is subject to fines.</b></div></nowiki>
 +
 +Here is an example of showing special instructions for items with the circulation modifier of statepass on the checkout template.
 +
 +<nowiki><div ng-if="checkout.copy.circ_modifier.includes('statepass')"><b>To use your statepass... (instructions here)</b></div></nowiki>
 +
 +**Example: Show note for specific title record**
 +
 +This example shows a note if the item is attached to the title record with '5628015' as the database id on either the checkin or checkout receipt. (You can see the database ID for a title by looking at the record summary information in the staff catalog or by looking at the id in the URL of the title record.)
 +
 +<nowiki><div ng-if="checkout.call_number.record == '5628015'" style="border:2px dotted black;padding:10px;"><b>To use the zoo pass... (instructions here)</b></div></nowiki>
 +
 +A slight difference is required for the same note to work on the items out receipt:
 +
 +<nowiki><div ng-if="checkout.copy.call_number.record.id == '5628015'" style="border:2px dotted black;padding:10px;"><b>To use the zoo pass... (instructions here)</b></div></nowiki>
 +
 +**Example: Use preferred name if available**
 +
 +If the patron has a preferred name stored in their account, you can use a ternary operator to display it instead of the legal name. The first part before the question mark checks to see whether or not there is anything in that field. If there is, then it shows the value of the second part (before the colon). If not, then it shows the value of the third part (after the colon).
  
-Example for checkout print template that will only print the amount a patron owes if there is a balance:+<nowiki>{{patron.pref_first_given_name ? patron.pref_first_given_name : patron.first_given_name}}</nowiki>
  
-<span ng-if="patron_money.balance_owed">You owe the library $<nowiki>{{patron_money.balance_owed}}</nowiki></span> 
  
  
-See also: [[https://docs.angularjs.org/api/ng/directive/ngIf]]+**See also:** [[https://docs.angularjs.org/api/ng/directive/ngIf]]
 ==== Substrings ==== ==== Substrings ====
  
Line 147: Line 218:
 There are different ways to approach printing out receipts for items that will be left on a public holds shelf for patrons to pick up themselves, but it is always important to remove as much patron information from the printed receipts as possible. The attached example of a customized hold shelf slip print template uses only the first four letters of the patron's last name along with the last four numbers of the barcode. It includes information on the hold arrival date and shelf expiration date, and how the patron was notified, but not the details (ie, patron was notified by email, but does not print the email address). Because staff need to have the patron's phone number for those patrons who opt to be notified by phone, the receipts for those patrons will print the phone number at the very bottom where it can be cut off before the item is placed on the public shelf for pickup. There are different ways to approach printing out receipts for items that will be left on a public holds shelf for patrons to pick up themselves, but it is always important to remove as much patron information from the printed receipts as possible. The attached example of a customized hold shelf slip print template uses only the first four letters of the patron's last name along with the last four numbers of the barcode. It includes information on the hold arrival date and shelf expiration date, and how the patron was notified, but not the details (ie, patron was notified by email, but does not print the email address). Because staff need to have the patron's phone number for those patrons who opt to be notified by phone, the receipts for those patrons will print the phone number at the very bottom where it can be cut off before the item is placed on the public shelf for pickup.
  
-{{ :circ:workstations:sample-public-hold-shelf-slip-template.pdf | See example of a Hold Shelf Slip template designed for Self-Service (Public) Holds Shelves}}+{{ :admin:workstations:public_holds_shelf_print_template_example.pdf | See example of a Hold Shelf Slip template designed for Self-Service (Public) Holds Shelves}}
  
  
Line 158: Line 229:
 Evergreen allows certain blocks of text on the server to be configured to display across multiple print templates without needing to update the workstations every time the text changes. For example, if a library wishes to promote a different event every day, the library could configure the print templates on each workstation to include 'event text' and then would be able to change the content of that text each day in one location to have the change appear in all locations.  Evergreen allows certain blocks of text on the server to be configured to display across multiple print templates without needing to update the workstations every time the text changes. For example, if a library wishes to promote a different event every day, the library could configure the print templates on each workstation to include 'event text' and then would be able to change the content of that text each day in one location to have the change appear in all locations. 
  
-==== 1) Create the Included Text Setting ====+=== 1) Create the Included Text Setting ===
  
   - Go to: Administration > Local Administration > Library Settings Editor   - Go to: Administration > Local Administration > Library Settings Editor
   - Select the relevant library system or branch.   - Select the relevant library system or branch.
-  - Add the text (HTML is allowed) to the include you wish to use (eg, event_text). The settings are:+  - Add the text (HTML is __NOT__ allowed) to the include you wish to use (eg, event_text). The settings are:
       - Content of alert_text include       - Content of alert_text include
       - Content of event_text include       - Content of event_text include
Line 169: Line 240:
       - Content of notice_text include       - Content of notice_text include
  
-==== 2) Update Print Templates ====+=== 2) Update Print Templates ===
  
   - Go to: Administration > Workstation > Print Templates   - Go to: Administration > Workstation > Print Templates
   - Select a template you wish to include the text on.   - Select a template you wish to include the text on.
-  - Edit the template to add the include tag (eg, {{includes.event_text}}). Possibilities are: +  - Edit the template to add the include tag (eg, <nowiki>{{includes.event_text}}</nowiki>). Possibilities are: 
-      - {{includes.alert_text}} +      - <nowiki>{{includes.alert_text}}</nowiki> 
-      - {{includes.event_text}} +      - <nowiki>{{includes.event_text}}</nowiki> 
-      - {{includes.footer_text}} +      - <nowiki>{{includes.footer_text}}</nowiki> 
-      - {{includes.header_text}} +      - <nowiki>{{includes.header_text}}</nowiki> 
-      - {{includes.notice_text}}+      - <nowiki>{{includes.notice_text}}</nowiki>
   - Click Save Locally.   - Click Save Locally.
   - Repeat for each other template you wish to include the tag on, and for each other workstation.   - Repeat for each other template you wish to include the tag on, and for each other workstation.
 +  - Log out and then log back in to see the changes. 
  
-==== 3) Update Included Text ====+=== 3) Update Included Text ===
  
 When you wish to change the text that appears on each receipt, repeat step 1 (step 2 does not need to be repeated).  When you wish to change the text that appears on each receipt, repeat step 1 (step 2 does not need to be repeated). 
Line 188: Line 260:
 If you wish to remove the included text, you can clear out the contents of the library setting. There is no need to remove the tag from each of the workstations. If you wish to remove the included text, you can clear out the contents of the library setting. There is no need to remove the tag from each of the workstations.
  
 +The changes will appear after you log out and then log back in.
  
admin/workstations/receipts.1519753868.txt.gz · Last modified: 2018/10/11 20:15 (external edit)