[Koha-patches] [PATCH] Bug 5940: Reports Help Files
Ian Walls
ian.walls at bywatersolutions.com
Fri Apr 1 19:17:58 CEST 2011
From: Nicole C. Engard <nengard at bywatersolutions.com>
Signed-off-by: Nicole C. Engard <nengard at bywatersolutions.com>
Signed-off-by: Ian Walls <ian.walls at bywatersolutions.com>
---
.../modules/help/reports/acquisitions_stats.tmpl | 20 +++--
.../en/modules/help/reports/bor_issues_top.tmpl | 19 ++---
.../en/modules/help/reports/borrowers_out.tmpl | 18 ++--
.../en/modules/help/reports/borrowers_stats.tmpl | 29 +------
.../en/modules/help/reports/cat_issues_top.tmpl | 20 ++---
.../en/modules/help/reports/catalogue_out.tmpl | 22 ++---
.../en/modules/help/reports/catalogue_stats.tmpl | 26 +-----
.../prog/en/modules/help/reports/dictionary.tmpl | 64 +++-------------
.../en/modules/help/reports/guided_reports.tmpl | 82 +++++++++-----------
.../en/modules/help/reports/issues_avg_stats.tmpl | 15 ++--
.../prog/en/modules/help/reports/issues_stats.tmpl | 44 +++++------
.../prog/en/modules/help/reports/itemslost.tmpl | 14 +---
.../prog/en/modules/help/reports/manager.tmpl | 15 ++--
.../prog/en/modules/help/reports/reports-home.tmpl | 15 ++--
.../en/modules/help/reports/serials_stats.tmpl | 20 +----
15 files changed, 147 insertions(+), 276 deletions(-)
diff --git a/koha-tmpl/intranet-tmpl/prog/en/modules/help/reports/acquisitions_stats.tmpl b/koha-tmpl/intranet-tmpl/prog/en/modules/help/reports/acquisitions_stats.tmpl
index baf4f76..5f6a173 100644
--- a/koha-tmpl/intranet-tmpl/prog/en/modules/help/reports/acquisitions_stats.tmpl
+++ b/koha-tmpl/intranet-tmpl/prog/en/modules/help/reports/acquisitions_stats.tmpl
@@ -2,12 +2,14 @@
<h1>Acquisitions Statistics</h1>
-<p style="color: #990000">IMPORTANT: The Acquisitions 'Wizard' is designed to be a simple statistical snapshot, In each wizard, you will choose a single category to represent 'row' and another to represent 'column'.</p>
- <ul>
- <li>Go to the 'Reports' module (usually under 'More' in your Global Nav)</li>
- <li>Choose 'Acquisitions' under 'Statistics Wizards'</li>
- <li>Enter in the information you'd like to see in your repor</li>
- <li>Click 'Submit'</li>
- <li>By changing the report from 'Count items' to 'Amount' you will see the total spent</li>
- </ul>
- </div> <!-- TMPL_INCLUDE NAME="help-bottom.inc" -->
\ No newline at end of file
+<p>Using the form provided, choose which value you would like to appear in the Column and which will appear in the Row.</p>
+
+<p>If you choose to output to the browser your results will print to the screen.</p>
+
+<p>You can also choose to export to a file that you can manipulate to your needs.</p>
+
+<p>When generating your report, note that you get to choose between counting or summing the values.</p>
+
+<p>Choosing amount will change your results to appear as the sum of the amounts spent.</p>
+
+<!-- TMPL_INCLUDE NAME="help-bottom.inc" -->
\ No newline at end of file
diff --git a/koha-tmpl/intranet-tmpl/prog/en/modules/help/reports/bor_issues_top.tmpl b/koha-tmpl/intranet-tmpl/prog/en/modules/help/reports/bor_issues_top.tmpl
index cde76be..15591be 100644
--- a/koha-tmpl/intranet-tmpl/prog/en/modules/help/reports/bor_issues_top.tmpl
+++ b/koha-tmpl/intranet-tmpl/prog/en/modules/help/reports/bor_issues_top.tmpl
@@ -2,15 +2,10 @@
<h1>Patrons with the most checkouts</h1>
-<p>This guided report will show you which patrons have checked out the most items.</p>
- <ul>
- <li>Go to the 'Reports' module (usually under 'More' in your Global Nav)</li>
- <li>Choose 'Patrons with the most checkouts' under 'Top Lists'</li>
- <li>Choose any filters from the top section
- <ul>
- <li>
- IMPORTANT: Choose something other than 'None' from the 'By' field to see results</li>
- </ul></li>
- <li>Once you have your fields fill in, click 'Submit'</li>
- </ul>
- </div> <!-- TMPL_INCLUDE NAME="help-bottom.inc" -->
\ No newline at end of file
+<p>This report will simply list the patrons who have the most checkouts.</p>
+
+<p>If you choose to output to the browser your results will print to the screen.</p>
+
+<p>You can also choose to export to a file that you can manipulate to your needs.</p>
+
+<!-- TMPL_INCLUDE NAME="help-bottom.inc" -->
\ No newline at end of file
diff --git a/koha-tmpl/intranet-tmpl/prog/en/modules/help/reports/borrowers_out.tmpl b/koha-tmpl/intranet-tmpl/prog/en/modules/help/reports/borrowers_out.tmpl
index aa484b0..565c045 100644
--- a/koha-tmpl/intranet-tmpl/prog/en/modules/help/reports/borrowers_out.tmpl
+++ b/koha-tmpl/intranet-tmpl/prog/en/modules/help/reports/borrowers_out.tmpl
@@ -1,11 +1,11 @@
<!-- TMPL_INCLUDE NAME="help-top.inc" -->
-<h1>Patrons who haven't checked out</h1>
-
-<p>This guided report will give you a snapshot of which (OR HOW MANY?) items have not been checked out at all. You can limit these items by branch</p>
- <ul>
- <li>Go to the 'Reports' module (usually under 'More' in your Global Nav)</li>
- <li>Choose 'Patrons who haven't checked out' under 'Inactive'</li>
- <li>If you do not choose any filters or limits, you will see all patrons who have not checked anything out of your library</li>
- </ul>
- </div> <!-- TMPL_INCLUDE NAME="help-bottom.inc" -->
\ No newline at end of file
+<h1>Patrons with no checkouts</h1>
+
+<p>This report will simply list the patrons (and their barcodes) who have not checked anything out of the library.</p>
+
+<p>If you choose to output to the browser your results will print to the screen.</p>
+
+<p>You can also choose to export to a file that you can manipulate to your needs.</p>
+
+<!-- TMPL_INCLUDE NAME="help-bottom.inc" -->
\ No newline at end of file
diff --git a/koha-tmpl/intranet-tmpl/prog/en/modules/help/reports/borrowers_stats.tmpl b/koha-tmpl/intranet-tmpl/prog/en/modules/help/reports/borrowers_stats.tmpl
index cd28653..86a6fcb 100644
--- a/koha-tmpl/intranet-tmpl/prog/en/modules/help/reports/borrowers_stats.tmpl
+++ b/koha-tmpl/intranet-tmpl/prog/en/modules/help/reports/borrowers_stats.tmpl
@@ -2,29 +2,10 @@
<h1>Patron Statistics</h1>
-<p style="color: #990000">IMPORTANT: The Patron 'Wizard' is designed to be a simple statistical snapshot, In each wizard, you will choose a single category to represent 'row' and another to represent 'column'.</p>
- <ul>
- <li>Go to the 'Reports' module (usually under 'More' in your Global Nav)</li>
- <li>Choose 'Patrons' under 'Statistics Wizards'</li>
- <li>Use the radio button to choose a category for 'row' (In the case above, we've selected 'patron category' for the row
- <ul>
- <li>Use dropdowns to apply filters to this category</li>
- </ul></li>
- <li>Use the radio button to choose a category for 'column' (In the case above, we've selected 'branch' for the column)
- <ul>
- <li>
- <ul>
- <li>Use dropdowns to apply filters to this category</li>
- </ul></li>
- </ul></li>
- <li>Options without radio buttons such as 'Patron status', 'Patron activity', and 'Date of Birth' are limits you can place on the report.</li>
- <li style="background-color: #ffe599">
-TIP: To place no limits for a category, choose the blank field. When blank field is chosen all categories will be included in the statistical count.</li>
- <li>Choose a method for 'outputting' (viewing) the report: Options are 'browser' or saving as a file viewable in a program like Excel.</li>
- <li>Click 'Submit'</li>
- <li>For each patron category (rows), there is a count given by branch. Each row and columns are also totaled</li>
- </ul>
- </div>
+<p>Using the form provided, choose which value you would like to appear in the Column and which will appear in the Row.</p>
-<!-- TMPL_INCLUDE NAME="help-bottom.inc" -->
+<p>If you choose to output to the browser your results will print to the screen.</p>
+<p>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.</p>
+
+<!-- TMPL_INCLUDE NAME="help-bottom.inc" -->
\ No newline at end of file
diff --git a/koha-tmpl/intranet-tmpl/prog/en/modules/help/reports/cat_issues_top.tmpl b/koha-tmpl/intranet-tmpl/prog/en/modules/help/reports/cat_issues_top.tmpl
index d07159d..a39293b 100644
--- a/koha-tmpl/intranet-tmpl/prog/en/modules/help/reports/cat_issues_top.tmpl
+++ b/koha-tmpl/intranet-tmpl/prog/en/modules/help/reports/cat_issues_top.tmpl
@@ -1,17 +1,11 @@
<!-- TMPL_INCLUDE NAME="help-top.inc" -->
-<h1>Most -Circulated Items</h1>
+<h1>Most-Circulated Items</h1>
-<p>This guided report will show you which patrons</p>
+<p>This report will simply list the items that have the been checked out the most.</p>
- <ul>
- <li>Go to the 'Reports' module (usually under 'More' in your Global Nav)</li>
- <li>Choose 'Most-Circulated Items' under 'Top Lists'</li>
- <li>Choose any filters from the top section<br/>
- <ul>
- <li>
- IMPORTANT: Choose something other than 'None' from the 'By' field to see results</li>
- </ul></li>
- <li>Once you have your fields filled in, click 'Submit'</li>
- </ul>
- </div> <!-- TMPL_INCLUDE NAME="help-bottom.inc" -->
\ No newline at end of file
+<p>If you choose to output to the browser your results will print to the screen.</p>
+
+<p>You can also choose to export to a file that you can manipulate to your needs.</p>
+
+<!-- TMPL_INCLUDE NAME="help-bottom.inc" -->
\ No newline at end of file
diff --git a/koha-tmpl/intranet-tmpl/prog/en/modules/help/reports/catalogue_out.tmpl b/koha-tmpl/intranet-tmpl/prog/en/modules/help/reports/catalogue_out.tmpl
index 03bb398..70f8e5d 100644
--- a/koha-tmpl/intranet-tmpl/prog/en/modules/help/reports/catalogue_out.tmpl
+++ b/koha-tmpl/intranet-tmpl/prog/en/modules/help/reports/catalogue_out.tmpl
@@ -1,15 +1,11 @@
<!-- TMPL_INCLUDE NAME="help-top.inc" -->
-<h1>Items not checked out</h1>
-
-<p>This guided report will give you a snapshot of items have not been checked out at all. You can limit these items by branch</p>
-
- <ul>
- <li>Go to the 'Reports' module (usually under 'More' in your Global Nav)</li>
- <li>Choose 'Items not checked out' under 'Inactive'</li>
- <li>If you do not choose any filters or limits, you will see all items that have not been checked out of your library</li>
- <li>By choosing a limit you will change the output</li>
- <li>Choose a limit of 'Library'</li>
- <li>And your results will be sorted by Library code</li>
- </ul>
- </div> <!-- TMPL_INCLUDE NAME="help-bottom.inc" -->
\ No newline at end of file
+<h1>Items with no checkouts</h1>
+
+<p>This report will list items in your collection that have never been checked out.</p>
+
+<p>If you choose to output to the browser your results will print to the screen.</p>
+
+<p>You can also choose to export to a file that you can manipulate to your needs.</p>
+
+<!-- TMPL_INCLUDE NAME="help-bottom.inc" -->
\ No newline at end of file
diff --git a/koha-tmpl/intranet-tmpl/prog/en/modules/help/reports/catalogue_stats.tmpl b/koha-tmpl/intranet-tmpl/prog/en/modules/help/reports/catalogue_stats.tmpl
index b94254c..b397577 100644
--- a/koha-tmpl/intranet-tmpl/prog/en/modules/help/reports/catalogue_stats.tmpl
+++ b/koha-tmpl/intranet-tmpl/prog/en/modules/help/reports/catalogue_stats.tmpl
@@ -1,27 +1,11 @@
<!-- TMPL_INCLUDE NAME="help-top.inc" -->
-<h1> Catalog Statistics</h1>
+<h1>Catalog Statistics</h1>
-<p style="color: #990000">IMPORTANT: The Catalog 'Wizard' is designed to be a simple statistical snapshot. You will choose a single category to represent 'row' and another to represent 'column'.</p>
+<p>Using the form provided, choose which value you would like to appear in the Column and which will appear in the Row.</p>
- <ul>
- <li>Go to the 'Reports' module (usually under 'More' in your Global Nav)</li>
- <li>Choose 'Catalog' under 'Statistics Wizards'</li>
- <li>Use the radio button to choose a category for 'row' (In the case above, we've selected 'patron category' for the row
- <ul>
- <li>Use dropdowns to apply filters to this category</li>
- </ul></li>
- </ul>
- <ul>
- <li>Use the radio button to choose a category for 'column' (In the case above, we've selected 'branch' for the column)
- <ul>
- <li>Use dropdowns to apply filters to this category</li>
- </ul></li>
- </ul>
- <ul>
- <li>Choose a method for 'outputting' (viewing) the report: Options are 'browser' or saving as a file viewable in a program like Excel.</li>
- <li>Click 'Submit'</li>
- </ul>
+<p>If you choose to output to the browser your results will print to the screen.</p>
-<!-- TMPL_INCLUDE NAME="help-bottom.inc" -->
+<p>You can also choose to export to a file that you can manipulate to your needs.</p>
+<!-- TMPL_INCLUDE NAME="help-bottom.inc" -->
\ No newline at end of file
diff --git a/koha-tmpl/intranet-tmpl/prog/en/modules/help/reports/dictionary.tmpl b/koha-tmpl/intranet-tmpl/prog/en/modules/help/reports/dictionary.tmpl
index 351c967..35e12f7 100644
--- a/koha-tmpl/intranet-tmpl/prog/en/modules/help/reports/dictionary.tmpl
+++ b/koha-tmpl/intranet-tmpl/prog/en/modules/help/reports/dictionary.tmpl
@@ -1,64 +1,20 @@
<!-- TMPL_INCLUDE NAME="help-top.inc" -->
-<h1>Reports Dictionary Help</h1>
+<h1>Report Dictionary</h1>
-The dictionary provides a way that you can define custom criteria for reporting by combining existing criteria.
+<p>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.</p>
-<h2>Adding A New Definition</h2>
-
-<p><strong>Step 1: Name</strong></p>
-
-<p>At this step you will need to fill out the following details:</p>
-
-<ul>
-<li>Definition Name: Short name that is used for display and selection</li>
-<li>Definition Description: Used within the dictionary only to provide further detail about the definition</li>
-</ul>
-
-<p><strong>Step 2: Area</strong></p>
-
-<p>Now you will need to select the area that you are binding the definition to. </p>
-
-<p style="color: #990000">IMPORTANT: Definitions can only be bound to one area.</p>
-
-<p style="background-color: #ffe599">TIP: If you wish to use a similar definition in say, Circulation and Patrons, you will need to create two definitions - one for each area</p>
-
-<p><strong>Step 3: Columns</strong></p>
-
-<p>Now select the criteria that you wish to use to build your definition. </p>
-
-<ul>
-<li>Click on the database column name and then press the 'add' button.</li>
-<li>Once you have selected all your desired columns, press Next.</li>
-</ul>
-
-<p style="background-color: #ffe599">TIP: Definitions can be deleted easily, and if you are still learning the structure of the Koha data, it may take a little while to sort out which fields you require. Some trial and error may be required</p>
-
-<p><strong>Step 4: Values</strong></p>
-
-<p>Now you need to select the values for each column that will make up your new criteria. There are different ways to define the values, based on the type of data in the column you have selected</p>
-
-<ul>
-<li>Search String Matches For free text fields in that database, enter a string/phrase for the criteria to match on</li>
-<li>Date For date fields you can either select:</li>
-<ol><li>Date Range: enter values in both date fields</li>
- <li>All Data Before A Given Date: enter a value in the XXX field only</li>
- <li>All Data After A Given Date: enter a value in the XXX field only</li>
+<ol>
+ <li>Name the definition and provide a description if necessary</li>
+ <li>Choose the module that the will be queried.</li>
+ <li>Choose columns to query from the tables presented.</li>
+ <li>Choose the value(s) from the field(s). These will be automatically populated with options available in your database.</li>
</ol>
-<li>Select From Database Value For data that is given an authorized value in the Koha database, you the drop down list to select one value</li>
-</ul>
-
-<p><strong>Step 5: Confirmation</strong></p>
-
-<p>You will be presented with a confirmation once you have finished step 4</p>
-<p>Click 'Save'</p>
+<p>Confirm your selections to save the definition.</p>
-<h2>Using A Definition</h2>
+<p>Your definitions will all appear on the Reports Dictionary page</p>
-<p>Once you have created your new definition and it shows on in the Dictionary, you can use the definition for reporting.</p>
+<p>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.</p>
-<ul>
-<li>When you go to create a new report, the criteria for the area you are reporting on will automatically show as limits in the Guided Reports wizard</li>
-</ul>
<!-- TMPL_INCLUDE NAME="help-bottom.inc" -->
\ No newline at end of file
diff --git a/koha-tmpl/intranet-tmpl/prog/en/modules/help/reports/guided_reports.tmpl b/koha-tmpl/intranet-tmpl/prog/en/modules/help/reports/guided_reports.tmpl
index a584de5..6837f00 100644
--- a/koha-tmpl/intranet-tmpl/prog/en/modules/help/reports/guided_reports.tmpl
+++ b/koha-tmpl/intranet-tmpl/prog/en/modules/help/reports/guided_reports.tmpl
@@ -1,68 +1,60 @@
<!-- TMPL_INCLUDE NAME="help-top.inc" -->
-<h1>Add a Custom Report</h1>
+<h1>Custom Reports</p>
-<p>If the report you need is not already available, the 'Guided Reports' Wizard will walk you through creating a custom report.</p>
+<p>Koha's data is stored in a MySQL database which means that librarians can generate nearly any report they would like by either using the Guided Reports Wizard or writing their own SQL query.</p>
+<h2>Guided Report Wizard</h2>
-<ul>
-<li>Go to the 'Reports' module (usually under 'More' in your Global Nav)</li>
-<li>Choose 'Guided Reports' under 'Guided Reports Wizard'</li>
-</ul>
+<p>The guided report wizard will walk you through a six step process to generate a report.</p>
-<p>Answer the 6 questions presented in order to create your report.</p>
+<ol>
+ <li>Choose the module you want to report on. This will determine what tables and fields are available for you to query.</li>
+ <li>Choose a report type. For now, Tabular is the only option available.</li>
+ <li>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.</li>
+ <li>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.</li>
+ <li>Perform math functions. If you don't want to do any calculations, simply click Next instead of making an option.</li>
+ <li>Choose data order. If you want the data to print out in the order it's found in the database, simply click Finish.</li>
+</ol>
-<p><strong>Step 1: Choose a Module to Report on</strong></p>
-<ul>
-<li>Choose a Koha module to build a report on (patrons, circ, cataloging, etc)</li>
-<li>Click 'Next'</li>
-</ul>
+<p>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.</p>
-<p><strong>Step 2: Pick a Report Type</strong></p>
-<ul><li style="color: #990000">IMPORTANT: Only Tabular should be chosen with this option</li></ul>
-<p><strong>Step 3: Select Columns for Display</strong></p>
-<p><strong>Step 4: Select Criteria to Limit</strong></p>
-<ul><li>This is optional, if you don't want to limit results by any one field, just leave this section blank.</li></ul>
-<p><strong>Step 5: Pick which columns to perform mathmatical functions on</strong></p>
-<ul><li>This is optional, if you don't want to do any math on the results, just leave this section blank.</li></ul>
-<p><strong>Step 6: Choose how you want the report ordered</strong></p>
-<ul><li>This is optional, if you want the results to come out as they are in the table, just leave this section blank.</li></ul>
+<p>If you choose to save the report you will be asked to name your report and enter any notes regarding it.</p>
-<h1>Edit Reports</h1>
+<p>Once your report is saved it will appear on the 'Use Saved' page with all other saved reports.</p>
-<p>Custom reports can be edited in their entirety from the Saved Guided Reports page.</p>
+<p>From here you can make edits, run the report, or schedule a time to have the report run.</p>
-<ul><li><em>Get there:</em> More > Reports > Guided Reports > Use Saved</li></ul>
+<h2>Report from SQL</h2>
-<ul><li>To edit a report click 'Edit SQL' beside the report</li>
-<li>A page with editable fields will open so that you can change the title, notes and SQL related to the report</li></ul>
+<p>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: <a href="http://wiki.koha-community.org/wiki/SQL_Reports_Library">http://wiki.koha-community.org/wiki/SQL_Reports_Library</a>. You can also find your database structure in /installer/data/mysql/kohastructure.sql or online at: <a href="http://git.koha-community.org/cgi-bin/gitweb.cgi?p=koha.git;a=blob_plain;f=installer/data/mysql/kohastructure.sql;hb=HEAD">http://git.koha-community.org/cgi-bin/gitweb.cgi?p=koha.git;a=blob_plain;f=installer/data/mysql/kohastructure.sql;hb=HEAD</a>.</p>
+<p>To add your query, simply fill in the form presented</p>
-<h1>Questions</h1>
+<p>If you feel that your report might be too resource intesive 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.</p>
-<p><strong>Can I have reports run on a schedule?</strong></p>
+<p>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>>.</p>
+<ul>
+ <li>The << and >> are just delimiters. You must put << at the beginning and >> at the end of your parameter</li>
+ <li>The 'Question to ask' will be displayed on the left of the string to enter.</li>
+ <li>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</li>
+</ul>
-<p>Yes, you can use the Task Scheduler tool.</p>
+<p>Examples:</p>
-<ul><li><em>Get there:</em> More > Tools > Task Scheduler</li></ul>
+<ul>
+ <li>SELECT surname,firstname FROM borrowers WHERE branchcode=<<Enter patrons library|branches>> AND surname like <<Enter filter for patron surname (% if none)>></li>
+ <li>SELECT * FROM items WHERE homebranch = <<Pick your branch|branches>> and barcode like <<Partial barcode value here>></li>
+</ul>
-<p><strong>Is there a repository for reports?</strong></p>
+<p style="background-color: #ffe599">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.</p>
-<p>There is a page on the Koha Wiki: <a href="http://wiki.koha-community.org/wiki/SQL_Reports_Library" target="_new">http://wiki.koha-community.org/wiki/SQL_Reports_Library</a> with reports written by Koha libraries around the world.</p>
+<p style="color: #990000">Important: The only supported dropdowns at this time are Branches, Item Types and Patron Categories.</p>
-<p>NEKLS also has a great page (<a href="http://www.nexpresslibrary.org/training/reports-training/" target="_new">http://www.nexpresslibrary.org/training/reports-training/</a>) with a list of reports they have written.</p>
+<h2>Edit Custom Reports</h2>
-<p><strong>Can I have run-time defined parameters?</strong></p>
+<p>Every report can be edited from the reports lists. To see the list of reports already stored in Koha, click 'Use Saved.'</p>
-<p>Yes, you can: there is a specific syntax that Koha will understand as 'ask for values when running the report'. The syntax is <<Question to ask|authorised_value>>.</p>
-<ul>
-<li>The << and >> are just delimiters. You must put << at the beginning and >> at the end of your parameter</li>
-<li>The <strong>Question to ask</strong> will be displayed on the left of the string to enter.
-<li>The <strong>authorised_value</strong> can be omitted if not applicable. If it contains an authorised value category, or <strong>branches</strong> or <strong>itemtype</strong> or <strong>categorycode</strong>, a list with the Koha authorised values will be displayed instead of a free field</li>
-</ul>
-<p>Note that you can have more than one parameter in a given SQL</p>
-<p>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</p>
-<p>Sample :</p>
-<ul><li>SELECT surname,firstname FROM borrowers WHERE branchcode=<<Enter patrons library|branches>> AND surname like <<Enter filter for patron surname (% if none)>></li></ul>
+<p>From this list you can edit any custom report by clicking 'Edit SQL'</p>
-<!-- TMPL_INCLUDE NAME="help-bottom.inc" -->
+<!-- TMPL_INCLUDE NAME="help-bottom.inc" -->
\ No newline at end of file
diff --git a/koha-tmpl/intranet-tmpl/prog/en/modules/help/reports/issues_avg_stats.tmpl b/koha-tmpl/intranet-tmpl/prog/en/modules/help/reports/issues_avg_stats.tmpl
index c1e1a4b..32c8cd8 100644
--- a/koha-tmpl/intranet-tmpl/prog/en/modules/help/reports/issues_avg_stats.tmpl
+++ b/koha-tmpl/intranet-tmpl/prog/en/modules/help/reports/issues_avg_stats.tmpl
@@ -1,12 +1,11 @@
<!-- TMPL_INCLUDE NAME="help-top.inc" -->
-<h1>Average loan time</h1>
+<h1>Average Loan Time</h1>
-<p>This report will show you how many items were checked out, by borrower (or 'patron') category</p>
+<p>This report will list the average time items are out on loan based on the criteria you enter</p>
- <ul>
- <li>Go to the 'Reports' module (usually under 'More' in your Global Nav)</li>
- <li>Choose 'Average loan time' under 'Other'</li>
- <li>Choose one field to appear in the rows and another to appear in the column. If you choose either of the date fields remember to choose to show data by 'Day', 'Month', or 'Year'</li>
- </ul>
- </div> <!-- TMPL_INCLUDE NAME="help-bottom.inc" -->
\ No newline at end of file
+<p>If you choose to output to the browser your results will print to the screen.</p>
+
+<p>You can also choose to export to a file that you can manipulate to your needs.</p>
+
+<!-- TMPL_INCLUDE NAME="help-bottom.inc" -->
\ No newline at end of file
diff --git a/koha-tmpl/intranet-tmpl/prog/en/modules/help/reports/issues_stats.tmpl b/koha-tmpl/intranet-tmpl/prog/en/modules/help/reports/issues_stats.tmpl
index 478c9a7..83b4daa 100644
--- a/koha-tmpl/intranet-tmpl/prog/en/modules/help/reports/issues_stats.tmpl
+++ b/koha-tmpl/intranet-tmpl/prog/en/modules/help/reports/issues_stats.tmpl
@@ -1,25 +1,23 @@
<!-- TMPL_INCLUDE NAME="help-top.inc" -->
-<h1> Circulation Statistics</h1>
-
-<p style="color: #990000">IMPORTANT: The Circulation 'Wizard' is designed to be a simple statistical snapshot. You will choose a single category to represent 'row' and another to represent 'column'.</p>
- <ul>
- <li>Go to the 'Reports' module (usually under 'More' in your Global Navigation)</li>
- <li>Choose 'Circulation' under 'Statistics Wizards'</li>
- <li>Select the information you want to display in rows by setting the 'Row' radio button next to that category</li>
- <li>Select the information you want to display in columns by setting the 'Column' radio button next to that category.</li>
- <li>You can limit, or Filter, your results by selecting a value from the pull down menu. For example, you could select a specific library or branch and set a time 'Period,' without needing to select those radio buttons.</li>
- </ul>
-<strong>Tips:</strong>
- <ul>
- <li>To get a complete picture of your monthly or daily circulation, you can run the report twice, once for 'Type' of 'Checkout' and again for 'Renewal.'</li>
- <li>This report uses 'Period,' or date, filtering that allows you to limit to a month by simply selecting the first day of the first month through the first day of the next month. For example, 10/1 to 11/1 to find statistics for the month of October.</li>
- <ul>
- <li>To find daily statistics, set your date range.</br> Example: "I want circulation data starting with date XXX up to, but not including, date XXX."</li>
- <li>For a whole month, an example range would be: 11/01/2009 to 12/01/2009</li>
- <li>For a whole year, an example range would be: 01/01/2009 to 01/01/2010</li>
- <li>For a single day, an example would be: 11/15/2009 to 11/16/2009 to find what circulated on the 15th</li>
- </ul>
- </ul>
- </div>
-<!-- TMPL_INCLUDE NAME="help-bottom.inc" -->
+<h1>Circulation Statistics</h1>
+
+<p>Using the form provided, choose which value you would like to appear in the Column and which will appear in the Row.</p>
+
+<p>If you choose to output to the browser your results will print to the screen.</p>
+
+<p>You can also choose to export to a file that you can manipulate to your needs.</p>
+
+<p style="background-color: #ffe599">Tip: To get a complete picture of your monthly or daily circulation, you can run the report twice, once for 'Type' of 'Checkout' and again for 'Renewal.'</p>
+
+<p>This report uses 'Period,' or date, filtering that allows you to limit to a month by simply selecting the first day of the first month through the first day of the next month. For example, 10/1 to 11/1 to find statistics for the month of October.</p>
+
+<ul>
+ <li>To find daily statistics, set your date range.<br />
+ Example: "I want circulation data starting with date XXX up to, but not including, date XXX."</li>
+ <li>For a whole month, an example range would be: 11/01/2009 to 12/01/2009</li>
+ <li>For a whole year, an example range would be: 01/01/2009 to 01/01/2010</li>
+ <li>For a single day, an example would be: 11/15/2009 to 11/16/2009 to find what circulated on the 15th</li>
+</ul>
+
+<!-- TMPL_INCLUDE NAME="help-bottom.inc" -->
\ No newline at end of file
diff --git a/koha-tmpl/intranet-tmpl/prog/en/modules/help/reports/itemslost.tmpl b/koha-tmpl/intranet-tmpl/prog/en/modules/help/reports/itemslost.tmpl
index c83e5b2..34d443c 100644
--- a/koha-tmpl/intranet-tmpl/prog/en/modules/help/reports/itemslost.tmpl
+++ b/koha-tmpl/intranet-tmpl/prog/en/modules/help/reports/itemslost.tmpl
@@ -2,16 +2,6 @@
<h1>Lost Items</h1>
-<p> This one-step report will show you how many items of each item type are currently in your branch library or libraries.</p>
+<p>This report will allow you to generate a list of items that have been marked as Lost within the system.</p>
- <ul>
- <li>Go to the 'Reports' module (usually under 'More' in your Global Nav)</li>
- <li>Choose 'Lost Items' under 'Other'</li>
- <li>Choose category to 'Order by' (the 'order by' field effects what ordering method is used when displaying the lost items)</li>
- <li>Enter a 'Barcode' if searching for a single item; if not leave this field blank</li>
- <li>Choose a 'Branch' to perform the report on (or choose 'All' field at the top of the dropdown menu to choose all branches)</li>
- <li>Choose an 'Item Type' to perform the report on (or, leave at the default 'All' to perform the report on all item types)</li>
- <li>Choose a 'Lost Status' to search only for items that are assumed lost (long overdue), missing, or lost (or, leave this set to 'All' to see all lost items)</li>
- <li>Click 'Submit'</li>
- </ul>
- </div> <!-- TMPL_INCLUDE NAME="help-bottom.inc" -->
\ No newline at end of file
+<!-- TMPL_INCLUDE NAME="help-bottom.inc" -->
\ No newline at end of file
diff --git a/koha-tmpl/intranet-tmpl/prog/en/modules/help/reports/manager.tmpl b/koha-tmpl/intranet-tmpl/prog/en/modules/help/reports/manager.tmpl
index 80a16cf..68755a8 100644
--- a/koha-tmpl/intranet-tmpl/prog/en/modules/help/reports/manager.tmpl
+++ b/koha-tmpl/intranet-tmpl/prog/en/modules/help/reports/manager.tmpl
@@ -2,11 +2,10 @@
<h1>Catalog by Item Type</h1>
-<p>This one-step report will show you how many items of each item type are currently in your branch library or libraries.</p>
-
- <ul>
- <li>Go to the 'Reports' module (usually under 'More' in your Global Nav)</li>
- <li>Choose 'Catalog by Item Type' under 'Other'</li>
- <li>Choose a branch (or choose the blank field at the top of the dropdown menu to choose all branches)</li>
- <li>Click 'Submit'</li>
- </ul><!-- TMPL_INCLUDE NAME="help-bottom.inc" -->
\ No newline at end of file
+<p>This report will list the total number of items of each item type per branch.</p>
+
+<p>If you choose to output to the browser your results will print to the screen.</p>
+
+<p>You can also choose to export to a file that you can manipulate to your needs.</p>
+
+<!-- TMPL_INCLUDE NAME="help-bottom.inc" -->
\ No newline at end of file
diff --git a/koha-tmpl/intranet-tmpl/prog/en/modules/help/reports/reports-home.tmpl b/koha-tmpl/intranet-tmpl/prog/en/modules/help/reports/reports-home.tmpl
index b2c0c98..4a8b6f5 100644
--- a/koha-tmpl/intranet-tmpl/prog/en/modules/help/reports/reports-home.tmpl
+++ b/koha-tmpl/intranet-tmpl/prog/en/modules/help/reports/reports-home.tmpl
@@ -2,13 +2,10 @@
<h1>Reports</h1>
-<h2>What Reports are there in Koha?</h2>
-
-<p>Koha comes with a number of predefined (or "canned") reports, along with two report builder engines.</p>
-<p><strong>Pre-defined Reports</strong></p>
-<p>There are number of predefined reports in Koha. Check the Circulation module for additional Circulation specific reports.</p>
-<p><strong>Statistics Wizards</strong></p>
-<p>The statistics wizards provide a way to build simple reports for each module. The reports produced can either be viewed on screen or downloaded for opening in a spreadsheet program or text editor.</p>
-<p><strong>Guided Reports Wizard</strong></p>
-<p>The Guided Reports Wizard helps you build reports using all the fields in the database for each module. The reports can then be saved and run using the scheduler. </p><!-- TMPL_INCLUDE NAME="help-bottom.inc" -->
+<p>Koha's reporting module gives you the freedom to generate reports on nearly anything. Koha's data is stored in a MySQL database which means that librarians can generate nearly any report they would like by either using the Guided Reports Wizard or writing their own SQL query.</p>
+<p>Koha also comes with a series of statistics reports to give you quick access to numerical data.</p>
+
+<p>Be sure to checkout the <a href="http://wiki.koha-community.org/wiki/SQL_Reports_Library">SQL Reports Library</a> with reports shared by librarians who are already using Koha.</p>
+
+<!-- TMPL_INCLUDE NAME="help-bottom.inc" -->
\ No newline at end of file
diff --git a/koha-tmpl/intranet-tmpl/prog/en/modules/help/reports/serials_stats.tmpl b/koha-tmpl/intranet-tmpl/prog/en/modules/help/reports/serials_stats.tmpl
index c2f68f0..65c0e94 100644
--- a/koha-tmpl/intranet-tmpl/prog/en/modules/help/reports/serials_stats.tmpl
+++ b/koha-tmpl/intranet-tmpl/prog/en/modules/help/reports/serials_stats.tmpl
@@ -2,22 +2,10 @@
<h1>Serials Statistics</h1>
-<p style="color: #990000">IMPORTANT: The Serials 'Wizard' is designed to be a simple
-statistical snapshot.
-</p>
-<ul>
- <li>
- Go to the 'Reports' module (usually under 'More' in your Global Nav)
- </li>
- <li>
- Choose 'Serials' under 'Statistics Wizards'</li>
- <li>Choose
- your vendor and branch (or leave them both set to 'Any' to get
- information on all subscriptions) and whether to include expired
- subscriptions</li>
- <li>Your results will appear as a list of subscriptions
- </li>
-</ul>
+<p>Using the form provided, choose how you would like to list the serials in your system.</p>
+<p>If you choose to output to the browser your results will print to the screen.</p>
+
+<p>You can also choose to export to a file that you can manipulate to your needs.</p>
<!-- TMPL_INCLUDE name="help-bottom.inc" -->
\ No newline at end of file
--
1.5.6.5
More information about the Koha-patches
mailing list