Bug 31638 - [DOCS] Log viewer - Expand section and add descriptions for objects and actions
Summary: [DOCS] Log viewer - Expand section and add descriptions for objects and actions
Status: Needs documenting
Alias: None
Product: Koha
Classification: Unclassified
Component: Documentation (show other bugs)
Version: Main
Hardware: All All
: P5 - low enhancement (vote)
Assignee: Bugs List
QA Contact: Testopia
: 29784 (view as bug list)
Depends on:
Reported: 2022-09-27 20:43 UTC by David Nind
Modified: 2023-06-24 18:00 UTC (History)
1 user (show)

See Also:
Change sponsored?: ---
Patch complexity: ---
Documentation contact:
Documentation submission:
Text to go in the release notes:
Version(s) released in:


Note You need to log in before you can comment on or make changes to this bug.
Description David Nind 2022-09-27 20:43:53 UTC
In the manual, there is currently no description or information about how to use the objects and action fields in the log viewer.

The section could also be expanded.

Resources to help with this:
- SQL Reports Library. https://wiki.koha-community.org/wiki/SQL_Reports_Library#action_logs
- ByWater Solutions. Monday Minutes : Using the Logs. 18 January 2021. https://bywatersolutions.com/education/to-log-or-not-to-log
- Mailing list thread: https://lists.katipo.co.nz/pipermail/koha/2022-September/058489.html

Manual reference: https://koha-community.org/manual/22.11/en/html/tools.html#log-viewer
Comment 1 Katrin Fischer 2023-06-24 17:59:44 UTC
*** Bug 29784 has been marked as a duplicate of this bug. ***
Comment 2 Katrin Fischer 2023-06-24 18:00:05 UTC
Moving Kelly's comment here:

(In reply to Kelly McElligott from comment #0)
> There is a super handy chart in the Koha Report Wiki that helps users
> understand what fields need what information when running the log viewer. 
> This is an extremely useful chart and one that would benefit from being in
> the manual as well.  If a user went to the log viewer page in the Staff
> Interface, it would be nice if they did need help, the "Help" button would
> bring them to the manual where the instructions on how to use the log viewer
> and the handy chart information could live together.
> This is the chart I am referring to:
> https://wiki.koha-community.org/wiki/SQL_Reports_Library#action_logs
> Currently, this is all that lives in the manual for using the logs:
> https://koha-community.org/manual//21.05/en/html/tools.html#log-viewer