Bug 32312 - Complete database column descriptions for circulation module in guided reports
Summary: Complete database column descriptions for circulation module in guided reports
Status: Pushed to oldstable
Alias: None
Product: Koha
Classification: Unclassified
Component: I18N/L10N (show other bugs)
Version: Main
Hardware: All All
: P5 - low minor (vote)
Assignee: David Nind
QA Contact: Martin Renvoize
URL:
Keywords: Academy
Depends on: 29695 32292
Blocks:
  Show dependency treegraph
 
Reported: 2022-11-21 22:26 UTC by Katrin Fischer
Modified: 2023-11-13 15:29 UTC (History)
7 users (show)

See Also:
Change sponsored?: ---
Patch complexity: Small patch
Documentation contact:
Documentation submission:
Text to go in the release notes:
This adds and clarifies database column descriptions shown for the statistics table when creating a guided report for the circulation module. Previously, some columns didn't have a description or were ambiguous.
Version(s) released in:
23.11.00,23.05.06,22.11.12


Attachments
Bug 32312: Add missing column descriptions to the statistics table (2.84 KB, patch)
2022-12-04 01:49 UTC, David Nind
Details | Diff | Splinter Review
Bug 32312: Add missing column descriptions to the statistics table (2.90 KB, patch)
2022-12-09 19:32 UTC, ByWater Sandboxes
Details | Diff | Splinter Review
Bug 32312: Add missing column descriptions to the statistics table (2.94 KB, patch)
2023-01-31 14:25 UTC, Martin Renvoize
Details | Diff | Splinter Review
Bug 32312: Add missing column descriptions to the statistics table (8.63 KB, patch)
2023-10-29 11:39 UTC, Katrin Fischer
Details | Diff | Splinter Review

Note You need to log in before you can comment on or make changes to this bug.
Comment 1 Katrin Fischer 2022-11-21 22:39:49 UTC
There are entries missing for the statistics table.

How to test:
* Add a new guided report
* Select module circulation
* Verify that statistics is missing some descriptions, only showing the
  database value
Comment 2 David Nind 2022-12-04 01:49:18 UTC
Created attachment 144415 [details] [review]
Bug 32312: Add missing column descriptions to the statistics table

This adds missing descriptions to the existing statistics database
columns.

It also improves some existing descriptions.

1. Go to Reports > Guided reports > Create guided report.
2. Choose 'Circulation' for the module to report on and select
   'Next'.
3. Choose 'Tabular' for the type of report and select 'Next'.
4. Scroll down to the statistics table section and note that there
   are no descriptions for:
   - statistics.other
   - statistics.location
   - statistics.ccode
   - statistics.categorycode
5. Note that:
   - the description for statistics.type is 'Type'
   - the description for statistics.itemtype is 'Item type'
6. Apply the patch.
7. Restart all the things (restart_all).
8. Reload the page.
9. Note that:
   . there are now descriptions for the columns in step 4
   . the description for statistics.type is now 'Transaction type'
     (to more clearly indicate what it contains)
   . the description for statistics.itemtype is now 'Koha item type'
     (consistent with other tables where this is used, such as items)
10. Sign off :D

Signed-off-by: David Nind <david@davidnind.com>
Comment 3 David Nind 2022-12-04 02:05:12 UTC
For the statistics.other description:

1. C4/Stats.pm and C4/Circulation.pm indicate that the other field is used to record "sipmode".

2. The database schema comment is "used by SIP".

I used the description 'SIP mode', although I'm not sure exactly what this means or records for a SIP transaction.

I tried a checkout and a check in using SIP, but it didn't record anything additional in the column.
Comment 4 ByWater Sandboxes 2022-12-09 19:32:21 UTC
Created attachment 144532 [details] [review]
Bug 32312: Add missing column descriptions to the statistics table

This adds missing descriptions to the existing statistics database
columns.

It also improves some existing descriptions.

1. Go to Reports > Guided reports > Create guided report.
2. Choose 'Circulation' for the module to report on and select
   'Next'.
3. Choose 'Tabular' for the type of report and select 'Next'.
4. Scroll down to the statistics table section and note that there
   are no descriptions for:
   - statistics.other
   - statistics.location
   - statistics.ccode
   - statistics.categorycode
5. Note that:
   - the description for statistics.type is 'Type'
   - the description for statistics.itemtype is 'Item type'
6. Apply the patch.
7. Restart all the things (restart_all).
8. Reload the page.
9. Note that:
   . there are now descriptions for the columns in step 4
   . the description for statistics.type is now 'Transaction type'
     (to more clearly indicate what it contains)
   . the description for statistics.itemtype is now 'Koha item type'
     (consistent with other tables where this is used, such as items)
10. Sign off :D

Signed-off-by: David Nind <david@davidnind.com>

Signed-off-by: Andrew Fuerste-Henry <andrewfh@dubcolib.org>
Comment 5 Martin Renvoize 2023-01-31 14:25:46 UTC
Created attachment 145875 [details] [review]
Bug 32312: Add missing column descriptions to the statistics table

This adds missing descriptions to the existing statistics database
columns.

It also improves some existing descriptions.

1. Go to Reports > Guided reports > Create guided report.
2. Choose 'Circulation' for the module to report on and select
   'Next'.
3. Choose 'Tabular' for the type of report and select 'Next'.
4. Scroll down to the statistics table section and note that there
   are no descriptions for:
   - statistics.other
   - statistics.location
   - statistics.ccode
   - statistics.categorycode
5. Note that:
   - the description for statistics.type is 'Type'
   - the description for statistics.itemtype is 'Item type'
6. Apply the patch.
7. Restart all the things (restart_all).
8. Reload the page.
9. Note that:
   . there are now descriptions for the columns in step 4
   . the description for statistics.type is now 'Transaction type'
     (to more clearly indicate what it contains)
   . the description for statistics.itemtype is now 'Koha item type'
     (consistent with other tables where this is used, such as items)
10. Sign off :D

Signed-off-by: David Nind <david@davidnind.com>
Signed-off-by: Andrew Fuerste-Henry <andrewfh@dubcolib.org>
Signed-off-by: Martin Renvoize <martin.renvoize@ptfs-europe.com>
Comment 6 Martin Renvoize 2023-01-31 14:26:09 UTC
Thanks David, Passing QA
Comment 7 Tomás Cohen Arazi 2023-02-03 13:31:56 UTC
Please rebase.
Comment 8 Katrin Fischer 2023-10-29 11:39:33 UTC
Created attachment 158037 [details] [review]
Bug 32312: Add missing column descriptions to the statistics table

This adds missing descriptions to the existing statistics database
columns.

It also improves some existing descriptions.

1. Go to Reports > Guided reports > Create guided report.
2. Choose 'Circulation' for the module to report on and select
   'Next'.
3. Choose 'Tabular' for the type of report and select 'Next'.
4. Scroll down to the statistics table section and note that there
   are no descriptions for:
   - statistics.other
   - statistics.location
   - statistics.ccode
   - statistics.categorycode
5. Note that:
   - the description for statistics.type is 'Type'
   - the description for statistics.itemtype is 'Item type'
6. Apply the patch.
7. Restart all the things (restart_all).
8. Reload the page.
9. Note that:
   . there are now descriptions for the columns in step 4
   . the description for statistics.type is now 'Transaction type'
     (to more clearly indicate what it contains)
   . the description for statistics.itemtype is now 'Koha item type'
     (consistent with other tables where this is used, such as items)
10. Sign off :D

Signed-off-by: David Nind <david@davidnind.com>
Signed-off-by: Andrew Fuerste-Henry <andrewfh@dubcolib.org>
Signed-off-by: Martin Renvoize <martin.renvoize@ptfs-europe.com>
Signed-off-by: Katrin Fischer <katrin.fischer.83@web.de>
Comment 9 Tomás Cohen Arazi 2023-10-30 12:03:10 UTC
Pushed to master for 23.11.

Nice work everyone, thanks!
Comment 10 Fridolin Somers 2023-11-08 08:13:22 UTC
Pushed to 23.05.x for 23.05.06
Comment 11 Matt Blenkinsop 2023-11-13 15:29:13 UTC
Nice work everyone!

Pushed to oldstable for 22.11.x