Web Client: Print Templates - Missing/Problem Fields

[John Amundson]

Most recently tested on Evergreen Web Client 3.0.7.

As our libraries are preparing for the move to the web client, they have begun working on their print templates, and we are finding many of the fields available in the XUL client do not work in the web client.

Searching through launchpad, there have been other reports of missing/problem fields, but the tickets are usually specific. I wanted to open a bug to try and collect all the missing fields in hope that others won't have to go searching through launchpad like me when trying to sort out their templates. Additionally, collecting them may allow fields missing from multiple templates to be fixed in one go instead of several.

I have begun a Google Sheet collecting all the missing/problem fields that I have come across. You can find it here: https://docs.google.com/spreadsheets/d/1G2sO8i09dPIUiAalanQC7k_DP_nlYOIjeKgdK-0-oeI/edit?usp=sharing

I am sure I've missed some fields, so I'm going to be brave and give everyone editing privileges. If I've missed something or a field has already been fixed, go ahead and edit the doc. Just be kind. Because the web client sought parity with the xul client, for now I've only included fields that were available in the xul client.

The document includes fields that a)don't exist at all for the print template, b)may show in the preview but do not print, or c)don't show in the preview but do print. Fields falling into a) or b) would be priorities because it is more important for fields to print, but c) can be very frustrating when trying to put together a working template.

I also wanted to collect all the other lp bugs related to print template fields. If you think a field is missing from the document, it is possible is has already been fixed in another bug.

https://bugs.launchpad.net/evergreen/+bug/1708485 Courier Code added to Transit/Hold Transit slips - 2.12.5. Currently prints but does not show in preview - see lp bug 1730003.
https://bugs.launchpad.net/evergreen/+bug/1708487 Title and Item Barcode added to Bills,Current/Historical - 2.12.8/3.0.2. Title and Item Barcode both work, but the bills templates are still missing other item fields. See document.
https://bugs.launchpad.net/evergreen/+bug/1708488 Balance Owed added to Checkout template - 3.0.2.
https://bugs.launchpad.net/evergreen/+bug/1708489 Shelf Expire Date added to Hold Shelf Slip - 3.0.2/2.12.8.
https://bugs.launchpad.net/evergreen/+bug/1710731 Call Number added to Hold Shelf Slip - 3.0.2.
https://bugs.launchpad.net/evergreen/+bug/1718225 Patron Expire Date missing in Checkout Slip. This was fixed in lp bug 1737540.
https://bugs.launchpad.net/evergreen/+bug/1720148 Holdings Maintenance Template missing
https://bugs.launchpad.net/evergreen/+bug/1724032 Add Permission Group to Hold Shelf Slip - Wishlist
https://bugs.launchpad.net/evergreen/+bug/1725412 Transit Copy Status missing from Transit/Hold Transit slips
https://bugs.launchpad.net/evergreen/+bug/1730003 Courier Code does not appear in preview for Transit/Hold Transit slips
https://bugs.launchpad.net/evergreen/+bug/1737540 Patron fields added to Checkout, Items Out, and Bills, Payment. This include patron expire date as stated missing in lp bug 1718225
https://bugs.launchpad.net/evergreen/+bug/1743660 Payment Received field missing from Bills,Payment. I am using the code {{payment_total | currency}} in my templates for this. Now I'm questioning if that is the corresponding field.
https://bugs.launchpad.net/evergreen/+bug/1745232 Transaction Finish Time missing from Bills,Historical. In my testing, {{xact.xact_finish}} works but it does not appear in the preview. See document
https://bugs.launchpad.net/evergreen/+bug/1745240 Hold Alias missing from Holds Shelf Slip. In my testing, the field appears with {{patron.alias}} in the preview but does not print. See document
https://bugs.launchpad.net/evergreen/+bug/1750630 Transit List not printing transits. This can be fixed by removing the extra ":" in {{transit.source_send_time | date:}}. Should be updated to {{transit.source_send_time | date}}

I think that covers them all. Whew that was a lot. Anyway, I hope this bug helps those setting up print templates and were running into roadblocks like me.

(If anyone is bored and wants to attack one of the fields most requested at CW MARS, we would greatly appreciate having Item Owning Library, (Call Number owning library), added to the bills,current and bills,historical templates. Some of our libraries use these printouts to send with checks when a patron pays for an item owned by another library)

[John Amundson (jamundson)]

Adding a new bug to this list: https://bugs.launchpad.net/evergreen/+bug/1772444 - Patron fields added to Bills, current and Bills, historical. Currently has pullrequest tag.

[Jennifer Pringle (jpringle-u)]

Added Shelving Location for on the Items Out receipt to the google sheet.

[Jason Stephenson (jstephenson)]

I set this bug to confirmed because it affects more than 1 site, i.e. 3 people plus the submitter.

I targeted it at 3.0 and added a milestone for 3.1 so it doesn't fall of the RADAR. I'm not saying it will be fixed in those releases.

[Blake GH (bmagic)]

I would like to point out that all of the fields that were fleshed out for bug 1737540 (thank you Jason) - are not fleshed out on bills_current. I have tested each of these with this syntax:

{{patron.suffix}}<br />
{{patron.first_given_name}}<br />
{{patron.second_given_name}}<br />
{{patron.suffix}}<br />
{{patron.card.barcode}}<br />
{{patron.money_summary.balance_owed}}<br />
{{patron.money_summary.total_owed}}<br />
{{patron.money_summary.total_billed}}<br />
{{patron.expire_date}}<br />
{{patron.alias}}<br />
{{patron.has_email}}<br />
{{patron.has_phone}}<br />

and I can confirm that the receipt does not print anything for those variables in Bills, Current.

3.0.9

[John Amundson (jamundson)]

Blake, the patron fields should have been added to bills, current and bills, historical in Evergreen 3.0.9, per bug 1772444. I do not have 3.0.9 installed so I cannot confirm this, but I did test an earlier version of the patch, and the fields did indeed print with the syntax {{patron.first_given_name}}, etc.

I do not believe that money_summary was added, however.

[Dan Pearl (dpearl)]

It is my intention to address these items on a piecemeal basis.

[Lindsay Stratton (lstratton)]

Updated the sheet to add: Hold Shelf Slip should include Hold Note data. I am using 3.3.2.

[Jason Stephenson (jstephenson)]

Dan Pearl had some code to address some of these issues. We'll review it at CW MARS and see what remains to be done.

[Jason Stephenson (jstephenson)]

I have reviewed Daniel Pearl's code and do not think it is correct. I have not actually tried running it.

I did make a cleanup branch that fixes some obvious syntax and whitespace errors. I am going to add the link to the branch here so that there is a reference to it:

https://git.evergreen-ils.org/?p=working/Evergreen.git;a=shortlog;h=refs/heads/collab/dyrcona/LP1772053_receipt_cleanup

[Jason Stephenson (jstephenson)]

Related bugs, possibly some duplicates of this one:

bug 1820741
bug 1821047
bug 1821399
bug 1822836
bug 1822869
bug 1823071
bug 1823197

Dan Pearl also had code for these. There seems to be some overlap with the code for these bugs and the branch mentioned in comment #9.

I have made a collab branch with the cleanup of this code. I have not tested it, yet.

https://git.evergreen-ils.org/?p=working/Evergreen.git;a=shortlog;h=refs/heads/collab/dyrcona/lp1820741-receipt-omnibus

Dan Pearl did signoff on his original code, but he could not possibly have tested it, since his code contained syntax errors.

[Jason Stephenson (jstephenson)]

Here is a cleaned up branch of code that Daniel Pearl left behind at CW MARS that is supposed to resolve this bug. I'm sharing it here with the pullrequest tag in the hope that someone will test it for bug squashing week.

https://git.evergreen-ils.org/?p=working/Evergreen.git;a=shortlog;h=refs/heads/collab/dyrcona/LP1772053_receipt_cleanup

[Terran McCanna (tmccanna)]

A few of the bugs linked in the comment #1 are still open, but many of the others have already been fixed, and the omnibus fix in comment #11 resolves most of the rest of them, so I'm going to go ahead and sign off on this omnibus bug and the other linked bugs that are fixed with the omnibus.

My sign off for Dan's & Jason's work at:
https://git.evergreen-ils.org/?p=working/Evergreen.git;a=shortlog;h=refs/heads/user/mccanna/LP1772053_receipt_cleanup_signoff

[Chris Sharp (chrissharp123)]

Fixes pushed to master and rel_3_5. Thanks Dan, Jason, and Terran!