Attachment #5782 for bug #6966

View | Details | Raw Unified | Return to bug 6966
Collapse All | Expand All





<h1>Acquisitions 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>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>

<p><strong>See the full documentation for Acquisitions Statistics in the <a href="http://manual.koha-community.org/3.6/en/statsreports.html#acqstats">manual</a> (online).</strong></p>

[% INCLUDE 'help-bottom.inc' %]




[% INCLUDE 'help-top.inc' %]

<h1>Patrons With The Most Checkouts</h1>

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

<p><strong>See the full documentation for the Patrons with the most Checkouts report in the <a href="http://manual.koha-community.org/3.6/en/statsreports.html#mostcheckouts">manual</a> (online).</strong></p>

[% INCLUDE 'help-bottom.inc' %]
			<li>Once you have your fields fill in, click 'Submit'</li>
		</ul>
	</div>	[% INCLUDE 'help-bottom.inc' %]




[% INCLUDE 'help-top.inc' %]

<h1>Patrons With No Checkouts</h1>

<p>This report will list for you the patrons in your system who haven't checked any items 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>

<p><strong>See the full documentation for the Patrons with no Checkouts report in the <a href="http://manual.koha-community.org/3.6/en/statsreports.html#patnocheckouts">manual</a> (online).</strong></p>

[% INCLUDE 'help-bottom.inc' %]





<h1>Patron 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>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>

<p><strong>See the full documentation for Patron Statistics in the <a href="http://manual.koha-community.org/3.6/en/statsreports.html#patstats">manual</a> (online).</strong></p>
			</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>

[% INCLUDE 'help-bottom.inc' %]





[% INCLUDE 'help-top.inc' %]

<h1>Most Circulated Items</h1>

<p>This report will simply list the items that have the been checked out the most.</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><strong>See the full documentation for the Most Circulation Items report in the <a href="http://manual.koha-community.org/3.6/en/statsreports.html#mostcirculated">manual</a> (online).</strong></p>

[% INCLUDE 'help-bottom.inc' %]
			</ul></li>
			<li>Once you have your fields filled in, click 'Submit'</li>
		</ul>
	</div>	[% INCLUDE 'help-bottom.inc' %]




[% INCLUDE 'help-top.inc' %]

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

<p><strong>See the full documentation for the Issues with no Checkouts report in the <a href="http://manual.koha-community.org/3.6/en/statsreports.html#itemnocheckouts">manual</a> (online).</strong></p>

[% INCLUDE 'help-bottom.inc' %]
		</ul>
	</div>	[% INCLUDE 'help-bottom.inc' %]




[% INCLUDE 'help-top.inc' %]

<h1>Catalog 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><strong>See the full documentation for Catalog Statistics in the <a href="http://manual.koha-community.org/3.6/en/statsreports.html#catstats">manual</a> (online).</strong></p>
			<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>

[% INCLUDE 'help-bottom.inc' %]





[% INCLUDE 'help-top.inc' %]

<h1>Reports Dictionary</h1>

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

<p>Step 1: Name the definition and provide a description if necessary</p>

<p>Step 2: Choose the module that the will be queried.</p>

<p>Step 3: Choose columns to query from the tables presented.</p>

<p>Step 4: Choose the value(s) from the field(s). These will be automatically populated with options available in your database.</p>
<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>Confirm your selections to save the definition.</p>

<p>Your definitions will all appear on the Reports Dictionary page</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>

<p><strong>See the full documentation for the Reports Dictionary in the <a href="http://manual.koha-community.org/3.6/en/reportdic.html">manual</a> (online).</strong></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>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>

<h2>Using A Definition</h2>

<p>Once you have created your new definition and it shows on in the Dictionary, you can use the definition for reporting.</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>
[% INCLUDE 'help-bottom.inc' %]





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


<ul>
<li>Go to the 'Reports' module (usually under 'More' in your Global Nav)</li>
<li>Choose 'Guided Reports' under 'Guided Reports Wizard'</li>

<p>Answer the 6 questions presented in order to create your report.</p>

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

<h1>Edit Reports</h1>


<ul><li><em>Get there:</em> More > Reports > Guided Reports > Use Saved</li></ul>

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

<h1>Questions</h1>

<p><strong>Can I have reports run on a schedule?</strong></p>

<p>Yes, you can use the Task Scheduler tool.</p>

<ul><li><em>Get there:</em> More > Tools > Task Scheduler</li></ul>

<p><strong>Is there a repository for reports?</strong></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><strong>Can I have run-time defined parameters?</strong></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 &lt;&lt;Question to ask|authorised_value&gt;&gt;.</p>

<ul>
<li>The &lt;&lt; and &gt;&gt; are just delimiters. You must put &lt;&lt; at the beginning and &gt;&gt; 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=&lt;&lt;Enter title&gt;&gt;" will display results with title='' (no title). If you want to have to have something not mandatory, use "title like &lt;&lt;Enter title&gt;&gt;" and enter a % at run time instead of nothing</p>

<p>Sample :</p>

<ul><li>SELECT surname,firstname FROM borrowers WHERE branchcode=&lt;&lt;Enter patrons library|branches&gt;&gt; AND surname like &lt;&lt;Enter filter for patron surname (% if none)&gt;&gt;</li></ul>

<p><strong>See the full documentation for Custom Reports in the <a href="http://manual.koha-community.org/3.6/en/reports.html#customreports">manual</a> (online).</strong></p>

[% INCLUDE 'help-bottom.inc' %]




[% INCLUDE 'help-top.inc' %]

<h1>Average Loan Time</h1>

<p>This report will list the average time items are out on loan based on the criteria you enter</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><strong>See the full documentation for the Average Loan Time report in the <a href="http://manual.koha-community.org/3.6/en/statsreports.html#avloantime">manual</a> (online).</strong></p>

[% INCLUDE 'help-bottom.inc' %]




[% INCLUDE 'help-top.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.

<ul>
	<li>To find daily statistics, set your date range.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>

<p><strong>See the full documentation for Circulation Statistics in the <a href="http://manual.koha-community.org/3.6/en/statsreports.html#circstats">manual</a> (online).</strong></p>

	</div>
[% INCLUDE 'help-bottom.inc' %]

Lines 14-17 Link Here

(-)a/koha-tmpl/intranet-tmpl/prog/en/modules/help/reports/itemslost.tt (-1 / +5 lines)
14	<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>	14	<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>
15	<li>Click 'Submit'</li>	15	<li>Click 'Submit'</li>
16	</ul>	16	</ul>
17	</div> [% INCLUDE 'help-bottom.inc' %]	17	</div>
		18
		19	<p><strong>See the full documentation for the Lost Items report in the <a href="http://manual.koha-community.org/3.6/en/statsreports.html#lostreport">manual</a> (online).</strong></p>
		20
		21	[% INCLUDE 'help-bottom.inc' %]





<h1>Catalog by Item Type</h1>

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

<p><strong>See the full documentation for the Catalog by Item Type report in the <a href="http://manual.koha-community.org/3.6/en/statsreports.html#catbyitem">manual</a> (online).</strong></p>

[% INCLUDE 'help-bottom.inc' %]





<h1>Reports</h1>

<p>Koha's reporting module allows you to gather data from your system.  There are two main types of reports:
 
<p>Koha comes with a number of predefined (or &quot;canned&quot;) 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>[% INCLUDE 'help-bottom.inc' %]

<ul>
	<li>Custom Reports
<ul>
	<li>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.</li>
</ul>
</li>
	<li>Statistical Reports
<ul>
	<li>Statistic reports will show you counts and sums. These reports are all about numbers and statistics, for reports that return more detailed data, use the Guided Report Wizard.</li>
</ul>
</li>
</ul>

<p><strong>See the full documentation for Reports in the <a href="http://manual.koha-community.org/3.6/en/reports.html">manual</a> (online).</strong></p>

[% INCLUDE 'help-bottom.inc' %]





<h1>Serials Statistics</h1>

<p>Using the form provided, choose how you would like to list the serials in your system.</p>
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>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><strong>See the full documentation for Serials Statistics in the <a href="http://manual.koha-community.org/3.6/en/statsreports.html#serialstats">manual</a> (online).</strong></p>

[% INCLUDE 'help-bottom.inc' %]
- 

Return to bug 6966

Lines 2-13 Link Here

(-)a/koha-tmpl/intranet-tmpl/prog/en/modules/help/reports/acquisitions_stats.tt (-9 / +13 lines)
2		2
3	<h1>Acquisitions Statistics</h1>	3	<h1>Acquisitions Statistics</h1>
4		4
5	<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>	5	<p>Using the form provided, choose which value you would like to appear in the Column and which will appear in the Row.</p>
6	<ul>	6
7	<li>Go to the 'Reports' module (usually under 'More' in your Global Nav)</li>	7	<p>If you choose to output to the browser your results will print to the screen.</p>
8	<li>Choose 'Acquisitions' under 'Statistics Wizards'</li>	8
9	<li>Enter in the information you'd like to see in your repor</li>	9	<p>You can also choose to export to a file that you can manipulate to your needs.</p>
10	<li>Click 'Submit'</li>	10
11	<li>By changing the report from 'Count items' to 'Amount' you will see the total spent</li>	11	<p>When generating your report, note that you get to choose between counting or summing the values.</p>
12	</ul>	12
13	</div> [% INCLUDE 'help-bottom.inc' %]	13	<p>Choosing amount will change your results to appear as the sum of the amounts spent.</p>
		14
		15	<p><strong>See the full documentation for Acquisitions Statistics in the <a href="http://manual.koha-community.org/3.6/en/statsreports.html#acqstats">manual</a> (online).</strong></p>
		16
		17	[% INCLUDE 'help-bottom.inc' %]

Lines 1-16 Link Here

(-)a/koha-tmpl/intranet-tmpl/prog/en/modules/help/reports/bor_issues_top.tt (-13 / +10 lines)
1	[% INCLUDE 'help-top.inc' %]	1	[% INCLUDE 'help-top.inc' %]
2		2
3	<h1>Patrons with the most checkouts</h1>	3	<h1>Patrons With The Most Checkouts</h1>
4		4
5	<p>This guided report will show you which patrons have checked out the most items.</p>	5	<p>This report will simply list the patrons who have the most checkouts.</p>
6	<ul>	6
7	<li>Go to the 'Reports' module (usually under 'More' in your Global Nav)</li>	7	<p>If you choose to output to the browser your results will print to the screen.</p>
8	<li>Choose 'Patrons with the most checkouts' under 'Top Lists'</li>	8
9	<li>Choose any filters from the top section	9	<p>You can also choose to export to a file that you can manipulate to your needs.</p>
10	<ul>	10
11	<li>	11	<p><strong>See the full documentation for the Patrons with the most Checkouts report in the <a href="http://manual.koha-community.org/3.6/en/statsreports.html#mostcheckouts">manual</a> (online).</strong></p>
12	IMPORTANT: Choose something other than 'None' from the 'By' field to see results</li>	12
13	</ul></li>	13	[% INCLUDE 'help-bottom.inc' %]
14	<li>Once you have your fields fill in, click 'Submit'</li>
15	</ul>
16	</div> [% INCLUDE 'help-bottom.inc' %]

Lines 2-30 Link Here

(-)a/koha-tmpl/intranet-tmpl/prog/en/modules/help/reports/borrowers_stats.tt (-23 / +7 lines)
2		2
3	<h1>Patron Statistics</h1>	3	<h1>Patron Statistics</h1>
4		4
5	<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>	5	<p>Using the form provided, choose which value you would like to appear in the Column and which will appear in the Row.</p>
6	<ul>	6
7	<li>Go to the 'Reports' module (usually under 'More' in your Global Nav)</li>	7	<p>If you choose to output to the browser your results will print to the screen.</p>
8	<li>Choose 'Patrons' under 'Statistics Wizards'</li>	8
9	<li>Use the radio button to choose a category for 'row' (In the case above, we've selected 'patron category' for the row	9	<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>
10	<ul>	10
11	<li>Use dropdowns to apply filters to this category</li>	11	<p><strong>See the full documentation for Patron Statistics in the <a href="http://manual.koha-community.org/3.6/en/statsreports.html#patstats">manual</a> (online).</strong></p>
12	</ul></li>
13	<li>Use the radio button to choose a category for 'column' (In the case above, we've selected 'branch' for the column)
14	<ul>
15	<li>
16	<ul>
17	<li>Use dropdowns to apply filters to this category</li>
18	</ul></li>
19	</ul></li>
20	<li>Options without radio buttons such as 'Patron status', 'Patron activity', and 'Date of Birth' are limits you can place on the report.</li>
21	<li style="background-color: #ffe599">
22	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>
23	<li>Choose a method for 'outputting' (viewing) the report: Options are 'browser' or saving as a file viewable in a program like Excel.</li>
24	<li>Click 'Submit'</li>
25	<li>For each patron category (rows), there is a count given by branch. Each row and columns are also totaled</li>
26	</ul>
27	</div>
28		12
29	[% INCLUDE 'help-bottom.inc' %]	13	[% INCLUDE 'help-bottom.inc' %]
30		14

Lines 4-10 Link Here

(-)a/koha-tmpl/intranet-tmpl/prog/en/modules/help/reports/guided_reports.tt (-10 / +20 lines)
4		4
5	<p>If the report you need is not already available, the 'Guided Reports' Wizard will walk you through creating a custom report.</p>	5	<p>If the report you need is not already available, the 'Guided Reports' Wizard will walk you through creating a custom report.</p>
6		6
7
8	<ul>	7	<ul>
9	<li>Go to the 'Reports' module (usually under 'More' in your Global Nav)</li>	8	<li>Go to the 'Reports' module (usually under 'More' in your Global Nav)</li>
10	<li>Choose 'Guided Reports' under 'Guided Reports Wizard'</li>	9	<li>Choose 'Guided Reports' under 'Guided Reports Wizard'</li>
Lines 13-31 Link Here
13	<p>Answer the 6 questions presented in order to create your report.</p>	12	<p>Answer the 6 questions presented in order to create your report.</p>
14		13
15	<p><strong>Step 1: Choose a Module to Report on</strong></p>	14	<p><strong>Step 1: Choose a Module to Report on</strong></p>
		15
16	<ul>	16	<ul>
17	<li>Choose a Koha module to build a report on (patrons, circ, cataloging, etc)</li>	17	<li>Choose a Koha module to build a report on (patrons, circ, cataloging, etc)</li>
18	<li>Click 'Next'</li>	18	<li>Click 'Next'</li>
19	</ul>	19	</ul>
20		20
21	<p><strong>Step 2: Pick a Report Type</strong></p>	21	<p><strong>Step 2: Pick a Report Type</strong></p>
		22
22	<ul><li style="color: #990000">IMPORTANT: Only Tabular should be chosen with this option</li></ul>	23	<ul><li style="color: #990000">IMPORTANT: Only Tabular should be chosen with this option</li></ul>
		24
23	<p><strong>Step 3: Select Columns for Display</strong></p>	25	<p><strong>Step 3: Select Columns for Display</strong></p>
		26
24	<p><strong>Step 4: Select Criteria to Limit</strong></p>	27	<p><strong>Step 4: Select Criteria to Limit</strong></p>
		28
25	<ul><li>This is optional, if you don't want to limit results by any one field, just leave this section blank.</li></ul>	29	<ul><li>This is optional, if you don't want to limit results by any one field, just leave this section blank.</li></ul>
		30
26	<p><strong>Step 5: Pick which columns to perform mathmatical functions on</strong></p>	31	<p><strong>Step 5: Pick which columns to perform mathmatical functions on</strong></p>
		32
27	<ul><li>This is optional, if you don't want to do any math on the results, just leave this section blank.</li></ul>	33	<ul><li>This is optional, if you don't want to do any math on the results, just leave this section blank.</li></ul>
		34
28	<p><strong>Step 6: Choose how you want the report ordered</strong></p>	35	<p><strong>Step 6: Choose how you want the report ordered</strong></p>
		36
29	<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>	37	<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>
30		38
31	<h1>Edit Reports</h1>	39	<h1>Edit Reports</h1>
Lines 34-51 Link Here
34		42
35	<ul><li><em>Get there:</em> More > Reports > Guided Reports > Use Saved</li></ul>	43	<ul><li><em>Get there:</em> More > Reports > Guided Reports > Use Saved</li></ul>
36		44
37	<ul><li>To edit a report click 'Edit SQL' beside the report</li>	45	<ul>
38	<li>A page with editable fields will open so that you can change the title, notes and SQL related to the report</li></ul>	46	<li>To edit a report click 'Edit SQL' beside the report</li>
39		47	<li>A page with editable fields will open so that you can change the title, notes and SQL related to the report</li>
		48	</ul>
40		49
41	<h1>Questions</h1>	50	<h1>Questions</h1>
42		51
43	<p><strong>Can I have reports run on a schedule?</strong></p>
44
45	<p>Yes, you can use the Task Scheduler tool.</p>
46
47	<ul><li><em>Get there:</em> More > Tools > Task Scheduler</li></ul>
48
49	<p><strong>Is there a repository for reports?</strong></p>	52	<p><strong>Is there a repository for reports?</strong></p>
50		53
51	<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>	54	<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>
Lines 55-68 Link Here
55	<p><strong>Can I have run-time defined parameters?</strong></p>	58	<p><strong>Can I have run-time defined parameters?</strong></p>
56		59
57	<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>	60	<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>
		61
58	<ul>	62	<ul>
59	<li>The << and >> are just delimiters. You must put << at the beginning and >> at the end of your parameter</li>	63	<li>The << and >> are just delimiters. You must put << at the beginning and >> at the end of your parameter</li>
60	<li>The <strong>Question to ask</strong> will be displayed on the left of the string to enter.	64	<li>The <strong>Question to ask</strong> will be displayed on the left of the string to enter.
61	<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>	65	<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>
62	</ul>	66	</ul>
		67
63	<p>Note that you can have more than one parameter in a given SQL</p>	68	<p>Note that you can have more than one parameter in a given SQL</p>
		69
64	<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>	70	<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>
		71
65	<p>Sample :</p>	72	<p>Sample :</p>
		73
66	<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>	74	<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>
67		75
		76	<p><strong>See the full documentation for Custom Reports in the <a href="http://manual.koha-community.org/3.6/en/reports.html#customreports">manual</a> (online).</strong></p>
		77
68	[% INCLUDE 'help-bottom.inc' %]	78	[% INCLUDE 'help-bottom.inc' %]

Lines 2-12 Link Here

(-)a/koha-tmpl/intranet-tmpl/prog/en/modules/help/reports/manager.tt (-8 / +9 lines)
2		2
3	<h1>Catalog by Item Type</h1>	3	<h1>Catalog by Item Type</h1>
4		4
5	<p>This one-step report will show you how many items of each item type are currently in your branch library or libraries.</p>	5	<p>This report will list the total number of items of each item type per branch.</p>
6		6
7	<ul>	7	<p>If you choose to output to the browser your results will print to the screen.</p>
8	<li>Go to the 'Reports' module (usually under 'More' in your Global Nav)</li>	8
9	<li>Choose 'Catalog by Item Type' under 'Other'</li>	9	<p>You can also choose to export to a file that you can manipulate to your needs.</p>
10	<li>Choose a branch (or choose the blank field at the top of the dropdown menu to choose all branches)</li>	10
11	<li>Click 'Submit'</li>	11	<p><strong>See the full documentation for the Catalog by Item Type report in the <a href="http://manual.koha-community.org/3.6/en/statsreports.html#catbyitem">manual</a> (online).</strong></p>
12	</ul>[% INCLUDE 'help-bottom.inc' %]	12
		13	[% INCLUDE 'help-bottom.inc' %]

Lines 2-14 Link Here

(-)a/koha-tmpl/intranet-tmpl/prog/en/modules/help/reports/reports-home.tt (-9 / +17 lines)
2		2
3	<h1>Reports</h1>	3	<h1>Reports</h1>
4		4
5	<h2>What Reports are there in Koha?</h2>	5	<p>Koha's reporting module allows you to gather data from your system. There are two main types of reports:
6
7	<p>Koha comes with a number of predefined (or "canned") reports, along with two report builder engines.</p>
8	<p><strong>Pre-defined Reports</strong></p>
9	<p>There are number of predefined reports in Koha. Check the Circulation module for additional Circulation specific reports.</p>
10	<p><strong>Statistics Wizards</strong></p>
11	<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>
12	<p><strong>Guided Reports Wizard</strong></p>
13	<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>[% INCLUDE 'help-bottom.inc' %]
14		6
		7	<ul>
		8	<li>Custom Reports
		9	<ul>
		10	<li>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.</li>
		11	</ul>
		12	</li>
		13	<li>Statistical Reports
		14	<ul>
		15	<li>Statistic reports will show you counts and sums. These reports are all about numbers and statistics, for reports that return more detailed data, use the Guided Report Wizard.</li>
		16	</ul>
		17	</li>
		18	</ul>
		19
		20	<p><strong>See the full documentation for Reports in the <a href="http://manual.koha-community.org/3.6/en/reports.html">manual</a> (online).</strong></p>
		21
		22	[% INCLUDE 'help-bottom.inc' %]

Lines 2-23 Link Here

(-)a/koha-tmpl/intranet-tmpl/prog/en/modules/help/reports/serials_stats.tt (-17 / +6 lines)
2		2
3	<h1>Serials Statistics</h1>	3	<h1>Serials Statistics</h1>
4		4
5	<p style="color: #990000">IMPORTANT: The Serials 'Wizard' is designed to be a simple	5	<p>Using the form provided, choose how you would like to list the serials in your system.</p>
6	statistical snapshot.
7	</p>
8	<ul>
9	<li>
10	Go to the 'Reports' module (usually under 'More' in your Global Nav)
11	</li>
12	<li>
13	Choose 'Serials' under 'Statistics Wizards'</li>
14	<li>Choose
15	your vendor and branch (or leave them both set to 'Any' to get
16	information on all subscriptions) and whether to include expired
17	subscriptions</li>
18	<li>Your results will appear as a list of subscriptions
19	</li>
20	</ul>
21		6
		7	<p>If you choose to output to the browser your results will print to the screen.</p>
		8
		9	<p>You can also choose to export to a file that you can manipulate to your needs.</p>
		10
		11	<p><strong>See the full documentation for Serials Statistics in the <a href="http://manual.koha-community.org/3.6/en/statsreports.html#serialstats">manual</a> (online).</strong></p>
22		12
23	[% INCLUDE 'help-bottom.inc' %]	13	[% INCLUDE 'help-bottom.inc' %]
24	-