Bug 29816 - Document patron emailer cronjob
Summary: Document patron emailer cronjob
Status: Needs documenting
Alias: None
Product: Koha
Classification: Unclassified
Component: Documentation (show other bugs)
Version: Main
Hardware: All All
: P5 - low enhancement (vote)
Assignee: Bugs List
QA Contact: Testopia
URL:
Keywords:
Depends on:
Blocks:
 
Reported: 2022-01-07 07:48 UTC by Magnus Enger
Modified: 2023-12-07 09:30 UTC (History)
1 user (show)

See Also:
Change sponsored?: ---
Patch complexity: ---
Documentation contact:
Documentation submission:
Text to go in the release notes:
Version(s) released in:


Attachments

Note You need to log in before you can comment on or make changes to this bug.
Description Magnus Enger 2022-01-07 07:48:14 UTC
misc/cronjobs/patron_emailer.pl was introduced by Bug 16149, but as far as I can tell it is not documented in the manual. Sorry if I missed it. 

I'd say documenting this is extra important, since it is a cool feature that is not visible from the Koha GUI (but see also Bug 27452.)
Comment 1 Ray Delahunty 2023-11-03 10:20:49 UTC
I'll have a go at drafting something out and run it by our support company- I've not done any documentation work in Koha, so I am a newbie. I just love the patron emailer functionality and we are using it a lot, with more uses to come. But I am struggling a bit with the lack of html / TT support that I have rasied in Bug 27443.
Comment 2 Katrin Fischer 2023-11-04 13:32:56 UTC
Hi Ray, 

have you unsuccessfully tried to mark the notice template used as HTML? From looking at the cron I don't see why that wouldn't work. It seems to use the standard procedure for creating emails.

The patron emailer documentation on ByWater's blog also included some TT - sadly that is no longer accessible. Maybe by TT you think of specific objects or variables?
Comment 3 Ray Delahunty 2023-12-06 07:11:39 UTC
Apologies- on 22.11 I have notices being sent by the patron_emailer.pl script working perfectly with html, and the fields pulled in from the report must use TT notation so html and at least some TT is supported. All I can assume from earlier failures (ages back) must be down to specific objects/ variables that either aren’t fully supported (or more likely!) I had syntax errors in my TT code.
Comment 4 Katrin Fischer 2023-12-07 09:30:21 UTC
(In reply to Ray Delahunty from comment #3)
> Apologies- on 22.11 I have notices being sent by the patron_emailer.pl
> script working perfectly with html, and the fields pulled in from the report
> must use TT notation so html and at least some TT is supported. All I can
> assume from earlier failures (ages back) must be down to specific objects/
> variables that either aren’t fully supported (or more likely!) I had syntax
> errors in my TT code.

Thanks for the feedback!

I think it would be worthwhile to have better documentation especially with some no longer available for the plugin.