Enhancing Koha s Public Reports Feature

Transcription

1 Enhancing Koha s Public Reports Feature A presentation to the Koha-Oz User Group Melbourne Athenaeum 18 August 2016 Bob Birchall / Chris Vella

2 Reports in Koha can be made public FROM THE Koha MANUAL: Report is public' should be left to the default of 'No' in most cases. A report can be made public if you intend to allow access to it through the JSON webservice interface. This is a system that can be used by developers to make custom presentations of the data from the report, for example displaying it using a graphing API. To learn more speak to your local developer. A public report is accessible via a URL that looks like this:

3

4 So what? So you can add the URL of a report as a link in your OPAC! Sure, you can just use a List, but there are advantages to using a Public report. Report on anything in Koha. In Koha, if you can name it, you can report on it.

5 Creating a report... Create a report in the Koha reports module. In the example, we want to make a list of the e-journals held by the library available on the OPAC home page. Make the report public.

6

7 Now you can add that as a link to your OPAC: We do that in the staff client. And with a little HTML we can make the link a nice button. In the system preference opacmainuserblock, add an HTML link to your report: <!-- Button to trigger modal --> <a href="#ejournals" role="button" class="btn" data-toggle="modal">click to view E-Journals</a>

8

9 then set up the report display format: Some more HTML will provide attractive styling to the report: <!-- Modal <div id="ejournals" class="modal hide fade" tabindex="-1" role="dialog" aria-labelledby="ejournallabel" aria-hidden="true"> <div class="modal-header"> <button id="modal_close" type="button" class="close" data-dismiss="modal" aria-hidden="true"> </button> <h3 id="ejournallabel">e-journals</h3> <div id="list_logo"><center><img src=" </div> <div class="modal-body"> <table id="custom_table" class="table table-hover table-bordered"> <thead> <tr> <th>id</th> <th>title</th> <th>availability (Print and Online)</th> <th>online Access</th> </tr> </thead> <tbody> </tbody> </table> </div> <div class="modal-footer"> <button class="btn" data-dismiss="modal" aria-hidden="true">close</button> </div> </div>

10 But to make it run, we also need some JQuery: Again in the staff client, add the JQuery on the next slide to your opacuserjs system preference. This calls the report. You can see (in the third line) that it s calling Report #4. It then extracts the JSON output and places it into rows and columns. Next we can add some nice functionality to the report: Open the catalogue record by clicking on the biblio number; Make the link to the e-journal clickable and to open in a new tab; and Make each column sortable.

11 Here s our custom JQuery: $(document).ready(function() { var data1; $.get( "/cgi-bin/koha/svc/report?id=4", function( data1 ) { $.each(data1, function(index, value) { // json is a record arr var json = value; var tr; tr = $('<tr/>'); $.each(json, function(index, value) { tr.append("<td>" + value + "</td>"); }); $('#custom_table').append(tr); // alert( index + ": " + value ); }); $("#custom_table").tablesorter(); $("#custom_table td:nth-child(1)").each(function(index, element){ $(element).wrapinner('<a href="/cgi-bin/koha/opac-detail.pl?biblionumber='+$(element).text()+'" target="_blank"></a>'); }); $("#custom_table td:nth-child(4)").each(function(index, element){ $(element).wrapinner('<a href="'+$(element).text()+'" target="_blank"></a>'); }); }); }); // Custom list script In addition you also need to add the JQuery plug-in Tablesorter 2.0 from

12

13 In summary: Make a custom report which is public. Use HTML in opacmainuserblock to: a. b. 3. Make an attractive button to call the link; and Set up the appearance of the report. Use JQuery in opacuserjs to call the report and add some nice functionality.

14 Why not just use a list? Because a public report has quite a few advantages: Supports large numbers of items (with a scrolling bar); Easier to maintain (changes to the catalogue are picked up automatically); Add or delete columns - just modify the report; Sort dynamically on any column; Automatically updated regularly. Lists still have their place, but where there are a large number of items or the content is dynamic, a public report might serve you better. For more Koha tips, join the Koha-oz mailing list Calyx: enquiries@calyx.net.au or subscribe to our newsletter: