[Bug 41980] New: SIP codes in the new SIP Config UI could have better descriptions
https://bugs.koha-community.org/bugzilla3/show_bug.cgi?id=41980 Bug ID: 41980 Summary: SIP codes in the new SIP Config UI could have better descriptions Initiative type: --- Sponsorship --- status: Product: Koha Version: Main Hardware: All OS: All Status: NEW Severity: enhancement Priority: P5 - low Component: System Administration Assignee: koha-bugs@lists.koha-community.org Reporter: martin.renvoize@openfifth.co.uk QA Contact: testopia@bugs.koha-community.org CC: gmcharlt@gmail.com Depends on: 37893 Now we have a nice systems librarian facing SIP configuration page, it would be nice to improve the field descriptions from many simple SIP codes to something a little more understandable for the person doing the configuration should they not be a SIP expert. Referenced Bugs: https://bugs.koha-community.org/bugzilla3/show_bug.cgi?id=37893 [Bug 37893] Migrate some SIP configuration into the staff interface -- You are receiving this mail because: You are watching all bug changes. You are the assignee for the bug.
https://bugs.koha-community.org/bugzilla3/show_bug.cgi?id=41980 Martin Renvoize (ashimema) <martin.renvoize@openfifth.co.uk> changed: What |Removed |Added ---------------------------------------------------------------------------- Patch complexity|--- |Trivial patch Status|NEW |Needs Signoff Assignee|koha-bugs@lists.koha-commun |martin.renvoize@openfifth.c |ity.org |o.uk Sponsorship status|--- |Unsponsored -- You are receiving this mail because: You are the assignee for the bug. You are watching all bug changes.
https://bugs.koha-community.org/bugzilla3/show_bug.cgi?id=41980 --- Comment #1 from Martin Renvoize (ashimema) <martin.renvoize@openfifth.co.uk> --- Created attachment 194398 --> https://bugs.koha-community.org/bugzilla3/attachment.cgi?id=194398&action=edit Bug 41980: Add more descriptive labels to SIP2 field codes - Add field name labels to all entries in getSIPFields() used by the Allow/Hide fields dropdowns (e.g. "CV - Alert Type" instead of "CV") sourced from C4::SIP::Sip::Constants field identifier names - Add tooltips to ae_field_template, av_field_template and da_field_template explaining what each SIP field represents and which Template::Toolkit objects are available - Improve ct_always_send tooltip to explain CT is Destination Location - Improve cv_send_00_on_success tooltip to explain CV alert type codes - Improve cv_triggers_alert tooltip to clarify the two alert behaviours - Improve cr_item_field tooltip to explain CR is Collection Code -- You are receiving this mail because: You are watching all bug changes.
https://bugs.koha-community.org/bugzilla3/show_bug.cgi?id=41980 Martin Renvoize (ashimema) <martin.renvoize@openfifth.co.uk> changed: What |Removed |Added ---------------------------------------------------------------------------- CC| |andrew@bywatersolutions.com | |, | |jesse@bywatersolutions.com, | |kyle@bywatersolutions.com -- You are receiving this mail because: You are watching all bug changes.
https://bugs.koha-community.org/bugzilla3/show_bug.cgi?id=41980 --- Comment #2 from Martin Renvoize (ashimema) <martin.renvoize@openfifth.co.uk> --- Hmm, this is actually exposed in the hints/tooltips rather than labels.. my mistake in the commit message. Either way, the test plan is basically to navigate to the 'Add account' page in the SIP config page and hover over the various fields hints.. read the new hints and confirm they're a little clearer as to the fields intended purpose. -- You are receiving this mail because: You are watching all bug changes.
https://bugs.koha-community.org/bugzilla3/show_bug.cgi?id=41980 David Nind <david@davidnind.com> changed: What |Removed |Added ---------------------------------------------------------------------------- Status|Needs Signoff |Signed Off -- You are receiving this mail because: You are watching all bug changes.
https://bugs.koha-community.org/bugzilla3/show_bug.cgi?id=41980 David Nind <david@davidnind.com> changed: What |Removed |Added ---------------------------------------------------------------------------- Attachment #194398|0 |1 is obsolete| | --- Comment #3 from David Nind <david@davidnind.com> --- Created attachment 194414 --> https://bugs.koha-community.org/bugzilla3/attachment.cgi?id=194414&action=edit Bug 41980: Add more descriptive labels to SIP2 field codes - Add field name labels to all entries in getSIPFields() used by the Allow/Hide fields dropdowns (e.g. "CV - Alert Type" instead of "CV") sourced from C4::SIP::Sip::Constants field identifier names - Add tooltips to ae_field_template, av_field_template and da_field_template explaining what each SIP field represents and which Template::Toolkit objects are available - Improve ct_always_send tooltip to explain CT is Destination Location - Improve cv_send_00_on_success tooltip to explain CV alert type codes - Improve cv_triggers_alert tooltip to clarify the two alert behaviours - Improve cr_item_field tooltip to explain CR is Collection Code Signed-off-by: David Nind <david@davidnind.com> -- You are receiving this mail because: You are watching all bug changes.
https://bugs.koha-community.org/bugzilla3/show_bug.cgi?id=41980 David Nind <david@davidnind.com> changed: What |Removed |Added ---------------------------------------------------------------------------- Text to go in the| |This enhancement improves release notes| |the descriptions and | |tooltips for several | |fields: | |- Allow and hide fields: | |instead of codes (such as | |CQ), | | most codes now include a | |description | | (such as CQ - Valid | |Patron Password) | |- Improved tooltips for | |these fields: | | . CR item field | | . CT always send | | . CV always send 00 on | |success | | . CV triggers alert | |- Adds tooltips in the | |template section for the | | AE, AV, and DA field | |templates CC| |david@davidnind.com --- Comment #4 from David Nind <david@davidnind.com> --- Nice! This definitely makes things clearer. Testing notes (using KTD): 1. Go to Administration > Patrons and circulation > Self-service circulation (SIP2) > Accounts > New account 2. In the details section: 2.1 Note that the values listed for these dropdown lists are just codes, such as CQ, CD: - Allow fields - Hide fields 2.2 Note there are relatively short tooltips for these fields: - CR item field - CT always send - CV always send 00 on success - CV triggers alert 2.3 In the templates section, note that there are no tooltips for these fields: - AE field template - AV field template - DA field template 3. Apply the patch. 4. Rebuild things: yarn build 5. Restart everything: restart_all 6. Refresh the page. 7. For step 2.1, note that most values have a short description for each code. 8. For step 2.2, note that more detailed tooltips (see the patch diff for a comparison). 9. For step 2.3, note that there are now tooltips for the fields. Observations, not showstoppers for me as they can be done in new bugs: 1. Should we use sentence case for the dropdown list descriptions? 2. There are no descriptions for these codes: - AR - AW - AX - BA - BB - BC - BJ - CE 3. For AE, AV, and DA, maybe we should change the text for the last sentence: - Current: "...Use the Template::Toolkit syntax; the 'XXX' object (Koha::XXX) is available." - Proposed: "...Use Template Toolkit syntax - the XXX fields for XXX are available." 4. Happy to add a follow-up patch for these, or do on a new bug. -- You are receiving this mail because: You are watching all bug changes.
https://bugs.koha-community.org/bugzilla3/show_bug.cgi?id=41980 David Nind <david@davidnind.com> changed: What |Removed |Added ---------------------------------------------------------------------------- Text to go in the|This enhancement improves |This enhancement improves release notes|the descriptions and |the descriptions and |tooltips for several |tooltips for several SIP2 |fields: |account form fields: |- Allow and hide fields: |- Allow and hide fields: |instead of codes (such as |instead of just codes (such |CQ), |as CQ), | most codes now include a | most codes now include a |description |description | (such as CQ - Valid | (such as CQ - Valid |Patron Password) |Patron Password) |- Improved tooltips for |- Improved tooltips for |these fields: |these fields: | . CR item field | . CR item field | . CT always send | . CT always send | . CV always send 00 on | . CV always send 00 on |success |success | . CV triggers alert | . CV triggers alert |- Adds tooltips in the |- Adds tooltips in the |template section for the |template section for the | AE, AV, and DA field | AE, AV, and DA field |templates |templates -- You are receiving this mail because: You are watching all bug changes.
https://bugs.koha-community.org/bugzilla3/show_bug.cgi?id=41980 carthur@slolibrary.org <carthur@slolibrary.org> changed: What |Removed |Added ---------------------------------------------------------------------------- CC| |carthur@slolibrary.org -- You are receiving this mail because: You are watching all bug changes.
https://bugs.koha-community.org/bugzilla3/show_bug.cgi?id=41980 John Vinke <jvinke@austinseminary.edu> changed: What |Removed |Added ---------------------------------------------------------------------------- Status|Signed Off |Passed QA -- You are receiving this mail because: You are watching all bug changes.
https://bugs.koha-community.org/bugzilla3/show_bug.cgi?id=41980 John Vinke <jvinke@austinseminary.edu> changed: What |Removed |Added ---------------------------------------------------------------------------- Attachment #194414|0 |1 is obsolete| | --- Comment #5 from John Vinke <jvinke@austinseminary.edu> --- Created attachment 195201 --> https://bugs.koha-community.org/bugzilla3/attachment.cgi?id=195201&action=edit Bug 41980: Add more descriptive labels to SIP2 field codes - Add field name labels to all entries in getSIPFields() used by the Allow/Hide fields dropdowns (e.g. "CV - Alert Type" instead of "CV") sourced from C4::SIP::Sip::Constants field identifier names - Add tooltips to ae_field_template, av_field_template and da_field_template explaining what each SIP field represents and which Template::Toolkit objects are available - Improve ct_always_send tooltip to explain CT is Destination Location - Improve cv_send_00_on_success tooltip to explain CV alert type codes - Improve cv_triggers_alert tooltip to clarify the two alert behaviours - Improve cr_item_field tooltip to explain CR is Collection Code Signed-off-by: David Nind <david@davidnind.com> Signed-off-by: John Vinke <jvinke@austinseminary.edu> -- You are receiving this mail because: You are watching all bug changes.
https://bugs.koha-community.org/bugzilla3/show_bug.cgi?id=41980 John Vinke <jvinke@austinseminary.edu> changed: What |Removed |Added ---------------------------------------------------------------------------- QA Contact|testopia@bugs.koha-communit |jvinke@austinseminary.edu |y.org | CC| |jvinke@austinseminary.edu --- Comment #6 from John Vinke <jvinke@austinseminary.edu> --- We tested this during baby devs and it worked great. We noted that there may be a translation issue with the code and the description in the dropdowns being in English. Martin will check with Cait. We would like to ask for a new patch from David with clarity on what he wanted for the AE, AV, and DA tooltips. CR fields specifies 3M in the tooltip, but if anyone is aware of others who use that field it might need to be changed later. -- You are receiving this mail because: You are watching all bug changes.
https://bugs.koha-community.org/bugzilla3/show_bug.cgi?id=41980 Lisette Scheer <lisette@bywatersolutions.com> changed: What |Removed |Added ---------------------------------------------------------------------------- CC| |lisette@bywatersolutions.co | |m -- You are receiving this mail because: You are watching all bug changes.
https://bugs.koha-community.org/bugzilla3/show_bug.cgi?id=41980 --- Comment #7 from David Nind <david@davidnind.com> --- (In reply to John Vinke from comment #6)
We tested this during baby devs and it worked great. We noted that there may be a translation issue with the code and the description in the dropdowns being in English. Martin will check with Cait.
We would like to ask for a new patch from David with clarity on what he wanted for the AE, AV, and DA tooltips.
CR fields specifies 3M in the tooltip, but if anyone is aware of others who use that field it might need to be changed later.
Sorry I missed baby devs (slept through my alarm 8-(). For the AE, AV, and DA tooltips, I felt that these were written in "developer speak". Example: "...Uses Template::Toolkit syntax; the 'accountline' object (Koha::Account::Line) and 'patron' object are available." That's why I suggested: - Instead of "Use the Template::Toolkit syntax" ==> "Use the Template Toolkit syntax" - I have no idea what the rest of the sentence means, but assume it relates to the fields that are available that you can use with Template Toolkit syntax. - So instead of "...the 'accountline' object (Koha::Account::Line) and 'patron' object are available.", something that makes sense to non-developers. For example, "You can use fields from the accountline and borrowers tables." or something similar. -- You are receiving this mail because: You are watching all bug changes.
https://bugs.koha-community.org/bugzilla3/show_bug.cgi?id=41980 --- Comment #8 from Katrin Fischer <katrin.fischer@bsz-bw.de> --- They look to be translatable, but I am not completely sure they work the same in vue as in other places. Easiest would be to run a test, updating the po files and then checking them for the strings to appear. The descriptons don't follow capitalization rules... -- You are receiving this mail because: You are watching all bug changes.
https://bugs.koha-community.org/bugzilla3/show_bug.cgi?id=41980 John Vinke <jvinke@austinseminary.edu> changed: What |Removed |Added ---------------------------------------------------------------------------- Status|Passed QA |Failed QA --- Comment #9 from John Vinke <jvinke@austinseminary.edu> --- I switched it so failed QA Since we didn't catch the sentence case issue. Maybe the capitalization fix and the the "devspeak" simplification can happen at the same time? -- You are receiving this mail because: You are watching all bug changes.
https://bugs.koha-community.org/bugzilla3/show_bug.cgi?id=41980 --- Comment #10 from Martin Renvoize (ashimema) <martin.renvoize@openfifth.co.uk> --- (In reply to Katrin Fischer from comment #8)
They look to be translatable, but I am not completely sure they work the same in vue as in other places. Easiest would be to run a test, updating the po files and then checking them for the strings to appear.
The descriptons don't follow capitalization rules...
I think the translatable query was more about should we be including the Code within the translation block.. At the moment there's lots of `XX - Nice description` where the XX is really the underlying SIP code and isn't someone you would want to translate? -- You are receiving this mail because: You are watching all bug changes.
https://bugs.koha-community.org/bugzilla3/show_bug.cgi?id=41980 --- Comment #11 from Martin Renvoize (ashimema) <martin.renvoize@openfifth.co.uk> --- Created attachment 195368 --> https://bugs.koha-community.org/bugzilla3/attachment.cgi?id=195368&action=edit Bug 41980: (Follow-up) Improve SIP2 field code descriptions - Use sentence case for all dropdown descriptions - Add 'Unused' descriptions for AR, AW, AX, BA, BB, BC, BJ, CE - Move SIP field codes outside translatable strings to avoid untranslatable codes being sent to translators - Update AE/AV/DA tooltip text: use 'Template Toolkit' (not 'Template::Toolkit'), imperative form, and clearer object field descriptions -- You are receiving this mail because: You are watching all bug changes.
https://bugs.koha-community.org/bugzilla3/show_bug.cgi?id=41980 Martin Renvoize (ashimema) <martin.renvoize@openfifth.co.uk> changed: What |Removed |Added ---------------------------------------------------------------------------- Status|Failed QA |Signed Off -- You are receiving this mail because: You are watching all bug changes.
https://bugs.koha-community.org/bugzilla3/show_bug.cgi?id=41980 John Vinke <jvinke@austinseminary.edu> changed: What |Removed |Added ---------------------------------------------------------------------------- Status|Signed Off |Passed QA -- You are receiving this mail because: You are watching all bug changes.
https://bugs.koha-community.org/bugzilla3/show_bug.cgi?id=41980 John Vinke <jvinke@austinseminary.edu> changed: What |Removed |Added ---------------------------------------------------------------------------- Attachment #195201|0 |1 is obsolete| | --- Comment #12 from John Vinke <jvinke@austinseminary.edu> --- Created attachment 195597 --> https://bugs.koha-community.org/bugzilla3/attachment.cgi?id=195597&action=edit Bug 41980: Add more descriptive labels to SIP2 field codes - Add field name labels to all entries in getSIPFields() used by the Allow/Hide fields dropdowns (e.g. "CV - Alert Type" instead of "CV") sourced from C4::SIP::Sip::Constants field identifier names - Add tooltips to ae_field_template, av_field_template and da_field_template explaining what each SIP field represents and which Template::Toolkit objects are available - Improve ct_always_send tooltip to explain CT is Destination Location - Improve cv_send_00_on_success tooltip to explain CV alert type codes - Improve cv_triggers_alert tooltip to clarify the two alert behaviours - Improve cr_item_field tooltip to explain CR is Collection Code Signed-off-by: David Nind <david@davidnind.com> Signed-off-by: John Vinke <jvinke@austinseminary.edu> -- You are receiving this mail because: You are watching all bug changes.
https://bugs.koha-community.org/bugzilla3/show_bug.cgi?id=41980 John Vinke <jvinke@austinseminary.edu> changed: What |Removed |Added ---------------------------------------------------------------------------- Attachment #195368|0 |1 is obsolete| | --- Comment #13 from John Vinke <jvinke@austinseminary.edu> --- Created attachment 195598 --> https://bugs.koha-community.org/bugzilla3/attachment.cgi?id=195598&action=edit Bug 41980: (Follow-up) Improve SIP2 field code descriptions - Use sentence case for all dropdown descriptions - Add 'Unused' descriptions for AR, AW, AX, BA, BB, BC, BJ, CE - Move SIP field codes outside translatable strings to avoid untranslatable codes being sent to translators - Update AE/AV/DA tooltip text: use 'Template Toolkit' (not 'Template::Toolkit'), imperative form, and clearer object field descriptions Signed-off-by: John Vinke <jvinke@austinseminary.edu> -- You are receiving this mail because: You are watching all bug changes.
https://bugs.koha-community.org/bugzilla3/show_bug.cgi?id=41980 --- Comment #14 from John Vinke <jvinke@austinseminary.edu> --- The only thing I note is that the QA script said you did not spell "follow-up" correctly. I'm not sure if that's an issue or just a warning that can be ignored. -- You are receiving this mail because: You are watching all bug changes.
https://bugs.koha-community.org/bugzilla3/show_bug.cgi?id=41980 Martin Renvoize (ashimema) <martin.renvoize@openfifth.co.uk> changed: What |Removed |Added ---------------------------------------------------------------------------- Version(s)| |26.05.00 released in| | Status|Passed QA |Pushed to main -- You are receiving this mail because: You are watching all bug changes.
https://bugs.koha-community.org/bugzilla3/show_bug.cgi?id=41980 --- Comment #15 from Martin Renvoize (ashimema) <martin.renvoize@openfifth.co.uk> --- Thanks for all the hard work! Pushed to main for the next 26.05.00 release as RM Assistant -- You are receiving this mail because: You are watching all bug changes.
https://bugs.koha-community.org/bugzilla3/show_bug.cgi?id=41980 --- Comment #16 from Martin Renvoize (ashimema) <martin.renvoize@openfifth.co.uk> --- Created attachment 196499 --> https://bugs.koha-community.org/bugzilla3/attachment.cgi?id=196499&action=edit Bug 41980: (Follow-up) Fix Cypress test ambiguous field code search Typing "CE" in the allow_fields dropdown now matches both "CE - Unused" and "AY - Sequence number" (case-insensitive match on "ce" in "Sequence"), causing the wrong option to be selected. Use "CE - " to uniquely target the intended option. -- You are receiving this mail because: You are watching all bug changes.
https://bugs.koha-community.org/bugzilla3/show_bug.cgi?id=41980 Jacob O'Mara <jacob.omara@openfifth.co.uk> changed: What |Removed |Added ---------------------------------------------------------------------------- Status|Pushed to main |Pushed to stable Version(s)|26.05.00 |26.05.00,25.11.05 released in| | -- You are receiving this mail because: You are watching all bug changes.
https://bugs.koha-community.org/bugzilla3/show_bug.cgi?id=41980 --- Comment #17 from Jacob O'Mara <jacob.omara@openfifth.co.uk> --- Thanks all, pushed to 25.11.x -- You are receiving this mail because: You are watching all bug changes.
https://bugs.koha-community.org/bugzilla3/show_bug.cgi?id=41980 Wainui Witika-Park <wainuiwitikapark@catalyst.net.nz> changed: What |Removed |Added ---------------------------------------------------------------------------- CC| |wainuiwitikapark@catalyst.n | |et.nz Status|Pushed to stable |Needs documenting --- Comment #18 from Wainui Witika-Park <wainuiwitikapark@catalyst.net.nz> --- Enhancement - not backporting to 25.05 -- You are receiving this mail because: You are watching all bug changes.
https://bugs.koha-community.org/bugzilla3/show_bug.cgi?id=41980 David Cook <dcook@prosentient.com.au> changed: What |Removed |Added ---------------------------------------------------------------------------- CC| |dcook@prosentient.com.au --- Comment #19 from David Cook <dcook@prosentient.com.au> --- It's not clear in the UI but I'm assuming that "Field" has to be a valid SIP2 field and not an arbitrary field? If so, we could probably have some client-side pattern requirements (and server side validation of course) -- You are receiving this mail because: You are watching all bug changes.
participants (1)
-
bugzilla-daemon＠bugs.koha-community.org