| Summary: | Runtime parameters don't work with report templates on first run | ||
|---|---|---|---|
| Product: | Koha | Reporter: | David Cook <dcook> |
| Component: | Reports | Assignee: | David Cook <dcook> |
| Status: | Needs documenting --- | QA Contact: | Julian Maurice <julian.maurice> |
| Severity: | normal | ||
| Priority: | P5 - low | CC: | david, fridolin.somers, julian.maurice |
| Version: | Main | ||
| Hardware: | All | ||
| OS: | All | ||
| GIT URL: | Initiative type: | --- | |
| Sponsorship status: | --- | Comma delimited list of Sponsors: | |
| Crowdfunding goal: | 0 | Patch complexity: | --- |
| Documentation contact: | Documentation submission: | ||
| Text to go in the release notes: | Version(s) released in: |
25.05.00,24.11.08
|
|
| Circulation function: | |||
| Attachments: |
Bug 39298: Add runtime parameter support to report templates
Bug 39298: Add runtime parameter support to report templates Bug 39298: Add runtime parameter support to report templates Bug 39298: (QA follow-up) Add missing html filter |
||
|
Description
David Cook
2025-03-11 04:48:49 UTC
Created attachment 179136 [details] [review] Bug 39298: Add runtime parameter support to report templates This change makes it so that you can provide runtime parameters and use "Run with template". Test plan: 0. Apply the patch and koha-plack --restart kohadev 1. Create a report template. For example: <table> <tr><th>Transformed Biblionumber</th></tr> [% FOREACH row IN data %] <tr><td>Biblionumber [% row.biblionumber %]</td></tr> [% END %] </table> 2. Create a SQL report with a runtime parameter. For example: SELECT biblionumber FROM biblio WHERE biblionumber > <<biblionumber>> 3. Run the report using "Run with template" 4. Specify a biblionumber of 1 5. Click "Run the report" 6. Note that the output is the template output and not regular SQL output Created attachment 179145 [details] [review] Bug 39298: Add runtime parameter support to report templates This change makes it so that you can provide runtime parameters and use "Run with template". Test plan: 0. Apply the patch and koha-plack --restart kohadev 1. Create a report template. For example: <table> <tr><th>Transformed Biblionumber</th></tr> [% FOREACH row IN data %] <tr><td>Biblionumber [% row.biblionumber %]</td></tr> [% END %] </table> 2. Create a SQL report with a runtime parameter. For example: SELECT biblionumber FROM biblio WHERE biblionumber > <<biblionumber>> 3. Run the report using "Run with template" 4. Specify a biblionumber of 1 5. Click "Run the report" 6. Note that the output is the template output and not regular SQL output Signed-off-by: David Nind <david@davidnind.com> Testing notes (using KTD) - replicating the issue before applying the patch: 1. The first time you run the report using the report template option, it will look like a normal report result - with standard pagination and a column with just the biblionumber. 2. If you then go "Run with template" again, you will then get your customised output, in this case a table with all the results formatted using the template: a table heading called "Transformed Biblionumber" and then rows with "Biblionumber X" (where X = a number). Created attachment 180354 [details] [review] Bug 39298: Add runtime parameter support to report templates This change makes it so that you can provide runtime parameters and use "Run with template". Test plan: 0. Apply the patch and koha-plack --restart kohadev 1. Create a report template. For example: <table> <tr><th>Transformed Biblionumber</th></tr> [% FOREACH row IN data %] <tr><td>Biblionumber [% row.biblionumber %]</td></tr> [% END %] </table> 2. Create a SQL report with a runtime parameter. For example: SELECT biblionumber FROM biblio WHERE biblionumber > <<biblionumber>> 3. Run the report using "Run with template" 4. Specify a biblionumber of 1 5. Click "Run the report" 6. Note that the output is the template output and not regular SQL output Signed-off-by: David Nind <david@davidnind.com> Signed-off-by: Julian Maurice <julian.maurice@biblibre.com> Created attachment 180355 [details] [review] Bug 39298: (QA follow-up) Add missing html filter Signed-off-by: Julian Maurice <julian.maurice@biblibre.com> I didn't know about the report template feature, so for future references: report templates are created with the "Notices & slips" tool. (In reply to Julian Maurice from comment #6) > I didn't know about the report template feature, so for future references: > report templates are created with the "Notices & slips" tool. I only learned about it recently myself. It managed to sneak into Koha without too much advertisement I think. A scary feature in a number of ways, but also quite interesting. Using bug 39296 a person can use the entire MARC record for generating reports. Pushed for 25.05! Well done everyone, thank you! Pushed to 24.11.x for 24.11.08 Not backporting to 22.11.x as it wasn't backported to 24.05.x |