[Bug 20581] New: Allow manual selection of custom ILL request statuses

classic Classic list List threaded Threaded
17 messages Options
Reply | Threaded
Open this post in threaded view
|

[Bug 20581] New: Allow manual selection of custom ILL request statuses

bugzilla-daemon
https://bugs.koha-community.org/bugzilla3/show_bug.cgi?id=20581

            Bug ID: 20581
           Summary: Allow manual selection of custom ILL request statuses
 Change sponsored?: ---
           Product: Koha
           Version: master
          Hardware: All
                OS: All
            Status: NEW
          Severity: enhancement
          Priority: P5 - low
         Component: ILL
          Assignee: [hidden email]
          Reporter: [hidden email]

Currently the displayed status of any given ILL request is strictly prescribed
by where it is in the workflow, as defined in the ILL module.

While this gives an accurate indication of the current status of a request, it
does not allow for any local variation in the displayed status, which can be
limiting for the end user.

This bug proposes adding the ability for the admin, via a syspref, to define a
custom set of request statuses, which can be selected for display by the
manager of an ILL request. These statuses work alongside the existing
"workflow" status that an ILL request has and will, if selected, override *for
display* the status of that request.

This proposal will allow the ILL module to continue to strictly prescribe and
manage the workflow of requests, but will also allow the end user some
flexibility in the display of a given request's status

--
You are receiving this mail because:
You are watching all bug changes.
You are the assignee for the bug.
_______________________________________________
Koha-bugs mailing list
[hidden email]
http://lists.koha-community.org/cgi-bin/mailman/listinfo/koha-bugs
website : http://www.koha-community.org/
git : http://git.koha-community.org/
bugs : http://bugs.koha-community.org/
Reply | Threaded
Open this post in threaded view
|

[Bug 20581] Allow manual selection of custom ILL request statuses

bugzilla-daemon
https://bugs.koha-community.org/bugzilla3/show_bug.cgi?id=20581

Andrew Isherwood <[hidden email]> changed:

           What    |Removed                     |Added
----------------------------------------------------------------------------
           Assignee|[hidden email]-commun |andrew.isherwood@ptfs-europ
                   |ity.org                     |e.com
             Status|NEW                         |ASSIGNED
   Patch complexity|---                         |Small patch

--
You are receiving this mail because:
You are the assignee for the bug.
You are watching all bug changes.
_______________________________________________
Koha-bugs mailing list
[hidden email]
http://lists.koha-community.org/cgi-bin/mailman/listinfo/koha-bugs
website : http://www.koha-community.org/
git : http://git.koha-community.org/
bugs : http://bugs.koha-community.org/
Reply | Threaded
Open this post in threaded view
|

[Bug 20581] Allow manual selection of custom ILL request statuses

bugzilla-daemon
In reply to this post by bugzilla-daemon
https://bugs.koha-community.org/bugzilla3/show_bug.cgi?id=20581

Andrew Isherwood <[hidden email]> changed:

           What    |Removed                     |Added
----------------------------------------------------------------------------
         Depends on|                            |7317


Referenced Bugs:

https://bugs.koha-community.org/bugzilla3/show_bug.cgi?id=7317
[Bug 7317] Add an Interlibrary Loan Module to Circulation and OPAC
--
You are receiving this mail because:
You are watching all bug changes.
_______________________________________________
Koha-bugs mailing list
[hidden email]
http://lists.koha-community.org/cgi-bin/mailman/listinfo/koha-bugs
website : http://www.koha-community.org/
git : http://git.koha-community.org/
bugs : http://bugs.koha-community.org/
Reply | Threaded
Open this post in threaded view
|

[Bug 20581] Allow manual selection of custom ILL request statuses

bugzilla-daemon
In reply to this post by bugzilla-daemon
https://bugs.koha-community.org/bugzilla3/show_bug.cgi?id=20581

--- Comment #1 from Andrew Isherwood <[hidden email]> ---
Work on this bug is being submitted as distinct patches rather than one large
patch. Each patch is related to a specific area of work, e.g. database schema
changes, API changes, ILLrequest object changes, staff template changes & OPAC
changes.

Although these patches are distinct, they are all required for the end result
to work. As such, I am adding QA test scenarios here rather than attaching them
to the individual patches.

Test custom status creation:
1) Apply this bug's patches
2) Apply database updates
3) Ensure you have at least one ILL backend available:
   https://wiki.koha-community.org/wiki/ILL_backends
4) Ensure you have the "ILLModule" preference enabled
5) Log in as a user with the ability to add authorised values.
6) Depending on whether you opted to accept the "Default ILL request status
authorised value category name" data population during install, you may or may
not have an authorised values category ILLSTATUS, if not, create it.
7) Add some authorised values to the ILLSTATUS category, these can be custom
request statuses of your choice

Test custom status usage:
8) From the staff interface, create an ILL request from a backend of your
choice
9) On the resulting "Request details" page, observe that the request's status
is "New request"
10) Click the "Edit request" button
11) In the "Request details" pane, observe that the request's status is now
available in a drop down box, it should contain the current status PLUS your
custom statuses.
12) Select a custom status and Submit the form
13) In the resulting "View ILL requests" page, observe that your request is now
displaying your custom status.
14) Click the "Manage request" button for your new request
15) In the "Request details" page, observe that the request's status is
displaying as your custom status

Test custom status is overridden when request progresses through workflow:
16) Click "Confirm request", then the "Confirm request" confirmation
17) Observe that in the resulting "Request details" page, the request's status
is now no longer displaying your custom status but has switched to "Requested"

Test custom status is removed when authorised value is removed:
18) Observe that the request has the status "Requested", we are going to
override that with a custom status, then remove that custom status authorised
value
19) Click "Edit request"
20) Select a custom status and Submit the form
21) In the resulting "View ILL requests" page, observe that your request is now
displaying your custom status.
22) Go to the authorised values management page
23) Delete the custom status you previously selected in step 19
24) Return to the list of ILL requests
25) Observe that the request that previously had the custom status now has it's
former status of "Requested"

Test API response for View ILL requests view:
26) Modify an existing request and set a custom status as discussed above
27) Navigate to the "View ILL requests" page
28) Examine the response to the API call made to the
/api/v1/illrequests?embed=metadata,patron,capabilities,library,status_alias
route
28) Observe that for requests with a custom status, the status_alias property
contains an object for the request's authorised value containing the custom
status
29) Observe that for requests without a custom status, status_alias is null

Test OPAC view:
30) Modify an existing request and set a custom status as discussed above
31) In the OPAC, navigate to "your interlibrary loan requests"
32) In the "Interlibrary loan requests" view, observe that the request's status
is displaying your custom value
33) Click "View" on the request with a custom value
34) In the "View Interlibrary loan request" view, observe that the request's
status is displaying your custom value

--
You are receiving this mail because:
You are watching all bug changes.
_______________________________________________
Koha-bugs mailing list
[hidden email]
http://lists.koha-community.org/cgi-bin/mailman/listinfo/koha-bugs
website : http://www.koha-community.org/
git : http://git.koha-community.org/
bugs : http://bugs.koha-community.org/
Reply | Threaded
Open this post in threaded view
|

[Bug 20581] Allow manual selection of custom ILL request statuses

bugzilla-daemon
In reply to this post by bugzilla-daemon
https://bugs.koha-community.org/bugzilla3/show_bug.cgi?id=20581

Andrew Isherwood <[hidden email]> changed:

           What    |Removed                     |Added
----------------------------------------------------------------------------
   Patch complexity|Small patch                 |Medium patch

--
You are receiving this mail because:
You are watching all bug changes.
_______________________________________________
Koha-bugs mailing list
[hidden email]
http://lists.koha-community.org/cgi-bin/mailman/listinfo/koha-bugs
website : http://www.koha-community.org/
git : http://git.koha-community.org/
bugs : http://bugs.koha-community.org/
Reply | Threaded
Open this post in threaded view
|

[Bug 20581] Allow manual selection of custom ILL request statuses

bugzilla-daemon
In reply to this post by bugzilla-daemon
https://bugs.koha-community.org/bugzilla3/show_bug.cgi?id=20581

--- Comment #2 from Andrew Isherwood <[hidden email]> ---
Created attachment 74323
  -->
https://bugs.koha-community.org/bugzilla3/attachment.cgi?id=74323&action=edit
Bug 20581: Modifications to database schema

- This patch provides an illrequests.status_alias column that is a foreign key
to
authorised_values.id. This provides the ability for an ILL request to
have an optional status alias that is defined as an authorised valued.
- A new ILLSTATUS authorised value category is also made available during
install.

--
You are receiving this mail because:
You are watching all bug changes.
_______________________________________________
Koha-bugs mailing list
[hidden email]
http://lists.koha-community.org/cgi-bin/mailman/listinfo/koha-bugs
website : http://www.koha-community.org/
git : http://git.koha-community.org/
bugs : http://bugs.koha-community.org/
Reply | Threaded
Open this post in threaded view
|

[Bug 20581] Allow manual selection of custom ILL request statuses

bugzilla-daemon
In reply to this post by bugzilla-daemon
https://bugs.koha-community.org/bugzilla3/show_bug.cgi?id=20581

--- Comment #3 from Andrew Isherwood <[hidden email]> ---
Created attachment 74324
  -->
https://bugs.koha-community.org/bugzilla3/attachment.cgi?id=74324&action=edit
Bug 20581: Provide status_alias on IllRequest

This patch provides status_alias support for the Koha::Illrequest
object.

- New 'statusalias' getter method, returns the request's status_alias
authorised value object if set, otherwise undef
- Overloads existing 'status' method, getter/setter accessors intact,
but setting the request's status now implicitly removes any status_alias
that has been set

--
You are receiving this mail because:
You are watching all bug changes.
_______________________________________________
Koha-bugs mailing list
[hidden email]
http://lists.koha-community.org/cgi-bin/mailman/listinfo/koha-bugs
website : http://www.koha-community.org/
git : http://git.koha-community.org/
bugs : http://bugs.koha-community.org/
Reply | Threaded
Open this post in threaded view
|

[Bug 20581] Allow manual selection of custom ILL request statuses

bugzilla-daemon
In reply to this post by bugzilla-daemon
https://bugs.koha-community.org/bugzilla3/show_bug.cgi?id=20581

--- Comment #4 from Andrew Isherwood <[hidden email]> ---
Created attachment 74325
  -->
https://bugs.koha-community.org/bugzilla3/attachment.cgi?id=74325&action=edit
Bug 20581: API provide status_alias embed

- This patch provides the illrequests API route with an additional embed,
called 'status_alias'. Requesting this embed returns an object for the
request's status_alias authorised value, or null if one is not set.
- This patch also adds the new status_alias as a default embed on the API
call made by the illlist view

--
You are receiving this mail because:
You are watching all bug changes.
_______________________________________________
Koha-bugs mailing list
[hidden email]
http://lists.koha-community.org/cgi-bin/mailman/listinfo/koha-bugs
website : http://www.koha-community.org/
git : http://git.koha-community.org/
bugs : http://bugs.koha-community.org/
Reply | Threaded
Open this post in threaded view
|

[Bug 20581] Allow manual selection of custom ILL request statuses

bugzilla-daemon
In reply to this post by bugzilla-daemon
https://bugs.koha-community.org/bugzilla3/show_bug.cgi?id=20581

--- Comment #5 from Andrew Isherwood <[hidden email]> ---
Created attachment 74326
  -->
https://bugs.koha-community.org/bugzilla3/attachment.cgi?id=74326&action=edit
Bug 20581: Add display of status_alias to staff vw

- This patch adds display of the new status_alias value, when set, in
favour of the request's status value.
- It also allows the user to set a status_alias for an existing request.
When set, this value will be displayed in preference to the status.

--
You are receiving this mail because:
You are watching all bug changes.
_______________________________________________
Koha-bugs mailing list
[hidden email]
http://lists.koha-community.org/cgi-bin/mailman/listinfo/koha-bugs
website : http://www.koha-community.org/
git : http://git.koha-community.org/
bugs : http://bugs.koha-community.org/
Reply | Threaded
Open this post in threaded view
|

[Bug 20581] Allow manual selection of custom ILL request statuses

bugzilla-daemon
In reply to this post by bugzilla-daemon
https://bugs.koha-community.org/bugzilla3/show_bug.cgi?id=20581

--- Comment #6 from Andrew Isherwood <[hidden email]> ---
Created attachment 74327
  -->
https://bugs.koha-community.org/bugzilla3/attachment.cgi?id=74327&action=edit
Bug 20581: Add support for status_alias to OPAC view

- This patch adds the abililty for the OPAC to display a set status_alias
value in preference to a request's status value. During ILL request
listing or individual ILL request view, the status_alias value, if set,
will be displayed in favour of the status

--
You are receiving this mail because:
You are watching all bug changes.
_______________________________________________
Koha-bugs mailing list
[hidden email]
http://lists.koha-community.org/cgi-bin/mailman/listinfo/koha-bugs
website : http://www.koha-community.org/
git : http://git.koha-community.org/
bugs : http://bugs.koha-community.org/
Reply | Threaded
Open this post in threaded view
|

[Bug 20581] Allow manual selection of custom ILL request statuses

bugzilla-daemon
In reply to this post by bugzilla-daemon
https://bugs.koha-community.org/bugzilla3/show_bug.cgi?id=20581

--- Comment #7 from Andrew Isherwood <[hidden email]> ---
Created attachment 74362
  -->
https://bugs.koha-community.org/bugzilla3/attachment.cgi?id=74362&action=edit
Bug 20581: Unit tests for status_alias

This patch adds unit tests for the specific status_alias functionality
added in this bug

- Creation of the ILLSTATUS authorised value
- Illrequest->statusalias accessor
- Illrequest->status overloading to reset status_alias

To test:
1) Apply this patch
2) prove t/db_dependent/Illrequests.t

--
You are receiving this mail because:
You are watching all bug changes.
_______________________________________________
Koha-bugs mailing list
[hidden email]
http://lists.koha-community.org/cgi-bin/mailman/listinfo/koha-bugs
website : http://www.koha-community.org/
git : http://git.koha-community.org/
bugs : http://bugs.koha-community.org/
Reply | Threaded
Open this post in threaded view
|

[Bug 20581] Allow manual selection of custom ILL request statuses

bugzilla-daemon
In reply to this post by bugzilla-daemon
https://bugs.koha-community.org/bugzilla3/show_bug.cgi?id=20581

Andrew Isherwood <[hidden email]> changed:

           What    |Removed                     |Added
----------------------------------------------------------------------------
             Status|ASSIGNED                    |Needs Signoff

--
You are receiving this mail because:
You are watching all bug changes.
_______________________________________________
Koha-bugs mailing list
[hidden email]
http://lists.koha-community.org/cgi-bin/mailman/listinfo/koha-bugs
website : http://www.koha-community.org/
git : http://git.koha-community.org/
bugs : http://bugs.koha-community.org/
Reply | Threaded
Open this post in threaded view
|

[Bug 20581] Allow manual selection of custom ILL request statuses

bugzilla-daemon
In reply to this post by bugzilla-daemon
https://bugs.koha-community.org/bugzilla3/show_bug.cgi?id=20581

M. Tompsett <[hidden email]> changed:

           What    |Removed                     |Added
----------------------------------------------------------------------------
                 CC|                            |[hidden email]

--- Comment #8 from M. Tompsett <[hidden email]> ---
Let's say I install multiple languages.
If the Authorized Value is not keyed partially on language, then how well will
this work in a multilingual setting where one user might use one language, and
another one might use some other language.

--
You are receiving this mail because:
You are watching all bug changes.
_______________________________________________
Koha-bugs mailing list
[hidden email]
http://lists.koha-community.org/cgi-bin/mailman/listinfo/koha-bugs
website : http://www.koha-community.org/
git : http://git.koha-community.org/
bugs : http://bugs.koha-community.org/
Reply | Threaded
Open this post in threaded view
|

[Bug 20581] Allow manual selection of custom ILL request statuses

bugzilla-daemon
In reply to this post by bugzilla-daemon
https://bugs.koha-community.org/bugzilla3/show_bug.cgi?id=20581

--- Comment #9 from Andrew Isherwood <[hidden email]> ---
Hi Mark. That's a very good point. My knowledge of how to add multi language
support to authorised values is, unfortunately, non existent. Are you aware of
any "good practice" examples for this kind of thing?

--
You are receiving this mail because:
You are watching all bug changes.
_______________________________________________
Koha-bugs mailing list
[hidden email]
http://lists.koha-community.org/cgi-bin/mailman/listinfo/koha-bugs
website : http://www.koha-community.org/
git : http://git.koha-community.org/
bugs : http://bugs.koha-community.org/
Reply | Threaded
Open this post in threaded view
|

[Bug 20581] Allow manual selection of custom ILL request statuses

bugzilla-daemon
In reply to this post by bugzilla-daemon
https://bugs.koha-community.org/bugzilla3/show_bug.cgi?id=20581

Katrin Fischer <[hidden email]> changed:

           What    |Removed                     |Added
----------------------------------------------------------------------------
                 CC|                            |[hidden email]

--- Comment #10 from Katrin Fischer <[hidden email]> ---
(In reply to Andrew Isherwood from comment #9)
> Hi Mark. That's a very good point. My knowledge of how to add multi language
> support to authorised values is, unfortunately, non existent. Are you aware
> of any "good practice" examples for this kind of thing?

Hi Andrew,
at the moment it's not possible to have multi-language authorised values. It's
kind of an ongoing discussion if we should add more of them. But I think the
long term solution woudl be to copy what we do for itemtype descriptions (there
is a bug for that, but not spotting it right now).

So the question is, if maybe there is a better way to achieve what you want to
do.
Could it be an option to have default values that are translatable via
templates?
A mix of custom values and and default values?

I am not per se against adding authorised values - it's a problem we need to
fix globally at some point. Even better of course if someone would be willing
to have a look.

--
You are receiving this mail because:
You are watching all bug changes.
_______________________________________________
Koha-bugs mailing list
[hidden email]
http://lists.koha-community.org/cgi-bin/mailman/listinfo/koha-bugs
website : http://www.koha-community.org/
git : http://git.koha-community.org/
bugs : http://bugs.koha-community.org/
Reply | Threaded
Open this post in threaded view
|

[Bug 20581] Allow manual selection of custom ILL request statuses

bugzilla-daemon
In reply to this post by bugzilla-daemon
https://bugs.koha-community.org/bugzilla3/show_bug.cgi?id=20581

--- Comment #11 from Andrew Isherwood <[hidden email]> ---
Hi Katrin

Thanks for the suggestions.

I'm wary about cooking up a home baked way of doing it as, at the moment, I'm
using a well established method of providing an authorised list of values,
which is exactly what the custom statuses need. I think I'd rather keep to a
correct "Koha" way of providing this functionality than try to work around the
lack of translations with a bespoke solution.

It's tricky when in a transitional phase with anything, but I think having devs
coming up with bespoke solutions will likely cause more pain down the line when
a standard way of doing it is established and it's necessary to migrate to it.

So I think, for now, it feels more "correct" to use authorised values and
accept that they cannot be translated.

Cheers
Andrew

--
You are receiving this mail because:
You are watching all bug changes.
_______________________________________________
Koha-bugs mailing list
[hidden email]
http://lists.koha-community.org/cgi-bin/mailman/listinfo/koha-bugs
website : http://www.koha-community.org/
git : http://git.koha-community.org/
bugs : http://bugs.koha-community.org/
Reply | Threaded
Open this post in threaded view
|

[Bug 20581] Allow manual selection of custom ILL request statuses

bugzilla-daemon
In reply to this post by bugzilla-daemon
https://bugs.koha-community.org/bugzilla3/show_bug.cgi?id=20581

Andrew Isherwood <[hidden email]> changed:

           What    |Removed                     |Added
----------------------------------------------------------------------------
             Blocks|                            |18589


Referenced Bugs:

https://bugs.koha-community.org/bugzilla3/show_bug.cgi?id=18589
[Bug 18589] Show ILLs as part of patron profile
--
You are receiving this mail because:
You are watching all bug changes.
_______________________________________________
Koha-bugs mailing list
[hidden email]
http://lists.koha-community.org/cgi-bin/mailman/listinfo/koha-bugs
website : http://www.koha-community.org/
git : http://git.koha-community.org/
bugs : http://bugs.koha-community.org/