Koha-Library-Software/C4/Create-Guided-Reports/English - Revision history

Madhurig at 14:09, 18 January 2026

2026-01-18T14:09:20Z

Madhurig at 14:01, 18 January 2026

2026-01-18T14:01:19Z

VaibhaviS: Created page with "'''Title of the Script: Create guided reports'''. '''Author: '''Maya Hans and Vaibhavi Satardekar '''Keywords:''' koha, koha 24.05, koha library system, reports module, guid..."

2025-12-12T06:04:32Z

Created page with "'''Title of the Script: Create guided reports'''. '''Author: '''Maya Hans and Vaibhavi Satardekar '''Keywords:''' koha, koha 24.05, koha library system, reports module, guid..."

New page

'''Title of the Script: Create guided reports'''.

'''Author: '''Maya Hans and Vaibhavi Satardekar

'''Keywords:''' koha, koha 24.05, koha library system, reports module, guided reports wizard, create report, tabular report, report criteria, cache expiry, sql reports, saved reports, library automation, video tutorial.

'''Prerequisite: '''Cataloging

{|border=1
|-
|| '''Visual Cue'''
|| '''Narration'''
|-
|| '''Slide Number 1'''

'''Title Slide'''
|| Welcome to this Spoken Tutorial on '''Create guided reports '''in '''Koha'''.
|-
|| '''Slide Number 2'''

'''Learning Objectives'''
* Create guided report

|| In this tutorial, we will learn to:
* Create a guided report in '''Koha'''.

|-
|| '''Slide Number 3'''

'''System Requirement'''
* '''Ubuntu Linux OS v22.04'''
* '''Koha v24.05'''
* '''Firefox v131.0.3'''
* '''A working internet connection'''

|| To record this tutorial, I am using the following setup.
|-
|| '''Slide Number 4'''

'''Prerequisites'''
* '''You should have knowledge of Library Science'''

|| To follow this tutorial you should have knowledge of Library Science.
|-
|| Show '''Koha''' interface

'''Username - Bella '''

'''Password - Library@1'''

'''Library: Spoken Tutorial Library'''

Click on '''Login'''
|| To create a simple guided report in '''Koha''', I have logged in as a '''Superlibrarian'''.
|-
|| Click on '''Reports '''module
|| On the '''Koha''' staff interface click on the '''Reports '''module.

The '''Reports''' module allows librarians to create, manage, and run reports for library operations.
|-
|| Point to '''Reports''' page

Point to '''Guided reports'''
* '''Create guided report''' for simple step-by-step reports,
* '''Create from SQL '''for advanced users, and
* '''Use saved '''to reuse existing reports

|| The''' Reports''' page opens.

Here under the '''Guided reports '''we see three types of reports:
* '''Create guided report''' for simple step-by-step reports,
* '''Create from SQL''' for advanced users, and
* '''Use saved''' to reuse existing reports.

|-
|| '''Slide Number 5'''

'''What is Create guided report?'''
* The create guided report is useful for beginners
* It allows you to generate basic reports by selecting modules and fields
* No '''SQL''' is needed

|| Now let’s create a guided report.
* The create guided report is useful for beginners.
* It allows you to generate basic reports by selecting modules and fields.
* No '''SQL''' is needed.

|-
|| Click on''' Create guided report'''

Point to''' Build a report''' page

'''Step 1 of 6 Choose a module to report on, Set cache expiry, and choose report visibility'''

'''Choose>>Catalog>>'''Click on '''Next'''
|| Click on '''Create guided report'''.

'''Build a report''' page opens, with the heading '''Step 1 of 6 Choose a module to report on, Set cache expiry, and choose report visibility'''.

From the '''Choose''' dropdown, select the '''Catalog''' module.

Next is the '''Report is public''' field, it controls the visibility of reports.

We will leave it as it is.

Next is the''' Cache expiry '''field.

It is the time in seconds for which '''Koha''' stores the report results.

We will keep it as default and click on the '''Next''' button.
|-
|| Point to '''Step 2 of 6 Pick a report type'''

'''Choose>>Tabular>>'''Click on '''Next'''
|| The heading changes to '''Step 2 of 6 Pick a report type'''.

From the '''Choose''' dropdown, select '''Tabular''' and click on the '''Next''' button.

|-
|| Point to '''Step 3 of 6 Select columns for display'''

Scroll down to '''Items '''heading

Title / biblio.title

Author / biblio.author

Date acquired / items.dateaccessioned

Price / items.price

Call number / items.itemcallnumber

Koha itemtype / items.itype

ISBN / biblioitems.isbn

Edition statement / biblioitems.editionstatement

Number of pages / biblioitems.pages

Click on '''Next '''button
| The heading '''Step 3 of 6 Select columns for display''' opens.

It allows us to choose which fields or columns we want to see in the report output.

On the left side, you can see the fields with their codes.

When you select a field, it appears in the right-side box for display in the report.

Pause the video, and select and '''Add''' the fields as shown and click on the '''Next '''button.
|-
| Point to '''Step 4 of 6 Select criteria to limit on'''

Narration only

Click on '''Next '''button

|| The heading '''Step 4 of 6 Select criteria to limit on''' opens.

Here you can choose a criteria to show only the records you want in the report.

I don’t want to apply any specific criteria.

So, I will leave it as it is and click the '''Next''' button.
|-
|| Point to '''Step 5 of 6 Pick which columns to total''' opens

Narration only

Click on '''Next '''button
|| The heading '''Step 5 of 6 Pick which columns to total''' opens.

Here you can choose columns to calculate totals.

I don’t want to total any columns, so I will leave it as it is and click the '''Next''' button.
|-
|| Point to '''Step 6 of 6 Choose how you want the report ordered'''

Narration only

Click on '''Finish '''button
|| The last '''Step 6 of 6 Choose how you want the report ordered''' appears.

Here you can decide the order of the report, for example by title, author, or item type.

I will leave the default order and click the '''Finish''' button.

Please note, clicking this will only create the report.
|-
|| Point to '''Confirm customer report'''

Point to '''Your report will be generated with the following SQL statement'''

Point to '''You will need to save the report before you can execute it'''

Click on '''Next''' button
|| '''Confirm customer report '''page opens.

Saying '''Your report will be generated with the following SQL statement'''.

'''You will need to save the report before you can execute it'''.

Click on the '''Next''' button.

|-
|| Point to '''Edit SQL report '''

Point to '''Your report has been saved'''

In the '''Report name''' field type '''sample report'''

Click on '''Update SQL''' button

|| '''Edit SQL report '''page opens.

The text highlighted in the blue box says '''Your report has been saved'''.

In the required '''Report name''' field type '''sample report'''.

Leave the other fields as such.

Scroll down to the bottom of the page, click on the '''Update SQL '''button.

With this we have successfully created a guided report.
|-
|| Narration only
|| This brings us to the end of this tutorial.
|-
|| '''Slide Number 6'''

'''Summary'''

In this tutorial we learned to-
* '''Create guided report'''

|| Let’s quickly recap.
|-
|| '''Slide Number 7'''

'''Assignment '''
* Create a guided report using the '''Circulation''' module
* Select '''card number''', '''first name''', and '''due date''' fields
* Save the report with the name '''Borrower Due Report'''

|| As an assignment,
* Create a guided report using the '''Circulation''' module.
* Select the '''card number''', '''first name''', and '''due date''' fields.
* Save the report with the name '''Borrower Due Report'''.

|-
|| '''Slide Number 8'''

'''Thank you'''
|| Thank you for joining.
|-
|}

@@ Line 16: / Line 16: @@
 '''Title Slide'''
-|| Welcome to this Spoken Tutorial on '''Create guided reports '''in '''Koha'''.
+|| Welcome to this Spoken Tutorial on '''Create Guided reports '''in '''Koha'''.
 |-
 || '''Slide Number 2'''
@@ Line 146: / Line 146: @@
 | The heading '''Step 3 of 6 Select columns for display''' opens.
-It allows us to choose the fields or columns we want to see in the report output.
+It allows us to choose the fields or columns to display in the report.
 On the left column, you can see the fields with their codes.
@@ Line 208: / Line 208: @@
 Click on the '''Next''' button.
@@ Line 221: / Line 220: @@
 || '''Edit SQL report '''page opens.
@@ Line 228: / Line 226: @@
 Leave the other fields as such.
-Scroll down to the bottom of the page and click on the '''Update SQL '''button.
+Scroll down to the bottom of the page and click on the '''Update SQL ''' button.
 The text highlighted in the blue box says '''Your report has been saved'''.

@@ Line 5: / Line 5: @@
 '''Keywords:''' koha, koha 24.05, koha library system, reports module, guided reports wizard, create report, tabular report, report criteria, cache expiry, sql reports, saved reports, library automation, video tutorial.
-'''Prerequisite: '''Cataloging
+'''Prerequisite''': '''Cataloging'''
 {|border=1
@@ Line 22: / Line 23: @@
 * Create guided report
-|| In this tutorial, we will learn to:
+|| In this tutorial, we will learn how to:
 * Create a guided report in '''Koha'''.
@@ Line 52: / Line 53: @@
 Click on '''Login'''
-|| To create a simple guided report in '''Koha''', I have logged in as a '''Superlibrarian'''.
+||  I have logged in as a '''Superlibrarian'''.
 |-
 || Click on '''Reports '''module
-|| On the '''Koha''' staff interface click on the '''Reports '''module.
+|| To create a simple guided report in '''Koha''', on the '''Koha''' staff interface click on the '''Reports '''module.
 The '''Reports''' module allows librarians to create, manage, and run reports for library operations.
@@ Line 68: / Line 69: @@
 || The''' Reports''' page opens.
-Here under the '''Guided reports '''we see three types of reports:
+Here under the '''Guided reports ''' we can see three types of reports:
 * '''Create guided report''' for simple step-by-step reports,
 * '''Create from SQL''' for advanced users, and
@@ Line 79: / Line 80: @@
 * The create guided report is useful for beginners
 * It allows you to generate basic reports by selecting modules and fields
-* No '''SQL''' is needed
+* '''SQL''' is not required for this module.
 || Now let’s create a guided report.
 * The create guided report is useful for beginners.
 * It allows you to generate basic reports by selecting modules and fields.
-* No '''SQL''' is needed.
+* '''SQL''' is not required for this module.
 |-
@@ Line 98: / Line 99: @@
 '''Build a report''' page opens, with the heading '''Step 1 of 6 Choose a module to report on, Set cache expiry, and choose report visibility'''.
-From the '''Choose''' dropdown, select the '''Catalog''' module.
+From the '''Choose''' drop down, select the '''Catalog''' module.
 Next is the '''Report is public''' field, it controls the visibility of reports.
@@ Line 104: / Line 105: @@
 We will leave it as it is.
-Next is the''' Cache expiry '''field.
+Next is the ''' Cache expiry '''field.
 It is the time in seconds for which '''Koha''' stores the report results.
@@ Line 115: / Line 116: @@
 || The heading changes to '''Step 2 of 6 Pick a report type'''.
-From the '''Choose''' dropdown, select '''Tabular''' and click on the '''Next''' button.
+From the '''Choose''' drop down, select '''Tabular''' and click on the '''Next''' button.
 |-
 || Point to '''Step 3 of 6 Select columns for display'''
 Scroll down to '''Items '''heading
@@ Line 143: / Line 146: @@
 | The heading '''Step 3 of 6 Select columns for display''' opens.
-It allows us to choose which fields or columns we want to see in the report output.
+It allows us to choose the fields or columns we want to see in the report output.
-On the left side, you can see the fields with their codes.
+On the left column, you can see the fields with their codes.
-When you select a field, it appears in the right-side box for display in the report.
+Select a field and click on '''Add''' to make it appear in the right column.
-Pause the video, and select and '''Add''' the fields as shown and click on the '''Next '''button.
+Pause the video, select and add the fields as shown.
 |-
 | Point to '''Step 4 of 6 Select criteria to limit on'''
@@ Line 163: / Line 168: @@
 I don’t want to apply any specific criteria.
-So, I will leave it as it is and click the '''Next''' button.
+So, I will leave it as it is and click on the '''Next''' button.
 |-
 || Point to '''Step 5 of 6 Pick which columns to total''' opens
@@ Line 174: / Line 179: @@
 Here you can choose columns to calculate totals.
-I don’t want to total any columns, so I will leave it as it is and click the '''Next''' button.
+I don’t want to total any columns, so I will leave it as it is and click on the '''Next''' button.
 |-
 || Point to '''Step 6 of 6 Choose how you want the report ordered'''
@@ Line 217: / Line 222: @@
 || '''Edit SQL report '''page opens.
-The text highlighted in the blue box says '''Your report has been saved'''.
 In the required '''Report name''' field type '''sample report'''.
@@ Line 223: / Line 228: @@
 Leave the other fields as such.
-Scroll down to the bottom of the page, click on the '''Update SQL '''button.
+Scroll down to the bottom of the page and click on the '''Update SQL '''button.
 With this we have successfully created a guided report.