Bug 30715 - Terminology: Logs should use staff interface and not intranet for the interface
Summary: Terminology: Logs should use staff interface and not intranet for the interface
Status: Pushed to oldoldstable
Alias: None
Product: Koha
Classification: Unclassified
Component: Transaction logs (show other bugs)
Version: Main
Hardware: All All
: P5 - low minor
Assignee: David Nind
QA Contact: Emily Lamancusa (emlam)
URL:
Keywords: Academy
Depends on:
Blocks:
 
Reported: 2022-05-06 21:12 UTC by David Nind
Modified: 2024-09-12 02:05 UTC (History)
6 users (show)

See Also:
Change sponsored?: ---
Patch complexity: Trivial patch
Documentation contact: Caroline Cyr La Rose
Documentation submission: https://gitlab.com/koha-community/koha-manual/-/merge_requests/954
Text to go in the release notes:
This fixes the log viewer so that 'Staff interface' is used instead of 'Intranet' for the filtering option and the value displayed in the log entries interface column. Note: This does not fix the underlying value recorded in the action_log table (these are added as 'intranet' to the interface column), or the values shown in CSV exports.
Version(s) released in:
24.11.00,24.05.02,23.11.07,23.05.15
Circulation function:

Attachments
Bug 30715: Terminology for the log viewer - use 'Staff interface' instead of 'Intranet' (2.34 KB, patch)
2024-06-03 02:07 UTC, David Nind 		Details | Diff | Splinter Review
Bug 30715: Terminology for the log viewer - use 'Staff interface' instead of 'Intranet' (2.39 KB, patch)
2024-06-03 21:11 UTC, Lucas Gass (lukeg) 		Details | Diff | Splinter Review
Bug 30715: Terminology for the log viewer - use 'Staff interface' instead of 'Intranet' (2.46 KB, patch)
2024-06-12 14:56 UTC, Emily Lamancusa (emlam) 		Details | Diff | Splinter Review
Show Obsolete (2) View All Add an attachment (proposed patch, testcase, etc.)

Note You need to log in before you can comment on or make changes to this bug.
Description David Nind 2022-05-06 21:12:39 UTC 
When logs are enabled and an action is performed in the staff interface, it is displayed in the log interface column as "Intranet".

This should be displayed as "Staff interface", as per the terminology guidelines: https://wiki.koha-community.org/wiki/Terminology#I

To reproduce:

1. Any action logged by the staff interface should show this in the log viewer.

2. Example:
   . Enable logs for cataloging (enabled by default in koha-testing-docker) (CataloguingLog system preference).
   . For a record, change the shelving location for any item to something else.
   . Check the logs (Tools > Additional tools > Log viewer then Submit).
   . The interface column shows that the change was made in the "Intranet".
Comment 1 David Nind 2024-06-03 02:07:09 UTC 
Created attachment 167331 [details] [review]
Bug 30715: Terminology for the log viewer - use 'Staff interface' instead of 'Intranet'

The log viewer (Tools > Additional tools > Log viewer) uses
'Intranet' as:
- an option for filtering what log entries to display.
- a value in the log entries interface column, for log entries.

Koha's terminology guideline is to use 'Staff interface' instead of
'Interface' (https://wiki.koha-community.org/wiki/Terminology#I).

Test plan:
1. Perform some actions that will create log entries when using the
   staff interface. For example:
   1.1 Enable the UseRecalls system preference.
   1.2 Edit the title for a record.
   1.3 Add an item for a record.
2. Use the log viewer to view the logged changes:
   2.1 Go to Tools > Additional tools > Log viewer.
   2.2 Select Submit.
   2.3 Log entries are displayed for the changes made.
3. Note that:
   3.1 For the log viewer 'Interface' filter options, "All" is
       selected by default, and other options are Intranet, OPAC,
       SIP, Command-line, REST API, and Cron job.
   3.2 For the changes viewed in step 2, the value displayed in
       the 'Interface' column is 'Intranet'.
4. Apply the patch.
5. Refresh the page.
6. Note that:
   5.1 For the interface filter options, 'Intranet' is now changed
       to 'Staff interface'.
   5.2 In the list of log entries, the value in the interface column
       is now 'Staff interface'.
7. Sign off D:

Signed-off-by: David Nind <david@davidnind.com>
Comment 2 David Nind 2024-06-03 02:18:23 UTC 
This only fixes the usage of 'Intranet' as displayed on the log viewer page.

It does not fix the addition of entries to the action_log table (these are added as 'intranet' to the interface column).

It also doesn't fix the exported file - the CSV file exported still shows 'intranet' as the interface.

If these need to be fixed, this will need to be done by someone else who can work out how to do it.
Comment 3 Lucas Gass (lukeg) 2024-06-03 21:11:20 UTC 
Created attachment 167361 [details] [review]
Bug 30715: Terminology for the log viewer - use 'Staff interface' instead of 'Intranet'

The log viewer (Tools > Additional tools > Log viewer) uses
'Intranet' as:
- an option for filtering what log entries to display.
- a value in the log entries interface column, for log entries.

Koha's terminology guideline is to use 'Staff interface' instead of
'Interface' (https://wiki.koha-community.org/wiki/Terminology#I).

Test plan:
1. Perform some actions that will create log entries when using the
   staff interface. For example:
   1.1 Enable the UseRecalls system preference.
   1.2 Edit the title for a record.
   1.3 Add an item for a record.
2. Use the log viewer to view the logged changes:
   2.1 Go to Tools > Additional tools > Log viewer.
   2.2 Select Submit.
   2.3 Log entries are displayed for the changes made.
3. Note that:
   3.1 For the log viewer 'Interface' filter options, "All" is
       selected by default, and other options are Intranet, OPAC,
       SIP, Command-line, REST API, and Cron job.
   3.2 For the changes viewed in step 2, the value displayed in
       the 'Interface' column is 'Intranet'.
4. Apply the patch.
5. Refresh the page.
6. Note that:
   5.1 For the interface filter options, 'Intranet' is now changed
       to 'Staff interface'.
   5.2 In the list of log entries, the value in the interface column
       is now 'Staff interface'.
7. Sign off D:

Signed-off-by: David Nind <david@davidnind.com>
Signed-off-by: Lucas Gass <lucas@bywatersolutions.com>
Comment 4 David Nind 2024-06-03 21:25:08 UTC 
Thanks for the sign-off Lucas!
Comment 5 Emily Lamancusa (emlam) 2024-06-12 14:56:04 UTC 
Created attachment 167669 [details] [review]
Bug 30715: Terminology for the log viewer - use 'Staff interface' instead of 'Intranet'

The log viewer (Tools > Additional tools > Log viewer) uses
'Intranet' as:
- an option for filtering what log entries to display.
- a value in the log entries interface column, for log entries.

Koha's terminology guideline is to use 'Staff interface' instead of
'Interface' (https://wiki.koha-community.org/wiki/Terminology#I).

Test plan:
1. Perform some actions that will create log entries when using the
   staff interface. For example:
   1.1 Enable the UseRecalls system preference.
   1.2 Edit the title for a record.
   1.3 Add an item for a record.
2. Use the log viewer to view the logged changes:
   2.1 Go to Tools > Additional tools > Log viewer.
   2.2 Select Submit.
   2.3 Log entries are displayed for the changes made.
3. Note that:
   3.1 For the log viewer 'Interface' filter options, "All" is
       selected by default, and other options are Intranet, OPAC,
       SIP, Command-line, REST API, and Cron job.
   3.2 For the changes viewed in step 2, the value displayed in
       the 'Interface' column is 'Intranet'.
4. Apply the patch.
5. Refresh the page.
6. Note that:
   5.1 For the interface filter options, 'Intranet' is now changed
       to 'Staff interface'.
   5.2 In the list of log entries, the value in the interface column
       is now 'Staff interface'.
7. Sign off D:

Signed-off-by: David Nind <david@davidnind.com>
Signed-off-by: Lucas Gass <lucas@bywatersolutions.com>
Signed-off-by: Emily Lamancusa <emily.lamancusa@montgomerycountymd.gov>
Comment 6 Emily Lamancusa (emlam) 2024-06-12 15:00:40 UTC 
String change, looks good and QA script is happy. Passing QA
Comment 7 Martin Renvoize (ashimema) 2024-06-13 13:32:33 UTC 
Thanks for all the hard work!

Pushed to main for the next 24.11.00 release as RM Assistant
Comment 8 Lucas Gass (lukeg) 2024-07-18 17:37:02 UTC 
Backported to 24.05.x for upcoming 24.05.02
Comment 9 Fridolin Somers 2024-07-19 07:33:33 UTC 
Pushed to 23.11.x for 23.11.07
Comment 10 Wainui Witika-Park 2024-09-12 02:05:39 UTC 
Pushed to 23.05.x for 23.05.15