From e001fba5461c9c8c694e0d6e3aa310ab83ca19f8 Mon Sep 17 00:00:00 2001 From: Nicole C. Engard Date: Sat, 30 Mar 2013 10:14:06 -0400 Subject: [PATCH] Bug 9850: Update Reports Help for 3.12 This updates the reports help for Koha 3.12. To test: Visit all reports pages and review the help for textual changes and correct links. --- .../en/modules/help/reports/acquisitions_stats.tt | 4 +- .../prog/en/modules/help/reports/bor_issues_top.tt | 4 +- .../prog/en/modules/help/reports/borrowers_out.tt | 4 +- .../en/modules/help/reports/borrowers_stats.tt | 4 +- .../prog/en/modules/help/reports/cat_issues_top.tt | 4 +- .../prog/en/modules/help/reports/catalogue_out.tt | 4 +- .../en/modules/help/reports/catalogue_stats.tt | 4 +- .../prog/en/modules/help/reports/dictionary.tt | 4 +- .../prog/en/modules/help/reports/guided_reports.tt | 204 ++++++++++++++------ .../en/modules/help/reports/issues_avg_stats.tt | 4 +- .../prog/en/modules/help/reports/issues_stats.tt | 4 +- .../prog/en/modules/help/reports/itemslost.tt | 4 +- .../prog/en/modules/help/reports/manager.tt | 4 +- .../prog/en/modules/help/reports/reports-home.tt | 2 +- .../prog/en/modules/help/reports/reserves_stats.tt | 4 +- .../prog/en/modules/help/reports/serials_stats.tt | 4 +- 16 files changed, 177 insertions(+), 85 deletions(-) diff --git a/koha-tmpl/intranet-tmpl/prog/en/modules/help/reports/acquisitions_stats.tt b/koha-tmpl/intranet-tmpl/prog/en/modules/help/reports/acquisitions_stats.tt index bc4b01e..499e597 100644 --- a/koha-tmpl/intranet-tmpl/prog/en/modules/help/reports/acquisitions_stats.tt +++ b/koha-tmpl/intranet-tmpl/prog/en/modules/help/reports/acquisitions_stats.tt @@ -1,6 +1,6 @@ [% INCLUDE 'help-top.inc' %] -

Acquisitions Statistics

+

Acquisitions statistics

Using the form provided, choose which value you would like to appear in the Column and which will appear in the Row.

@@ -12,6 +12,6 @@

Choosing amount will change your results to appear as the sum of the amounts spent.

-

See the full documentation for Acquisitions Statistics in the manual (online).

+

See the full documentation for Acquisitions Statistics in the manual (online).

[% INCLUDE 'help-bottom.inc' %] \ No newline at end of file diff --git a/koha-tmpl/intranet-tmpl/prog/en/modules/help/reports/bor_issues_top.tt b/koha-tmpl/intranet-tmpl/prog/en/modules/help/reports/bor_issues_top.tt index 080a16d..717c5cb 100644 --- a/koha-tmpl/intranet-tmpl/prog/en/modules/help/reports/bor_issues_top.tt +++ b/koha-tmpl/intranet-tmpl/prog/en/modules/help/reports/bor_issues_top.tt @@ -1,6 +1,6 @@ [% INCLUDE 'help-top.inc' %] -

Patrons With The Most Checkouts

+

Patrons with the most checkouts

This report will simply list the patrons who have the most checkouts.

@@ -8,6 +8,6 @@

You can also choose to export to a file that you can manipulate to your needs.

-

See the full documentation for the Patrons with the most Checkouts report in the manual (online).

+

See the full documentation for the Patrons with the most Checkouts report in the manual (online).

[% INCLUDE 'help-bottom.inc' %] \ No newline at end of file diff --git a/koha-tmpl/intranet-tmpl/prog/en/modules/help/reports/borrowers_out.tt b/koha-tmpl/intranet-tmpl/prog/en/modules/help/reports/borrowers_out.tt index 40f369f..e9032c8 100644 --- a/koha-tmpl/intranet-tmpl/prog/en/modules/help/reports/borrowers_out.tt +++ b/koha-tmpl/intranet-tmpl/prog/en/modules/help/reports/borrowers_out.tt @@ -1,6 +1,6 @@ [% INCLUDE 'help-top.inc' %] -

Patrons With No Checkouts

+

Patrons with no checkouts

This report will list for you the patrons in your system who haven't checked any items out.

@@ -8,6 +8,6 @@

You can also choose to export to a file that you can manipulate to your needs.

-

See the full documentation for the Patrons with no Checkouts report in the manual (online).

+

See the full documentation for the Patrons with no Checkouts report in the manual (online).

[% INCLUDE 'help-bottom.inc' %] \ No newline at end of file diff --git a/koha-tmpl/intranet-tmpl/prog/en/modules/help/reports/borrowers_stats.tt b/koha-tmpl/intranet-tmpl/prog/en/modules/help/reports/borrowers_stats.tt index 310e952..36309c0 100644 --- a/koha-tmpl/intranet-tmpl/prog/en/modules/help/reports/borrowers_stats.tt +++ b/koha-tmpl/intranet-tmpl/prog/en/modules/help/reports/borrowers_stats.tt @@ -1,6 +1,6 @@ [% INCLUDE 'help-top.inc' %] -

Patron Statistics

+

Patron statistics

Using the form provided, choose which value you would like to appear in the Column and which will appear in the Row.

@@ -8,7 +8,7 @@

Based on your selections, you may see some query information above your results table. You can also choose to export to a file that you can manipulate to your needs.

-

See the full documentation for Patron Statistics in the manual (online).

+

See the full documentation for Patron Statistics in the manual (online).

[% INCLUDE 'help-bottom.inc' %] diff --git a/koha-tmpl/intranet-tmpl/prog/en/modules/help/reports/cat_issues_top.tt b/koha-tmpl/intranet-tmpl/prog/en/modules/help/reports/cat_issues_top.tt index cf615e9..ab569e3 100644 --- a/koha-tmpl/intranet-tmpl/prog/en/modules/help/reports/cat_issues_top.tt +++ b/koha-tmpl/intranet-tmpl/prog/en/modules/help/reports/cat_issues_top.tt @@ -1,6 +1,6 @@ [% INCLUDE 'help-top.inc' %] -

Most Circulated Items

+

Most circulated items

This report will simply list the items that have the been checked out the most.

@@ -8,6 +8,6 @@

You can also choose to export to a file that you can manipulate to your needs.

-

See the full documentation for the Most Circulation Items report in the manual (online).

+

See the full documentation for the Most Circulation Items report in the manual (online).

[% INCLUDE 'help-bottom.inc' %] \ No newline at end of file diff --git a/koha-tmpl/intranet-tmpl/prog/en/modules/help/reports/catalogue_out.tt b/koha-tmpl/intranet-tmpl/prog/en/modules/help/reports/catalogue_out.tt index 93e70a7..31f71b8 100644 --- a/koha-tmpl/intranet-tmpl/prog/en/modules/help/reports/catalogue_out.tt +++ b/koha-tmpl/intranet-tmpl/prog/en/modules/help/reports/catalogue_out.tt @@ -1,6 +1,6 @@ [% INCLUDE 'help-top.inc' %] -

Items With No Checkouts

+

Items with no checkouts

This report will list items in your collection that have never been checked out.

@@ -8,6 +8,6 @@

You can also choose to export to a file that you can manipulate to your needs.

-

See the full documentation for the Items with no Checkouts report in the manual (online).

+

See the full documentation for the Items with no Checkouts report in the manual (online).

[% INCLUDE 'help-bottom.inc' %] \ No newline at end of file diff --git a/koha-tmpl/intranet-tmpl/prog/en/modules/help/reports/catalogue_stats.tt b/koha-tmpl/intranet-tmpl/prog/en/modules/help/reports/catalogue_stats.tt index 3a54696..9678d20 100644 --- a/koha-tmpl/intranet-tmpl/prog/en/modules/help/reports/catalogue_stats.tt +++ b/koha-tmpl/intranet-tmpl/prog/en/modules/help/reports/catalogue_stats.tt @@ -1,6 +1,6 @@ [% INCLUDE 'help-top.inc' %] -

Catalog Statistics

+

Catalog statistics

Using the form provided, choose which value you would like to appear in the Column and which will appear in the Row.

@@ -8,7 +8,7 @@

You can also choose to export to a file that you can manipulate to your needs.

-

See the full documentation for Catalog Statistics in the manual (online).

+

See the full documentation for Catalog Statistics in the manual (online).

[% INCLUDE 'help-bottom.inc' %] diff --git a/koha-tmpl/intranet-tmpl/prog/en/modules/help/reports/dictionary.tt b/koha-tmpl/intranet-tmpl/prog/en/modules/help/reports/dictionary.tt index 191e437..cdaf397 100644 --- a/koha-tmpl/intranet-tmpl/prog/en/modules/help/reports/dictionary.tt +++ b/koha-tmpl/intranet-tmpl/prog/en/modules/help/reports/dictionary.tt @@ -1,6 +1,6 @@ [% INCLUDE 'help-top.inc' %] -

Reports Dictionary

+

Reports dictionary

The report dictionary is a way to pre-define common filters you'd like to apply to your reports. This is a good way to add in filters that the report wizard doesn't include by default. To add a new definition, or filter, click 'New Definition' on the Reports Dictionary page and follow the 4 step process.

@@ -18,6 +18,6 @@

Then when generating reports on the module you created the value for you will see an option to limit by the definition at the bottom of the usual filters.

-

See the full documentation for the Reports Dictionary in the manual (online).

+

See the full documentation for the Reports Dictionary in the manual (online).

[% INCLUDE 'help-bottom.inc' %] \ No newline at end of file diff --git a/koha-tmpl/intranet-tmpl/prog/en/modules/help/reports/guided_reports.tt b/koha-tmpl/intranet-tmpl/prog/en/modules/help/reports/guided_reports.tt index 33f46c6..c138ecf 100644 --- a/koha-tmpl/intranet-tmpl/prog/en/modules/help/reports/guided_reports.tt +++ b/koha-tmpl/intranet-tmpl/prog/en/modules/help/reports/guided_reports.tt @@ -1,103 +1,195 @@ [% INCLUDE 'help-top.inc' %] -

Add a Custom Report

+

Add a custom report

-

Guided Report Wizard

+

Guided report wizard

-

If the report you need is not already available, the 'Guided Reports' Wizard will walk you through creating a custom report.

+

The guided report wizard will walk you through a six step process to generate a report.

+

Step 1: Choose the module you want to report on. This will determine what tables and fields are available for you to query.

+ +

'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.

+

Step 2: Choose a report type. For now, Tabular is the only option available.

+ +

Step 3: Choose the fields you want in your report. You can select multiple fields and add them all at once by using CTRL+Click on each item you want to add before clicking the Add button.

+ +

Step 4: Choose any limits you might want to apply to your report (such as item types or branches). If you don't want to apply any limits, simply click Next instead of making an option.

+ +

Step 5: Perform math functions. If you don't want to do any calculations, simply click Next instead of making an option.

+ +

Step 6: Choose data order. If you want the data to print out in the order it's found in the database, simply click Finish.

+ +

When you are finished you will be presented with the SQL generated by the report wizard. From here you can choose to save the report by clicking 'Save' or copy the SQL and make edits to it by hand.

-

Answer the 6 questions presented in order to create your report.

+

If you choose to save the report you will be asked to name your report, sort it in to groups and subgroups and enter any notes regarding it.

-

Step 1: Choose a Module to Report on

+

Once your report is saved it will appear on the 'Use Saved' page with all other saved reports.

+

From here you can make edits, run the report, or schedule a time to have the report run. To find the report you created you can sort by any of the columns by clicking the on the column header (creation date is the best bet for finding the report you just added). You can also filter your results using the filter menu on the left or use the tabs to find reports based on your custom groups.

+ +

Report from SQL

+ +

In addition to the report wizard, you have the option to write your own queries using SQL. To find reports written by other Koha users, visit the Koha Wiki: http://wiki.koha-community.org/wiki/SQL_Reports_Library. You can also find your database structure in /installer/data/mysql/kohastructure.sql or online at: http://schema.koha-community.org.

+ +

To add your query, click the link to 'Create from SQL' on the main reports module or the 'New report' button at the top of the 'Saved reports' page.

+ +

Fill in the form presented

+ + +

Note: There is a limit of 10,000 records put on SQL statements entered in Koha. To get around this you want to add 'LIMIT 100000' to the end of your SQL statement (or any other number above 10,000.

+ +

Once everything is entered click the 'Save Report' button and you'll be presented with options to run it. Once a report is saved you do not have to recreate it you can simply find it on the Saved Reports page and run or edit it.

+ +

Duplicate Report

+ +

Reports can also be added by duplicating an existing report. Visit the 'Saved reports' page to see all of the reports listed on your system already.

+ +

To the right of every report there is a 'Duplicate' link in the 'Saved SQL' column. Click that 'Duplicate' link to use an existing report as the basis for your new report. That will populate the new report form with the existing SQL for easy editing and resaving.

-

Step 2: Pick a Report Type

+

Edit Custom Reports

- +

Every report can be edited from the reports lists. To see the list of reports already stored in Koha, click 'Use Saved.'

-

Step 3: Select Columns for Display

+

To find the report you'd like to edit you can sort by any of the columns by clicking the on the column header. You can also filter your results using the filter menu on the left or use the tabs to find reports based on your custom groups.

-

Step 4: Select Criteria to Limit

+

From this list you can edit any custom report by clicking 'Edit' in the 'Saved SQL' column.

- +

Running Custom Reports

-

Step 5: Pick which columns to perform mathmatical functions on

+

Once custom reports are saved to Koha, you can run them by going to the Saved Reports page and clicking the 'Run' link to the right of the report.

- +

When you report runs you will either be asked for some value or you will see the results right away

-

Step 6: Choose how you want the report ordered

+

From the results you can choose to rerun the report by clicking 'Run report' at the top, edit the report by clicking the 'Edit' button or starting over and creating a new report by using the 'New' button. You can also download your results by choosing a file type at the bottom of the results next to the 'Download the report' label and clicking 'Download.'

- +

Tip: A Comma Separated Text file is a CSV file and it can be opened by any spreadsheet application.

-

Edit Reports

+

DB table value for reports

-

Custom reports can be edited in their entirety from the Saved Guided Reports page.

+

Question: What do the codes in the accounttype field in the accountlines table stand for?

- +

Answer:

-

Report from SQL

+

Question: What are the possible codes for the type field in the statistics table?

-

In addition to the report wizard, you have the option to write your own queries using SQL. To find reports written by other Koha users, visit the Koha Wiki: http://wiki.koha-community.org/wiki/SQL_Reports_Library. You can also find your database structure in /installer/data/mysql/kohastructure.sql or online at: http://schema.koha-community.org.

+

Answer:

-

To add your query, click the link to 'Create from SQL' on the main reports module or the New button at the top of the Saved Reports page.

- -

Fill in the form presented

+ +

Question: What are the possible codes for the found field in the reserves and old_reserves tables?

+ +

Answer:

+ - -
  • Tip: To generate a date picker calendar to the right of the field when running a report you can use the 'date' keyword like this: <<Enter Date|date>>
  • -
  • Tip: You have to put "%" in a text box to 'leave it blank'. Otherwise, it literally looks for "" (empty string) as the value for the field.
  • -
  • Important: In addition to using any authorized value code to generate a dropdown, you can use the following values as well: Libraries (branches), Item Types (itemtypes) and Patron Categories (categorycode). For example a library pull down would be generated like this <<Library|branches>>
  • + +

    Question: What are the possible codes for the area field in the reports_dictionary table?

    + +

    Answer:

    + + -

    Note: There is a limit of 10,000 records put on SQL statements entered in Koha. To get around this you want to add 'LIMIT 100000' to the end of your SQL statement (or any other number above 10,000.

    +

    Question: What are the possible codes for the message_type field in the messages table?

    -

    Once everything is entered click the 'Save Report' button and you'll be presented with options to run it. Once a report is saved you do not have to recreate it you can simply find it on the Saved Reports page and run or edit it.

    +

    Answer:

    + + -

    Is there a repository for reports?

    +

    Question: What are the possible codes for the status field in the serial table"?

    -

    There is a page on the Koha Wiki: http://wiki.koha-community.org/wiki/SQL_Reports_Library with reports written by Koha libraries around the world.

    +

    Answer:

    -

    NEKLS also has a great page (http://www.nexpresslibrary.org/training/reports-training/) with a list of reports they have written.

    +

    See the full documentation for Custom Reports in the manual (online).

    diff --git a/koha-tmpl/intranet-tmpl/prog/en/modules/help/reports/issues_avg_stats.tt b/koha-tmpl/intranet-tmpl/prog/en/modules/help/reports/issues_avg_stats.tt index 16c025b..479e9a3 100644 --- a/koha-tmpl/intranet-tmpl/prog/en/modules/help/reports/issues_avg_stats.tt +++ b/koha-tmpl/intranet-tmpl/prog/en/modules/help/reports/issues_avg_stats.tt @@ -1,6 +1,6 @@ [% INCLUDE 'help-top.inc' %] -

    Average Loan Time

    +

    Average loan time

    This report will list the average time items are out on loan based on the criteria you enter

    @@ -8,6 +8,6 @@

    You can also choose to export to a file that you can manipulate to your needs.

    -

    See the full documentation for the Average Loan Time report in the manual (online).

    +

    See the full documentation for the Average Loan Time report in the manual (online).

    [% INCLUDE 'help-bottom.inc' %] \ No newline at end of file diff --git a/koha-tmpl/intranet-tmpl/prog/en/modules/help/reports/issues_stats.tt b/koha-tmpl/intranet-tmpl/prog/en/modules/help/reports/issues_stats.tt index 6117f00..068bff8 100644 --- a/koha-tmpl/intranet-tmpl/prog/en/modules/help/reports/issues_stats.tt +++ b/koha-tmpl/intranet-tmpl/prog/en/modules/help/reports/issues_stats.tt @@ -1,6 +1,6 @@ [% INCLUDE 'help-top.inc' %] -

    Circulation Statistics

    +

    Circulation statistics

    Using the form provided, choose which value you would like to appear in the Column and which will appear in the Row.

    @@ -19,6 +19,6 @@
  • For a single day, an example would be: 11/15/2009 to 11/16/2009 to find what circulated on the 15th
  • -

    See the full documentation for Circulation Statistics in the manual (online).

    +

    See the full documentation for Circulation Statistics in the manual (online).

    [% INCLUDE 'help-bottom.inc' %] diff --git a/koha-tmpl/intranet-tmpl/prog/en/modules/help/reports/itemslost.tt b/koha-tmpl/intranet-tmpl/prog/en/modules/help/reports/itemslost.tt index 5d48ded..4e33125 100644 --- a/koha-tmpl/intranet-tmpl/prog/en/modules/help/reports/itemslost.tt +++ b/koha-tmpl/intranet-tmpl/prog/en/modules/help/reports/itemslost.tt @@ -1,6 +1,6 @@ [% INCLUDE 'help-top.inc' %] -

    Lost Items

    +

    Lost items

    This one-step report will show you how many items of each item type are currently in your library or libraries.

    @@ -16,6 +16,6 @@ -

    See the full documentation for the Lost Items report in the manual (online).

    +

    See the full documentation for the Lost Items report in the manual (online).

    [% INCLUDE 'help-bottom.inc' %] diff --git a/koha-tmpl/intranet-tmpl/prog/en/modules/help/reports/manager.tt b/koha-tmpl/intranet-tmpl/prog/en/modules/help/reports/manager.tt index a9f3c02..3dd9ca2 100644 --- a/koha-tmpl/intranet-tmpl/prog/en/modules/help/reports/manager.tt +++ b/koha-tmpl/intranet-tmpl/prog/en/modules/help/reports/manager.tt @@ -1,6 +1,6 @@ [% INCLUDE 'help-top.inc' %] -

    Catalog by Item Type

    +

    Catalog by item type

    This report will list the total number of items of each item type per library.

    @@ -8,6 +8,6 @@

    You can also choose to export to a file that you can manipulate to your needs.

    -

    See the full documentation for the Catalog by Item Type report in the manual (online).

    +

    See the full documentation for the Catalog by Item Type report in the manual (online).

    [% INCLUDE 'help-bottom.inc' %] diff --git a/koha-tmpl/intranet-tmpl/prog/en/modules/help/reports/reports-home.tt b/koha-tmpl/intranet-tmpl/prog/en/modules/help/reports/reports-home.tt index c64c1a0..c7914cf 100644 --- a/koha-tmpl/intranet-tmpl/prog/en/modules/help/reports/reports-home.tt +++ b/koha-tmpl/intranet-tmpl/prog/en/modules/help/reports/reports-home.tt @@ -19,6 +19,6 @@ -

    See the full documentation for Reports in the manual (online).

    +

    See the full documentation for Reports in the manual (online).

    [% INCLUDE 'help-bottom.inc' %] \ No newline at end of file diff --git a/koha-tmpl/intranet-tmpl/prog/en/modules/help/reports/reserves_stats.tt b/koha-tmpl/intranet-tmpl/prog/en/modules/help/reports/reserves_stats.tt index 463f441..91bda83 100644 --- a/koha-tmpl/intranet-tmpl/prog/en/modules/help/reports/reserves_stats.tt +++ b/koha-tmpl/intranet-tmpl/prog/en/modules/help/reports/reserves_stats.tt @@ -1,6 +1,6 @@ [% INCLUDE 'help-top.inc' %] -

    Holds Statistics

    +

    Holds statistics

    Note: These reports are limited in what data they can look at, so it's often recommended to use custom reports for official end of the year statistics.

    @@ -10,6 +10,6 @@

    You can also choose to export to a file that you can manipulate to your needs.

    -

    See the full documentation for Holds Statistics in the manual (online).

    +

    See the full documentation for Holds Statistics in the manual (online).

    [% INCLUDE 'help-bottom.inc' %] \ No newline at end of file diff --git a/koha-tmpl/intranet-tmpl/prog/en/modules/help/reports/serials_stats.tt b/koha-tmpl/intranet-tmpl/prog/en/modules/help/reports/serials_stats.tt index dcb7d4b..1519f0d 100644 --- a/koha-tmpl/intranet-tmpl/prog/en/modules/help/reports/serials_stats.tt +++ b/koha-tmpl/intranet-tmpl/prog/en/modules/help/reports/serials_stats.tt @@ -1,6 +1,6 @@ [% INCLUDE 'help-top.inc' %] -

    Serials Statistics

    +

    Serials statistics

    Using the form provided, choose how you would like to list the serials in your system.

    @@ -8,6 +8,6 @@

    You can also choose to export to a file that you can manipulate to your needs.

    -

    See the full documentation for Serials Statistics in the manual (online).

    +

    See the full documentation for Serials Statistics in the manual (online).

    [% INCLUDE 'help-bottom.inc' %] \ No newline at end of file -- 1.7.2.3