From f893e2a5fbd5f9c4cb1e459f0a8f9a53cb9aa57b Mon Sep 17 00:00:00 2001 From: "Nicole C. Engard" Date: Fri, 19 Oct 2012 14:01:13 -0400 Subject: [PATCH] Bug 8945: Reports Help Files This patch updates the reports help files for 3.10. Signed-off-by: Jared Camins-Esakov Signed-off-by: Paul Poulain --- .../help/reports/acquisitions_stats.tt | 2 +- .../en/modules/help/reports/bor_issues_top.tt | 2 +- .../en/modules/help/reports/borrowers_out.tt | 2 +- .../modules/help/reports/borrowers_stats.tt | 2 +- .../en/modules/help/reports/cat_issues_top.tt | 2 +- .../en/modules/help/reports/catalogue_out.tt | 2 +- .../modules/help/reports/catalogue_stats.tt | 2 +- .../en/modules/help/reports/dictionary.tt | 2 +- .../en/modules/help/reports/guided_reports.tt | 55 +++++++++---------- .../modules/help/reports/issues_avg_stats.tt | 2 +- .../en/modules/help/reports/issues_stats.tt | 2 +- .../prog/en/modules/help/reports/itemslost.tt | 2 +- .../prog/en/modules/help/reports/manager.tt | 2 +- .../en/modules/help/reports/reports-home.tt | 2 +- .../en/modules/help/reports/reserves_stats.tt | 2 +- .../en/modules/help/reports/serials_stats.tt | 2 +- 16 files changed, 40 insertions(+), 45 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 59d31ca934..bc4b01e6e5 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 @@ -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 2811f378bb..080a16d8b5 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 @@ -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 22c8a8f687..40f369f507 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 @@ -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 f26347fafe..310e952358 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 @@ -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 8dd03cc941..cf615e990d 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 @@ -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 9efdf8fbd9..93e70a7cf1 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 @@ -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 fc346e9dbf..3a54696746 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 @@ -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 18808461a9..191e4379d7 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 @@ -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 1ebcc042c0..7be3885d83 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 @@ -38,7 +38,7 @@
  • This is optional, if you want the results to come out as they are in the table, just leave this section blank.
-

Edit Reports

+

Edit Reports

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

@@ -51,52 +51,47 @@

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.

+

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 button at the top of the Saved Reports page.

Fill in the form presented

    -
  • The name is what will appear on the Saved Reports page to help you identify the report later. It will also be searchable using the filters found the left of the Saved Reports page.
    • -
  • Notes will also appear on the Saved Reports page, this can be used to provide more details about the report or tips on how to enter values when it runs
    • -
  • The type should always be 'Tabular' at this time since the other formats have not been implemented
    • -
  • In the SQL box you will type or paste the SQL for the report
    • -
  • If you feel that your report might be too resource intensive you might want to consider using runtime parameters to your query. Runtime parameters basically make a filter appear before the report is run to save your system resources. +
  • The 'Name' is what will appear on the Saved Reports page to help you identify the report later. It will also be searchable using the filters found the left of the Saved Reports page.
    • +
  • You can use the 'Report group' to organize your reports so that you can easily filter reports by groups. Report groups are set in the REPORT_GROUP authorized value category.
    • +
  • You can use 'Report subgroup' to further organize your reports so that you can easily filter reports by groups and subgroups. Report subgroups are set in the REPORT_SUBGROUP authorized value category.
    • +
  • '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: http://MYOPAC/cgi-bin/koha/svc/report?id=REPORTID
      • +
    +
    • +
  • 'Notes' will also appear on the Saved Reports page, this can be used to provide more details about the report or tips on how to enter values when it runs
    • +
  • The type should always be 'Tabular' at this time since theother formats have not been implemented
    • +
  • In the 'SQL' box you will type or paste the SQL for the report
    • +
  • If you feel that your report might be too resource intensive you might want to consider using runtime parameters to your query. Runtime parameters basically make a filter appear before the report is run to save your system resources.There is a specific syntax that Koha will understand as 'ask for values when running the report'. The syntax is <<Question to ask|authorized_value>>.
      -
    • 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.
      • -
    • There is a specific syntax that Koha will understand as 'ask for values when running the report'. The syntax is <<Question to ask|authorized_value>>.
    • The << and >> are just delimiters. You must put << at the beginning and >> at the end of your parameter
    • The 'Question to ask' will be displayed on the left of the string to enter.
    • The authorized_value can be omitted if not applicable. If it contains an authorized value category, or branches or itemtype or categorycode, a list with the Koha authorized values will be displayed instead of a free field Note that you can have more than one parameter in a given SQL Note that entering nothing at run time won't probably work as you expect. It will be considered as "value empty" not as "ignore this parameter". For example entering nothing for : "title=<<Enter title>>" will display results with title='' (no title). If you want to have to have something not mandatory, use "title like <<Enter title>>" and enter a % at run time instead of nothing
    -

    Examples:

    -
    • SELECT surname, firstname
      - FROM borrowers
      - WHERE branchcode=<<Enter patrons library|branches>> AND surname like <<Enter filter for patron surname (% if none)>>
      • -
    • SELECT *
      - FROM items
      - WHERE homebranch = <<Pick your branch|branches>> and barcode like <<Partial barcode value here (use % for wildcard)>>
      • +FROM borrowers
      +WHERE branchcode=<<Enter patrons library|branches>> AND surname like <<Enter filter for patron surname (% if none)>> +
    • SELECT *
      +FROM items
      +WHERE homebranch = <<Pick your branch|branches>> AND barcode like <<Partial barcode value here>>
    • -
  • 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: Branches (branches), Item Types (itemtypes) and Patron Categories (categorycode). For example a branch pull down would be generated like this <<Branch|branches>>
    • +
  • 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: Branches (branches), Item Types (itemtypes) and Patron Categories (categorycode). For example a branch pull down would be generated like this <<Branch|branches>>
-

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.

- -

Questions

+

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.

-

What are duration and visibility?

-

The duration field may be visible or not, don't worry if you don't see it. If you see it, it says how long a report run is kept in Koha and, any subsequent re-run will in fact display the result run the 1st time

-

The visibility field specify if your report is accessible without authentication from the OPAC. Reports can be retrieved from the following URLs: -

  • opac: http://localhost/cgi-bin/koha/svc/report?id=1
    • -
  • intranet: http://localhost:8080/cgi-bin/koha/svc/report?id=1
    • -
-

(replace localhost and localhost:8080 with the appropriate URLs)

+

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.

Is there a repository for reports?

@@ -104,6 +99,6 @@

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

+

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

[% INCLUDE 'help-bottom.inc' %] 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 09ec95f2ae..16c025bfb9 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 @@ -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 7080f07db9..6117f006b1 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 @@ -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 8ee9408f4e..5d48dedcdf 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 @@ -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 e4fecf1f08..a9f3c02131 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 @@ -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 61cbf54f60..c64c1a0b0a 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 5383afdd7a..463f44114a 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 @@ -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 2dd4c5724d..dcb7d4b33b 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 @@ -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 -- 2.39.5