Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

OCLC Resource Sharing For Groups Integration - Phase one #154

Open
wants to merge 12 commits into
base: DIS-65_resource_sharing_for_groups_phase_one
Choose a base branch
from

Conversation

Chloe070196
Copy link

@Chloe070196 Chloe070196 commented Jan 6, 2025

Adds a connector to the RS API so that patrons whose libraries use the OCLC Resource Sharing For Groups services for in-system and for out-of-system interlibrary loan requests may place ILL requests through Aspen Discovery.

Detailed feature description: https://aspen-discovery.atlassian.net/browse/DIS-65

This patch touches the following areas of Aspen Discovery:

  • Administration Settings: Libraries, Locations and Interlibrary Loans sections
    -> new settings added
  • Search result page: 'Place Hold' / 'Request' button (on records), and 'Submit Request' (bottom of the page)
    -> control flow altered so RSFG integration is used if set and appropriate
  • Your Account > Titles On Hold: 'All' and 'Interlibrary Loan Requests' tabs
    -> displays ILL requests placed using the RSFG integration

Notes:

  • release notes to be added
  • test plans in commit messages and broken down by feature (fa734d0 does not include a test plan as the 'display ILL requests to patron is covered by test plans in aa9e390 and 26686ff)
  • OCLC Resource Sharing For Groups abbreviated to OCLC RSFG throughout
  • Phase Two to follow

@Chloe070196 Chloe070196 force-pushed the 25.02.00_resource_sharing_for_groups_phase_one branch from 2a0ac7a to e668cc6 Compare January 6, 2025 10:20
This enables admin with the right permissions to view existing Resource
Sharing For Groups settings, export them as CSV, update them, delete
them and create new ones.

The above is pre-existent behaviour. This test plan aims to ensure that
all functionalities normally present in Aspen (e.g for VDX) for settings
Administration also work for the newly introduced Resource Sharing For
Groups settings.

Additionally, admininstrators will be able to assign an OCLC RegistryId
to one or more locations.

Test plan:

- Ensure that the OCLC Resource Sharing For Groups
module is enabled
- Ensure that the admin user you are logged in has the Administer OCLC
Resource Sharing For Groups Settings permission
- Navigate to Aspen Administration > Interlibrary Loan
- Select Resource Sharing For Groups Settings
- Select 'Add New'
- Name your form and select which fields you would like to see displayed
on it
- Save your changes
- Return to the list of setting and notice that the one you created has
been added
- Create some more setting
- Select one of them, edit it, save the changes
- Batch update some of them
- Batch delete some of them
- Export CSV for one, some, all settings
- Navigate to Primary Configuration > Locations
- In the Interlibrary Loans section, notice there is now an OCLC
Registry Id  with a default value of -1
- Set it to a different value, save your changes, and notice that the
entered value stills displays in the input field upon page reload
This enables admin with the right permissions to view existing Resource
Sharing For Groups forms, export them as CSV, update them, delete them
and create new ones.

The above is pre-existent behaviour. This test plan aims to ensure that
all functionalities normally present in Aspen (e.g for VDX) for form
Administration also work for the newly introduced Resource Sharing For
Groups forms.

Test plan:

- Ensure that the OCLC Resource Sharing For Groups module is enabled
- Ensure that the admin user you are logged in has the Administer OCLC
Resource Sharing For Groups Forms permission
- Navigate to Aspen Administration > Interlibrary Loan
- Select Resource Sharing For Groups Forms
- Select 'Add New'
- Name your form and select which fields you would like to see displayed
on it
- Save your changes
- Return to the list of forms and notice that the one you created has
been added
- Create some more forms
- Select one of them, edit it, save the changes
- Batch update some of them
- Batch delete some of them
- Export CSV for one, some, all forms
Creates the two following permissions in the Interlibrary Loans section
in Aspen Administration > System Administration > Permissions:
- Administer OCLC Resource Sharing For Groups Settings
- Administer OCLC Resource Sharing For Groups Forms

Test plan:
- ensure that the OCLC Resource Sharing For Groups is enabled in Aspen
Administration > Systems Administration > Modules
- navigate to Aspen Administration > System Administration > Permissions
> Interlibrary Loans
- notice the two new permissions
- notice that these are enabled for opacAdmin
Patrons that meet the following conditions will have the option to place
ILL requests for some of the records found in catalogue search results.

The patrons must:
- be logged in
- be on the website of their home library
- have a home library that has been assigned an OCLC RSFG Setting in
Aspen
- have a home location that has been assigned an OCLC RegistryId in
Aspen

The 'Request' option will only appear for records that meet all the
following criteria:
- they are found within the Aspen System
- no item for these records is available at the patron's home library
- no item for these records is available at a library that shares a hold
group with the patron's home library

Set up:
- ensure that the OCLC Setting, Form, and RegistryId have all been
properly assigned and set up for the home library and location of the
patron you will be testing as.
- also ensure that the library site you will be visiting is one of a
specific location (if using adb, it can be useful to set a library other
than 'main library' as default).
- start masquerading, or log in as this patron

Test plan:
- run a search
- select 'Entire Collection' to view all results, including those for
records not found at the patron's home library
- in the results, find a record that is not available at the patron's
home library (these will have a 'Available from another library' tag)
- notice the 'Request' button on the record
- select 'Request' and notice that a pop up opens containing a Request
form
- notice that most fields are pre-filled with the record's details and
check this agains the marc record

Note that:
- the ISBN field only display for records with an ISBN
- the ISSN field only displays for records with an ISSN
- the OCLC number field only displays for records with an OCLC number
- if none of these identifier numbers are found, two fields display
instead:
  - a 'Unique Record Identifier Key' dropdown field displays with ISSN,
ISBN, and OCLC number as available options
  - a 'Unique Record Identifer' input field displays
  - both of these are marked as required
Allow a patron meeting the requirements (see the previous commit for
details) to place an ILL request through the Resource Sharing API.

This assumes that:
- the OCLC RSFG integration in Aspen has been set up
- the tester is logged in / masquerading as a patron of a library with
an OCLC RSFG Setting assigned to it, and has a home location with an
OCLC registryId assigned to it

Test plan:
- run a catologue search to find a record showing as 'Available from
another library' and for which a 'Request' button is available
- select 'Request', and check that all required fields are pre-filled in
the form that pops up (if not, fill in any missing information)
-  select 'Submit'
- notice the success message
- allow 2-3 minutes for the request to have reached OCLC and be ready to
view
- Navigate to 'Titles On Hold' > 'Interlibrary Loans'
- Select 'Refresh'
- Notice that the record you requested now displays both under the 'all'
and the 'Interlibrary Loans' type
- Also notice that the number displayed next to 'all' and 'Interlibrary
Loans' has been increased by 1
Allow administrators to set Materials Requests to be sent through the
OCLC integration, so that records that are not found anywhere within a
given Aspen system can also be requested through the OCLC RS API.

Test plan:

- navigate to 'Aspen Administration' > 'Library Systems' and select a
library to edit
- navigate to Materials Request and open the Materials Request System
dropdown
- notice that 'OCLC Resource Sharing For Groups' is now an option
- set it to this, save, reload the page, and notice that the new value
is saved and displayed
Allow a patron meeting the requirements (see the previous commit for
details) to place a request for a record not found anywhere with the
Aspen system through the Resource Sharing API.

This assumes that:
- the OCLC RSFG integration in Aspen has been set up
- Materials Request are set to use the OCLC RSFG integration
- the tester is logged in / masquerading as a patron of a library with
an OCLC RSFG Setting assigned to it, and has a home location with an
OCLC registryId assigned to it

Test plan:
- run a search
- at the bottom of the search result page, notice the 'Submit Request'
button
- select 'Submit Request' and notice that the Materials Request page
that opens displays the OCLC ILL request form
- fill in the required fields (use a valid ISSN, ISBN or OCLC number)
- submit your request
- notice that you are redirected to Your Account > Titles on Hold
- wait 2-3 minutes before selecting 'Refresh' to reload your ILL
requests
- notice that your new request is now displayed, that there is no cover
image (due to this not being tied to an existing Aspen record), and that
the numbers next to the 'all' and 'Interlibrary Loan Requests' have been
increase by 1
Allow a patron meeting the requirements (see earlier DIS-65 commits for
details) to view the details of an ILL request which they have placed
through the OCLC RSFG integration in Aspen.

This assumes that:
- the OCLC RSFG integration in Aspen has been set up
- the tester is logged in / masquerading as a patron of a library with
an OCLC RSFG Setting assigned to it, and has a home location with an
OCLC registryId assigned to it
- this patron has one or more ILL requests placed through the OCLC
integration with the OCLC RS API that are active (their status is not
'CLOSED')

Test plan:
- navigate to My Account > Titles On Hold
- Click on the title of one of the ILL request showing under 'All' or
'Interlibrary Loan Requests'
- Notice that an 'Interlibrary Loan Request' page opens which displays
additional information on the ILL request

Note: the information displayed on both the ILL requests list in 'Titles
on Hold' and the detailed ILL request view in 'Interlibray Loan Request'
is issued from the OCLC Resource Sharing For Groups Sharing, that is to
say that it may not exactly match the information found on the record
that the patron initially requested (as this is is issue from the
library's catalogue).
These aim to ensure that the aspen database contains up-to-date active
ILL requests placed through the OCLC Resource Sharing For Groups
integration by periodically fetching from the RS API and updating the
user_oclc_resource_sharing_for_groups table in Aspen db.
@Chloe070196 Chloe070196 force-pushed the 25.02.00_resource_sharing_for_groups_phase_one branch from e668cc6 to 2334d93 Compare January 16, 2025 13:14
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

1 participant