Agreements work: EBSCO KB + Agreements app integration (UXPROD-1548)

[UXPROD-1549] Agreements App: Search EBSCO KB via eResources Tab Created: 01/Mar/19  Updated: 15/Mar/19  Resolved: 15/Mar/19

Status: Closed
Project: UX Product
Components: None
Affects versions: None
Fix versions: None
Parent: Agreements work: EBSCO KB + Agreements app integration

Type: Sub-task Priority: P3
Reporter: Khalilah Gambrell Assignee: Unassigned
Resolution: Won't Do Votes: 0
Labels: None
Remaining Estimate: Not Specified
Time Spent: Not Specified
Original estimate: Not Specified

Issue links:
Relates
relates to ERM-299 Filter e-resource packages by source Closed
relates to UXPROD-582 Add resources to agreements Closed
relates to UXPROD-1523 Codex Search App: General Search Enha... Closed
relates to UXPROD-1524 eholdings work: eholdings app + Agree... Closed
Development Team: Spitfire

 Description   

As an electronic resource librarian
I want to search the KB(s) my library uses to manage its resources

Agreements App Requirements

  • Via eResources tab allow user to search EBSCO KB for packages and titles
  • Only libraries that have EBSCO KB setup under Settings > eholdings > Knowledgebase are eligible to search EBSCO KB

Acceptance Criteria
Given I have successfully setup EBSCO KB in Folio
When I conduct a search for 'Academic' on the eResources tab on the Agreements app
Then return all EBSCO KB package and title results that contain 'Academic' in the package or title name

Given I have not sucessfully setup EBSCO KB in Folio
When I conduct a search for 'Academic' on the eResources tab on the Agreements app
Then do not return any EBSCO KB package and title results
AND display an error to inform me that EBSCO KB is not properly setup

Given I have not setup EBSCO KB in Folio
When I conduct a search for 'Academic' on the eResources tab on the Agreements app
Then do not return any EBSCO KB package and title results



 Comments   
Comment by Ian Ibbotson (Use this one) [ 08/Mar/19 ]

It is critically important to note that agreements currently supports searching a local KB - this story is to provide an alternate / additional path to searching a different KB, not INSTEAD of the current implementation. There will also be a need, therefore, to define the mechanism that allows the user to say which KB they want the eResources tab to search - this might be per-tenant config, per user config, or per search operation - depending on the story.

Integration tests on ui-agreements should provide some regression protection, but care should be taken.

Comment by Khalilah Gambrell [ 12/Mar/19 ]

Adding Owen's 3/12 email response
"Specifically, I want to check: 1. Agreements App: Search EBSCO KB via eResources Tab
• As this (it seems to me) would lead to two ways of adding eHoldings resources to an Agreement - which feels like it is one too many. It also means supporting a different approach to search (because eResource search mixes titles and packages)
• Would it make sense and be suitable to support search of eHoldings resources via the existing eHoldings search interface, and adding resources to the Agreements basket (and from there to the Agreement) - which I think is already covered under the other tasks?
• I just want to make sure we aren’t trying to do something difficult (make eHoldings resources fit into the eResources search view) when we could achieve the same functionality for the user using the existing search that eHoldings already has.
• It’s possible that I’ve misunderstood where the complexity lies or exactly what is required to meet Chalmers requirements, and if that is the case accept my apologies and lets get on with the work!"

Comment by Khalilah Gambrell [ 12/Mar/19 ]

Adding Ian's 3/12 email response
"On 12 Mar 2019, at 16:57, Ian Ibbotson <ian.ibbotson@k-int.com> wrote:
Adding Steve in so he can double check my workings out.
OK - Firstly, there are some prerequisites - Obviously, we need the codex package search endpoint for this to be completed - Can you confirm that is in the testing build and working as expected? We'll assume so.
1. Agreements App: Search EBSCO KB via eResources Tab
2. Agreements app: Access EBSCO KB package and title metadata
Open Unassigned
3. Agreements app: Attach an EBSCO KB package or title to an Agreement line

  • Subtasks on these three:
  • .5d to update the UI to provide radio button toggles to allow users to select between local-kb, Codex-Titles and Codex-Packages (Unless codex no supports unified search over titles and packages) - and assuming that UX is acceptable to you?
  • Define the internal abstract class for searching KB sources - done 0d
  • Implement that class for local-kb - Done - 0d
  • Implement that class for Codex-Titles - .5d for baseline, .5d for converting the filter params
  • Implement that class for Codex-Packages - .5d + .5d as above, assuming this component is available and working
  • Update ui-agreements to use this new layout in eResources search results screen - .5d
  • Define abstract interface for returning availability options -.5d
  • Implement for local-KB - .5d
  • Implement for codex-titles - .5d
  • Implement for codex-packages - .5d
  • Extend interface for fetching existing entitlements/agreements via external reference - 1d
  • Optionally - add default settings for default radio button source on KB select - 1d (New backend interface needed, so bit longer than you might expect) "
Comment by Carole Godfrey [ 12/Mar/19 ]

On Status of Codex Packages Endpoint:

The endpoints for Get Package by Id and Get Package Collection are available for mod-codex-ekb in the following environment http://folio-testing.aws.indexdata.com and in folio/testing vagrant box - v5.0.0-20190312.1769

On the request, you will need to indicate x-okapi-module-id in header and indicate mod-codex-ekb with specific version - for example

FOLIO testing was at - codex-ekb-1.1.1-SNAPSHOT.85

Vagrant box was at – codex-ekb-1.1.1-SNAPSHOT.86

One ticket is left on implementing MUX collection – https://folio-org.atlassian.net/browse/MODCXMUX-33 - after which you will be able to make the request to the MUX and eliminate the need to indicate module in x-okapi-module-id header

Below are sample requests and responses

GET http://folio-testing-backend01.aws.indexdata.com:9130/codex-packages?query=(name=ABC)`
{
    "packages": [
        {
            "id": "1075-7698",
            "name": "ABC Chemistry: Directory of Free Full-Text Journals in Chemistry",
            "type": "onlinereference",
            "providerId": "1075",
            "provider": "ABC Chemistry",
            "itemCount": 1,
            "coverage": {
                "beginCoverage": "2018-08-13",
                "endCoverage": "2018-09-13"
            },
            "isSelected": "Yes",
            "source": "kb"
        },
        {
            "id": "123355-3124668",
            "name": "abc test sd",
            "type": "onlinereference",
            "providerId": "123355",
            "provider": "API DEV CORPORATE CUSTOMER",
            "itemCount": 21,
            "coverage": {
                "beginCoverage": "2019-02-12",
                "endCoverage": "2019-02-20"
            },
            "isSelected": "Yes",
            "source": "kb"
        },
        {
            "id": "583-4345",
            "name": "ABC-CLIO eBook Collection",
            "type": "ebook",
            "providerId": "583",
            "provider": "ABC-CLIO",
            "itemCount": 9667,
            "coverage": {
                "beginCoverage": "2018-08-13",
                "endCoverage": "2018-09-13"
            },
            "isSelected": "Yes",
            "source": "kb"
        },
        {
            "id": "583-2356523",
            "name": "ABC-CLIO eBook Collection 2008 (TAEBC)",
            "type": "ebook",
            "providerId": "583",
            "provider": "ABC-CLIO",
            "itemCount": 693,
            "coverage": {
                "beginCoverage": "2018-08-13",
                "endCoverage": "2018-09-13"
            },
            "isSelected": "Yes",
            "source": "kb"
        },
        {
            "id": "583-2356522",
            "name": "ABC-CLIO eBook Collection 2009 (TAEBC)",
            "type": "ebook",
            "providerId": "583",
            "provider": "ABC-CLIO",
            "itemCount": 1624,
            "coverage": {
                "beginCoverage": "2018-08-13",
                "endCoverage": "2018-09-13"
            },
            "isSelected": "Yes",
            "source": "kb"
        },
        {
            "id": "583-2356521",
            "name": "ABC-CLIO eBook Collection 2010 (TAEBC)",
            "type": "ebook",
            "providerId": "583",
            "provider": "ABC-CLIO",
            "itemCount": 359,
            "coverage": {
                "beginCoverage": "2018-08-13",
                "endCoverage": "2018-09-13"
            },
            "isSelected": "Yes",
            "source": "kb"
        },
        {
            "id": "583-2356520",
            "name": "ABC-CLIO eBook Collection 2011 (TAEBC)",
            "type": "ebook",
            "providerId": "583",
            "provider": "ABC-CLIO",
            "itemCount": 221,
            "coverage": {
                "beginCoverage": "2018-08-13",
                "endCoverage": "2018-09-13"
            },
            "isSelected": "Yes",
            "source": "kb"
        },
        {
            "id": "583-2356519",
            "name": "ABC-CLIO eBook Collection 2012 (TAEBC)",
            "type": "ebook",
            "providerId": "583",
            "provider": "ABC-CLIO",
            "itemCount": 302,
            "coverage": {
                "beginCoverage": "",
                "endCoverage": ""
            },
            "isSelected": "Yes",
            "source": "kb"
        },
        {
            "id": "583-2356518",
            "name": "ABC-CLIO eBook Collection 2014 (TAEBC)",
            "type": "ebook",
            "providerId": "583",
            "provider": "ABC-CLIO",
            "itemCount": 169,
            "coverage": {
                "beginCoverage": "2018-08-13",
                "endCoverage": "2018-09-13"
            },
            "isSelected": "Yes",
            "source": "kb"
        },
        {
            "id": "203-5302",
            "name": "Credo ABC-CLIO Collection",
            "type": "aggregatedfulltext",
            "providerId": "203",
            "provider": "Credo Reference",
            "itemCount": 339,
            "coverage": {
                "beginCoverage": "2018-08-13",
                "endCoverage": "2018-09-13"
            },
            "isSelected": "Yes",
            "source": "kb"
        }
    ],
    "resultInfo": {
        "totalRecords": 12,
        "facets": [],
        "diagnostics": []
    }
}
GET http://folio-testing-backend01.aws.indexdata.com:9130/codex-packages/583-4345
{
    "id": "583-4345",
    "name": "ABC-CLIO eBook Collection",
    "type": "ebook",
    "providerId": "583",
    "provider": "ABC-CLIO",
    "itemCount": 9667,
    "coverage": {
        "beginCoverage": "2018-08-13",
        "endCoverage": "2018-09-13"
    },
    "isSelected": "Yes",
    "source": "kb"
}
Comment by Khalilah Gambrell [ 12/Mar/19 ]

Owen Stephens's suggestion is definitely one to consider as a MVP and eholdings is already working on attaching agreements to packages/title+packages.

Generated at Fri Feb 09 00:16:28 UTC 2024 using Jira 1001.0.0-SNAPSHOT#100246-sha1:7a5c50119eb0633d306e14180817ddef5e80c75d.