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

(-)a/koha-tmpl/intranet-tmpl/prog/en/modules/help/reports/acquisitions_stats.tt (-2 / +2 lines)
Lines 1-6 Link Here
1
[% INCLUDE 'help-top.inc' %]
1
[% INCLUDE 'help-top.inc' %]
2
2
3
<h1>Acquisitions Statistics</h1>
3
<h1>Acquisitions statistics</h1>
4
4
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>
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
6
Lines 12-17 Link Here
12
12
13
<p>Choosing amount will change your results to appear as the sum of the amounts spent.</p>
13
<p>Choosing amount will change your results to appear as the sum of the amounts spent.</p>
14
14
15
<p><strong>See the full documentation for Acquisitions Statistics in the <a href="http://manual.koha-community.org/3.10/en/statsreports.html#acqstats">manual</a> (online).</strong></p>
15
<p><strong>See the full documentation for Acquisitions Statistics in the <a href="http://manual.koha-community.org/3.12/en/statsreports.html#acqstats">manual</a> (online).</strong></p>
16
16
17
[% INCLUDE 'help-bottom.inc' %]
17
[% INCLUDE 'help-bottom.inc' %]
(-)a/koha-tmpl/intranet-tmpl/prog/en/modules/help/reports/bor_issues_top.tt (-2 / +2 lines)
Lines 1-6 Link Here
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 report will simply list the patrons who have the most checkouts.</p>
5
<p>This report will simply list the patrons who have the most checkouts.</p>
6
6
Lines 8-13 Link Here
8
8
9
<p>You can also choose to export to a file that you can manipulate to your needs.</p>
9
<p>You can also choose to export to a file that you can manipulate to your needs.</p>
10
10
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.10/en/statsreports.html#mostcheckouts">manual</a> (online).</strong></p>
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.12/en/statsreports.html#mostcheckouts">manual</a> (online).</strong></p>
12
12
13
[% INCLUDE 'help-bottom.inc' %]
13
[% INCLUDE 'help-bottom.inc' %]
(-)a/koha-tmpl/intranet-tmpl/prog/en/modules/help/reports/borrowers_out.tt (-2 / +2 lines)
Lines 1-6 Link Here
1
[% INCLUDE 'help-top.inc' %]
1
[% INCLUDE 'help-top.inc' %]
2
2
3
<h1>Patrons With No Checkouts</h1>
3
<h1>Patrons with no checkouts</h1>
4
4
5
<p>This report will list for you the patrons in your system who haven't checked any items out.</p>
5
<p>This report will list for you the patrons in your system who haven't checked any items out.</p>
6
6
Lines 8-13 Link Here
8
8
9
<p>You can also choose to export to a file that you can manipulate to your needs.</p>
9
<p>You can also choose to export to a file that you can manipulate to your needs.</p>
10
10
11
<p><strong>See the full documentation for the Patrons with no Checkouts report in the <a href="http://manual.koha-community.org/3.10/en/statsreports.html#patnocheckouts">manual</a> (online).</strong></p>
11
<p><strong>See the full documentation for the Patrons with no Checkouts report in the <a href="http://manual.koha-community.org/3.12/en/statsreports.html#patnocheckouts">manual</a> (online).</strong></p>
12
12
13
[% INCLUDE 'help-bottom.inc' %]
13
[% INCLUDE 'help-bottom.inc' %]
(-)a/koha-tmpl/intranet-tmpl/prog/en/modules/help/reports/borrowers_stats.tt (-2 / +2 lines)
Lines 1-6 Link Here
1
[% INCLUDE 'help-top.inc' %]
1
[% INCLUDE 'help-top.inc' %]
2
2
3
<h1>Patron Statistics</h1>
3
<h1>Patron statistics</h1>
4
4
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>
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
6
Lines 8-14 Link Here
8
8
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>
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
10
11
<p><strong>See the full documentation for Patron Statistics in the <a href="http://manual.koha-community.org/3.10/en/statsreports.html#patstats">manual</a> (online).</strong></p>
11
<p><strong>See the full documentation for Patron Statistics in the <a href="http://manual.koha-community.org/3.12/en/statsreports.html#patstats">manual</a> (online).</strong></p>
12
12
13
[% INCLUDE 'help-bottom.inc' %]
13
[% INCLUDE 'help-bottom.inc' %]
14
14
(-)a/koha-tmpl/intranet-tmpl/prog/en/modules/help/reports/cat_issues_top.tt (-2 / +2 lines)
Lines 1-6 Link Here
1
[% INCLUDE 'help-top.inc' %]
1
[% INCLUDE 'help-top.inc' %]
2
2
3
<h1>Most Circulated Items</h1>
3
<h1>Most circulated items</h1>
4
4
5
<p>This report will simply list the items that have the been checked out the most.</p>
5
<p>This report will simply list the items that have the been checked out the most.</p>
6
6
Lines 8-13 Link Here
8
8
9
<p>You can also choose to export to a file that you can manipulate to your needs.</p>
9
<p>You can also choose to export to a file that you can manipulate to your needs.</p>
10
10
11
<p><strong>See the full documentation for the Most Circulation Items report in the <a href="http://manual.koha-community.org/3.10/en/statsreports.html#mostcirculated">manual</a> (online).</strong></p>
11
<p><strong>See the full documentation for the Most Circulation Items report in the <a href="http://manual.koha-community.org/3.12/en/statsreports.html#mostcirculated">manual</a> (online).</strong></p>
12
12
13
[% INCLUDE 'help-bottom.inc' %]
13
[% INCLUDE 'help-bottom.inc' %]
(-)a/koha-tmpl/intranet-tmpl/prog/en/modules/help/reports/catalogue_out.tt (-2 / +2 lines)
Lines 1-6 Link Here
1
[% INCLUDE 'help-top.inc' %]
1
[% INCLUDE 'help-top.inc' %]
2
2
3
<h1>Items With No Checkouts</h1>
3
<h1>Items with no checkouts</h1>
4
4
5
<p>This report will list items in your collection that have never been checked out.</p>
5
<p>This report will list items in your collection that have never been checked out.</p>
6
6
Lines 8-13 Link Here
8
8
9
<p>You can also choose to export to a file that you can manipulate to your needs.</p>
9
<p>You can also choose to export to a file that you can manipulate to your needs.</p>
10
10
11
<p><strong>See the full documentation for the Items with no Checkouts report in the <a href="http://manual.koha-community.org/3.10/en/statsreports.html#itemnocheckouts">manual</a> (online).</strong></p>
11
<p><strong>See the full documentation for the Items with no Checkouts report in the <a href="http://manual.koha-community.org/3.12/en/statsreports.html#itemnocheckouts">manual</a> (online).</strong></p>
12
12
13
[% INCLUDE 'help-bottom.inc' %]
13
[% INCLUDE 'help-bottom.inc' %]
(-)a/koha-tmpl/intranet-tmpl/prog/en/modules/help/reports/catalogue_stats.tt (-2 / +2 lines)
Lines 1-6 Link Here
1
[% INCLUDE 'help-top.inc' %]
1
[% INCLUDE 'help-top.inc' %]
2
2
3
<h1>Catalog Statistics</h1>
3
<h1>Catalog statistics</h1>
4
4
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>
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
6
Lines 8-14 Link Here
8
8
9
<p>You can also choose to export to a file that you can manipulate to your needs.</p>
9
<p>You can also choose to export to a file that you can manipulate to your needs.</p>
10
10
11
<p><strong>See the full documentation for Catalog Statistics in the <a href="http://manual.koha-community.org/3.10/en/statsreports.html#catstats">manual</a> (online).</strong></p>
11
<p><strong>See the full documentation for Catalog Statistics in the <a href="http://manual.koha-community.org/3.12/en/statsreports.html#catstats">manual</a> (online).</strong></p>
12
12
13
[% INCLUDE 'help-bottom.inc' %]
13
[% INCLUDE 'help-bottom.inc' %]
14
14
(-)a/koha-tmpl/intranet-tmpl/prog/en/modules/help/reports/dictionary.tt (-2 / +2 lines)
Lines 1-6 Link Here
1
[% INCLUDE 'help-top.inc' %]
1
[% INCLUDE 'help-top.inc' %]
2
2
3
<h1>Reports Dictionary</h1>
3
<h1>Reports dictionary</h1>
4
4
5
<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>
5
<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>
6
6
Lines 18-23 Link Here
18
18
19
<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>
19
<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>
20
20
21
<p><strong>See the full documentation for the Reports Dictionary in the <a href="http://manual.koha-community.org/3.10/en/reportdic.html">manual</a> (online).</strong></p>
21
<p><strong>See the full documentation for the Reports Dictionary in the <a href="http://manual.koha-community.org/3.12/en/reportdic.html">manual</a> (online).</strong></p>
22
22
23
[% INCLUDE 'help-bottom.inc' %]
23
[% INCLUDE 'help-bottom.inc' %]
(-)a/koha-tmpl/intranet-tmpl/prog/en/modules/help/reports/guided_reports.tt (-56 / +148 lines)
Lines 1-103 Link Here
1
[% INCLUDE 'help-top.inc' %]
1
[% INCLUDE 'help-top.inc' %]
2
2
3
<h1>Add a Custom Report</h1>
3
<h1>Add a custom report</h1>
4
4
5
<h2>Guided Report Wizard</h2>
5
<h3>Guided report wizard</h3>
6
6
7
<p>If the report you need is not already available, the 'Guided Reports' Wizard will walk you through creating a custom report.</p>
7
<p>The guided report wizard will walk you through a six step process to generate a report.</p>
8
8
9
<p><strong>Step 1:</strong> Choose the module you want to report on. This will determine what tables and fields are available for you to query.</p>
10
11
<p>'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.</p>
9
<ul>
12
<ul>
10
<li>Go to the 'Reports' module (usually under 'More' in your Global Nav)</li>
13
    <li>A public report is accessible via a URL that looks like this: http://MYOPAC/cgi-bin/koha/svc/report?id=REPORTID</li>
11
<li>Choose 'Guided Reports' under 'Guided Reports Wizard'</li>
12
</ul>
14
</ul>
15
<p><strong>Step 2:</strong> Choose a report type. For now, Tabular is the only option available.</p>
16
17
<p><strong>Step 3:</strong> 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.</p>
18
19
<p><strong>Step 4:</strong> 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.</p>
20
21
<p><strong>Step 5:</strong> Perform math functions. If you don't want to do any calculations, simply click Next instead of making an option.</p>
22
23
<p><strong>Step 6:</strong> Choose data order. If you want the data to print out in the order it's found in the database, simply click Finish.</p>
24
25
<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>
13
26
14
<p>Answer the 6 questions presented in order to create your report.</p>
27
<p>If you choose to save the report you will be asked to name your report, sort it in to groups and subgroups and enter any notes regarding it.</p>
15
28
16
<p><strong>Step 1: Choose a Module to Report on</strong></p>
29
<p>Once your report is saved it will appear on the 'Use Saved' page with all other saved reports.</p>
17
30
31
<p>From here you can make edits, run the report, or schedule a time to have the report run. To find the report you created you can sort by any of the columns by clicking the on the column header (creation date is the best bet for finding the report you just added). You can also filter your results using the filter menu on the left or use the tabs to find reports based on your custom groups.</p>
32
33
<h3>Report from SQL</h3>
34
35
<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" target="blank">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://schema.koha-community.org" target="blank">http://schema.koha-community.org</a>.</p>
36
37
<p>To add your query, click the link to 'Create from SQL' on the main reports module or the 'New report' button at the top of the 'Saved reports' page.</p>
38
39
<p>Fill in the form presented</p>
40
<ul>
41
	<li>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.</li>
42
	<li>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 or can be added on the fly when creating the report by choosing the 'or create' radio button.
18
<ul>
43
<ul>
19
<li>Choose a Koha module to build a report on (patrons, circ, cataloging, etc)</li>
44
	<li style="background-color: #ffe599;">Tip: If you're adding a report group on the fly, remember that you code should be fewer than 10 characters and should not include special characters or spaces.</li>
20
<li>Click 'Next'</li>
21
</ul>
45
</ul>
46
</li>
47
	<li>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 or can be added on the fly when creating the report by choosing the 'or create' radio button.
48
<ul>
49
	<li style="background-color: #ffe599;">Tip: If you're adding a report subgroup on the fly, remember that you code should be fewer than 10 characters and should not include special characters or spaces.</li>
50
</ul>
51
</li>
52
	<li>'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.
53
<ul>
54
	<li>A public report is accessible via a URL that looks like this: http://MYOPAC/cgi-bin/koha/svc/report?id=REPORTID</li>
55
</ul>
56
</li>
57
	<li>'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</li>
58
	<li>The type should always be 'Tabular' at this time since the other formats have not been implemented</li>
59
	<li>In the 'SQL' box you will type or paste the SQL for the report</li>
60
	<li>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 &lt;&lt;Question to ask authorized_value&gt;&gt;.
61
<ul>
62
	<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>
63
	<li>The 'Question to ask' will be displayed on the left of the string to enter.</li>
64
	<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=&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</li>
65
</ul>
66
</li>
67
	<li>Examples:
68
<ul>
69
	<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>
70
	<li>SELECT * FROM items WHERE homebranch = &lt;&lt;Pick your branch|branches&gt;&gt; and barcode like &lt;&lt;Partial barcode value here&gt;&gt;</li>
71
</ul>
72
</li>
73
	<li style="background-color: #ffe599;">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: &lt;&lt;Enter Date|date&gt;&gt;
74
</li>
75
	<li 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.</li>
76
	<li style="color: #990000;">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 &lt;&lt;Branch|branches&gt;&gt;</li>
77
</ul>
78
79
<p><strong>Note</strong>: 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.</p>
80
81
<p>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.</p>
82
83
<h3>Duplicate Report</h3>
84
85
<p>Reports can also be added by duplicating an existing report. Visit the 'Saved reports' page to see all of the reports listed on your system already.</p>
86
87
<p>To the right of every report there is a 'Duplicate' link in the 'Saved SQL' column. Click that 'Duplicate' link to use an existing report as the basis for your new report. That will populate the new report form with the existing SQL for easy editing and resaving.</p>
22
88
23
<p><strong>Step 2: Pick a Report Type</strong></p>
89
<h3>Edit Custom Reports</h3>
24
90
25
<ul><li style="color: #990000">IMPORTANT: Only Tabular should be chosen with this option</li></ul>
91
<p>Every report can be edited from the reports lists. To see the list of reports already stored in Koha, click 'Use Saved.'</p>
26
92
27
<p><strong>Step 3: Select Columns for Display</strong></p>
93
<p>To find the report you'd like to edit you can sort by any of the columns by clicking the on the column header. You can also filter your results using the filter menu on the left or use the tabs to find reports based on your custom groups.</p>
28
94
29
<p><strong>Step 4: Select Criteria to Limit</strong></p>
95
<p>From this list you can edit any custom report by clicking 'Edit' in the 'Saved SQL' column.</p>
30
96
31
<ul><li>This is optional, if you don't want to limit results by any one field, just leave this section blank.</li></ul>
97
<h3>Running Custom Reports</h3>
32
98
33
<p><strong>Step 5: Pick which columns to perform mathmatical functions on</strong></p>
99
<p>Once custom reports are saved to Koha, you can run them by going to the Saved Reports page and clicking the 'Run' link to the right of the report.</p>
34
100
35
<ul><li>This is optional, if you don't want to do any math on the results, just leave this section blank.</li></ul>
101
<p>When you report runs you will either be asked for some value or you will see the results right away</p>
36
102
37
<p><strong>Step 6: Choose how you want the report ordered</strong></p>
103
<p>From the results you can choose to rerun the report by clicking 'Run report' at the top, edit the report by clicking the 'Edit' button or starting over and creating a new report by using the 'New' button. You can also download your results by choosing a file type at the bottom of the results next to the 'Download the report' label and clicking 'Download.'</p>
38
104
39
<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>
105
<p style="background-color: #ffe599;">Tip:  A Comma Separated Text file is a CSV file and it can be opened by any spreadsheet application.</p>
40
106
41
<h2>Edit Reports</h2>
107
<h3>DB table value for reports</h3>
42
108
43
<p>Custom reports can be edited in their entirety from the Saved Guided Reports page.</p>
109
<p><strong>Question:</strong> What do the codes in the accounttype field in the accountlines table stand for?</p>
44
110
45
<ul><li><em>Get there:</em> More > Reports > Guided Reports > Use Saved</li></ul>
111
<p><strong>Answer:</strong></p>
46
112
47
<ul>
113
<ul>
48
<li>To edit a report click 'Edit SQL' beside the report</li>
114
	<li>A = Account management fee</li>
49
<li>A page with editable fields will open so that you can change the title, notes and SQL related to the report</li>
115
	<li>C = Credit</li>
116
	<li>F = Overdue fine</li>
117
	<li>FOR = Forgiven</li>
118
	<li>FU = Overdue, still acccruing</li>
119
	<li>L = Lost item</li>
120
	<li>LR = Lost item returned/refunded</li>
121
	<li>M = Sundry</li>
122
	<li>N = New card</li>
123
	<li>PAY = Payment</li>
124
	<li>W = Writeoff</li>
50
</ul>
125
</ul>
51
126
52
<h2>Report from SQL</h2>
127
<p><strong>Question:</strong> What are the possible codes for the type field in the statistics table?</p>
53
128
54
<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" target="_top">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://schema.koha-community.org/" target="_top">http://schema.koha-community.org</a>.</p>
129
<p><strong>Answer:</strong></p>
55
130
56
<p>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.</p>
57
58
<p>Fill in the form presented</p>
59
<ul>
131
<ul>
60
    <li>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.</li>
132
	<li>localuse
61
    <li>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.</li>
62
    <li>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.</li>
63
    <li>'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.
64
<ul>
133
<ul>
65
    <li>A public report is accessible via a URL that looks like this: http://MYOPAC/cgi-bin/koha/svc/report?id=REPORTID</li>
134
	<li>Registers if an item that had been checked out to a statistics patron (category type = 'X') is returned</li>
66
</ul>
135
</ul>
67
</li>
136
</li>
68
    <li>'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</li>
137
	<li>issue</li>
69
    <li>The type should always be 'Tabular' at this time since theother formats have not been implemented</li>
138
	<li>return</li>
70
    <li>In the 'SQL' box you will type or paste the SQL for the report</li>
139
	<li>renew</li>
71
    <li>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 &lt;&lt;Question to ask|authorized_value&gt;&gt;.
140
	<li>writeoff</li>
141
	<li>payment</li>
142
	<li>CreditXXX
72
<ul>
143
<ul>
73
    <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>
144
	<li>stores different types of fee credits, so a query to catch them all would include a clause like "type LIKE 'Credit%'"</li>
74
    <li>The 'Question to ask' will be displayed on the left of the string to enter.</li>
75
    <li>The authorized_value can be omitted if not applicable. If it contains an authorized value category, or libraries 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=&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</li>
76
</ul>
145
</ul>
77
<p>Examples:</p>
146
</li>
147
</ul>
148
149
<p><strong>Question</strong>: What are the possible codes for the found field in the reserves and old_reserves tables?</p>
150
151
<p><strong>Answer</strong>:</p>
152
78
<ul>
153
<ul>
79
    <li>SELECT surname, firstname<br />
154
	<li>NULL: means the patron requested the 1st available, and we haven't chosen the item</li>
80
FROM borrowers <br />
155
	<li>T = Transit: the reserve is linked to an item but is in transit to the pickup branch</li>
81
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>
156
	<li>W =Waiting: the reserve is linked to an item, is at the pickup branch, and is waiting on the hold shelf</li>
82
    <li>SELECT * <br />
157
	<li>F = Finished: the reserve has been completed, and is done</li>
83
FROM items <br />
84
WHERE homebranch = &lt;&lt;Pick your library|branches&gt;&gt; AND barcode like &lt;&lt;Partial barcode value here&gt;&gt;</li>
85
</ul>
158
</ul>
86
</li>
159
87
    <li>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: &lt;&lt;Enter Date|date&gt;&gt;</li>
160
<p><strong>Question</strong>: What are the possible codes for the area field in the reports_dictionary table?</p>
88
    <li>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.</li>
161
89
    <li style="color: #990000">Important: In addition to using any authorized value code to generate a dropdown, you can use the following values as well: Libraries (branches), Item Types (itemtypes) and Patron Categories (categorycode). For example a library pull down would be generated like this &lt;&lt;Library|branches&gt;&gt;</li>
162
<p><strong>Answer</strong>:</p>
163
164
<ul>
165
	<li>1 = Circulation</li>
166
	<li>2 = Catalog</li>
167
	<li>3 = Patrons</li>
168
	<li>4 = Acquistions</li>
169
	<li>5 = Accounts</li>
90
</ul>
170
</ul>
91
171
92
<p>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.</p>
172
<p><strong>Question</strong>: What are the possible codes for the message_type field in the messages table?</p>
93
173
94
<p>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.</p>
174
<p><strong>Answer</strong>:</p>
175
176
<ul>
177
	<li>L = For Librarians</li>
178
	<li>B = For Patrons/Borrowers</li>
179
</ul>
95
180
96
<p><strong>Is there a repository for reports?</strong></p>
181
<p><strong>Question</strong>: What are the possible codes for the status field in the serial table"?</p>
97
182
98
<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>
183
<p><strong>Answer</strong>:</p>
99
184
100
<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>
185
<ul>
186
	<li>1 = Expected</li>
187
	<li>2 = Arrived</li>
188
	<li>3 = Late</li>
189
	<li>4 = Missing</li>
190
	<li>5 = Not Available</li>
191
	<li>6 = Delete</li>
192
</ul>
101
193
102
<p><strong>See the full documentation for Custom Reports in the <a href="http://manual.koha-community.org/3.10/en/reports.html#customreports">manual</a> (online).</strong></p>
194
<p><strong>See the full documentation for Custom Reports in the <a href="http://manual.koha-community.org/3.10/en/reports.html#customreports">manual</a> (online).</strong></p>
103
195
(-)a/koha-tmpl/intranet-tmpl/prog/en/modules/help/reports/issues_avg_stats.tt (-2 / +2 lines)
Lines 1-6 Link Here
1
[% INCLUDE 'help-top.inc' %]
1
[% INCLUDE 'help-top.inc' %]
2
2
3
<h1>Average Loan Time</h1>
3
<h1>Average loan time</h1>
4
4
5
<p>This report will list the average time items are out on loan based on the criteria you enter</p>
5
<p>This report will list the average time items are out on loan based on the criteria you enter</p>
6
6
Lines 8-13 Link Here
8
8
9
<p>You can also choose to export to a file that you can manipulate to your needs.</p>
9
<p>You can also choose to export to a file that you can manipulate to your needs.</p>
10
10
11
<p><strong>See the full documentation for the Average Loan Time report in the <a href="http://manual.koha-community.org/3.10/en/statsreports.html#avloantime">manual</a> (online).</strong></p>
11
<p><strong>See the full documentation for the Average Loan Time report in the <a href="http://manual.koha-community.org/3.12/en/statsreports.html#avloantime">manual</a> (online).</strong></p>
12
12
13
[% INCLUDE 'help-bottom.inc' %]
13
[% INCLUDE 'help-bottom.inc' %]
(-)a/koha-tmpl/intranet-tmpl/prog/en/modules/help/reports/issues_stats.tt (-2 / +2 lines)
Lines 1-6 Link Here
1
[% INCLUDE 'help-top.inc' %]
1
[% INCLUDE 'help-top.inc' %]
2
2
3
<h1>Circulation Statistics</h1>
3
<h1>Circulation statistics</h1>
4
4
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>
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
6
Lines 19-24 Link Here
19
	<li>For a single day, an example would be: 11/15/2009 to 11/16/2009 to find what circulated on the 15th</li>
19
	<li>For a single day, an example would be: 11/15/2009 to 11/16/2009 to find what circulated on the 15th</li>
20
</ul>
20
</ul>
21
21
22
<p><strong>See the full documentation for Circulation Statistics in the <a href="http://manual.koha-community.org/3.10/en/statsreports.html#circstats">manual</a> (online).</strong></p>
22
<p><strong>See the full documentation for Circulation Statistics in the <a href="http://manual.koha-community.org/3.12/en/statsreports.html#circstats">manual</a> (online).</strong></p>
23
23
24
[% INCLUDE 'help-bottom.inc' %]
24
[% INCLUDE 'help-bottom.inc' %]
(-)a/koha-tmpl/intranet-tmpl/prog/en/modules/help/reports/itemslost.tt (-2 / +2 lines)
Lines 1-6 Link Here
1
[% INCLUDE 'help-top.inc' %]
1
[% INCLUDE 'help-top.inc' %]
2
2
3
<h1>Lost Items</h1>
3
<h1>Lost items</h1>
4
4
5
<p> This one-step report will show you how many items of each item type are currently in your library or libraries.</p>
5
<p> This one-step report will show you how many items of each item type are currently in your library or libraries.</p>
6
6
Lines 16-21 Link Here
16
		</ul>
16
		</ul>
17
	</div>	
17
	</div>	
18
18
19
<p><strong>See the full documentation for the Lost Items report in the <a href="http://manual.koha-community.org/3.10/en/statsreports.html#lostreport">manual</a> (online).</strong></p>
19
<p><strong>See the full documentation for the Lost Items report in the <a href="http://manual.koha-community.org/3.12/en/statsreports.html#lostreport">manual</a> (online).</strong></p>
20
	
20
	
21
[% INCLUDE 'help-bottom.inc' %]
21
[% INCLUDE 'help-bottom.inc' %]
(-)a/koha-tmpl/intranet-tmpl/prog/en/modules/help/reports/manager.tt (-2 / +2 lines)
Lines 1-6 Link Here
1
[% INCLUDE 'help-top.inc' %]
1
[% INCLUDE 'help-top.inc' %]
2
2
3
<h1>Catalog by Item Type</h1>
3
<h1>Catalog by item type</h1>
4
4
5
<p>This report will list the total number of items of each item type per library.</p>
5
<p>This report will list the total number of items of each item type per library.</p>
6
6
Lines 8-13 Link Here
8
8
9
<p>You can also choose to export to a file that you can manipulate to your needs.</p>
9
<p>You can also choose to export to a file that you can manipulate to your needs.</p>
10
10
11
<p><strong>See the full documentation for the Catalog by Item Type report in the <a href="http://manual.koha-community.org/3.10/en/statsreports.html#catbyitem">manual</a> (online).</strong></p>
11
<p><strong>See the full documentation for the Catalog by Item Type report in the <a href="http://manual.koha-community.org/3.12/en/statsreports.html#catbyitem">manual</a> (online).</strong></p>
12
12
13
[% INCLUDE 'help-bottom.inc' %]
13
[% INCLUDE 'help-bottom.inc' %]
(-)a/koha-tmpl/intranet-tmpl/prog/en/modules/help/reports/reports-home.tt (-1 / +1 lines)
Lines 19-24 Link Here
19
</li>
19
</li>
20
</ul>
20
</ul>
21
21
22
<p><strong>See the full documentation for Reports in the <a href="http://manual.koha-community.org/3.10/en/reports.html">manual</a> (online).</strong></p>
22
<p><strong>See the full documentation for Reports in the <a href="http://manual.koha-community.org/3.12/en/reports.html">manual</a> (online).</strong></p>
23
23
24
[% INCLUDE 'help-bottom.inc' %]
24
[% INCLUDE 'help-bottom.inc' %]
(-)a/koha-tmpl/intranet-tmpl/prog/en/modules/help/reports/reserves_stats.tt (-2 / +2 lines)
Lines 1-6 Link Here
1
[% INCLUDE 'help-top.inc' %]
1
[% INCLUDE 'help-top.inc' %]
2
2
3
<h1>Holds Statistics</h1>
3
<h1>Holds statistics</h1>
4
4
5
<p><strong>Note:</strong> These reports are limited in what data they can look at, so it's often recommended to use custom reports for official end of the year statistics.</p>
5
<p><strong>Note:</strong> These reports are limited in what data they can look at, so it's often recommended to use custom reports for official end of the year statistics.</p>
6
6
Lines 10-15 Link Here
10
10
11
<p>You can also choose to export to a file that you can manipulate to your needs.</p>
11
<p>You can also choose to export to a file that you can manipulate to your needs.</p>
12
12
13
<p><strong>See the full documentation for Holds Statistics in the <a href="manual.koha-community.org/3.10/en/statsreports.html#holdstats">manual</a> (online).</strong></p>
13
<p><strong>See the full documentation for Holds Statistics in the <a href="http://manual.koha-community.org/3.12/en/statsreports.html#holdstats">manual</a> (online).</strong></p>
14
14
15
[% INCLUDE 'help-bottom.inc' %]
15
[% INCLUDE 'help-bottom.inc' %]
(-)a/koha-tmpl/intranet-tmpl/prog/en/modules/help/reports/serials_stats.tt (-3 / +2 lines)
Lines 1-6 Link Here
1
[% INCLUDE 'help-top.inc' %]
1
[% INCLUDE 'help-top.inc' %]
2
2
3
<h1>Serials Statistics</h1>
3
<h1>Serials statistics</h1>
4
4
5
<p>Using the form provided, choose how you would like to list the serials in your system.</p>
5
<p>Using the form provided, choose how you would like to list the serials in your system.</p>
6
6
Lines 8-13 Link Here
8
8
9
<p>You can also choose to export to a file that you can manipulate to your needs.</p>
9
<p>You can also choose to export to a file that you can manipulate to your needs.</p>
10
10
11
<p><strong>See the full documentation for Serials Statistics in the <a href="http://manual.koha-community.org/3.10/en/statsreports.html#serialstats">manual</a> (online).</strong></p>
11
<p><strong>See the full documentation for Serials Statistics in the <a href="http://manual.koha-community.org/3.12/en/statsreports.html#serialstats">manual</a> (online).</strong></p>
12
12
13
[% INCLUDE 'help-bottom.inc' %]
13
[% INCLUDE 'help-bottom.inc' %]
14
- 

Return to bug 9850