Agreements and Licenses (ERM) - Trillium - Notes on functionality
- 1 New Feature: Acquisition Units support in Agreements and Licenses (UXPROD-5188, UXPROD-5605)
- 2 New Feature: GOKB remote title search integration (UXPROD-5193, UXPROD-5581)
- 3 New Feature: Local KB package content deletion (UXPROD-5189)
- 4 Feature enhancement: Entitlement log (UXPROD-5636)
- 5 General enhancements & bug fixes
New Feature: Acquisition Units support in Agreements and Licenses (UXPROD-5188, UXPROD-5605)
Summary
Agreements and Licenses now support Acquisition Units (the same mechanism used by Orders, Organisations, Invoices and Finance) to support fine-grained control over who can view, edit and delete agreements, agreement lines, licenses and amendments. Acquisition units work alongside FOLIO capabilities and allow libraries to grant groups of users access to specific agreements, agreement lines, licenses and amendments. Acquisition Unit filters have been added to agreement, agreement line, license and amendment search screens, and the Actions menus respect access control restrictions. From the user's perspective, this works seamlessly with existing Acquisition Units configuration — there is no need to set up separate groups.
For more on how Acquisition Units work and how to set them up and assign users, see the documentation at 
Settings > Acquisition units which describes how these already work with other modules.
Demonstration
To be added
Notes
Scope
Acquisition unit behaviour in Agreements and Licenses has been implemented in line with their behaviour in existing apps
Agreement lines inherit the acquisition units from their parent agreement (i.e. you cannot assign an acquisition unit directly to an agreement line, only to the agreement)
Amendments inherit the acquisition units from their parent license (i.e. you cannot assign an acquisition unit directly to an amendment, only to the license)
Capabilities/Permissions
To create, edit or delete acquisition units, users will need capabilities as described in the existing acquisition units documentation Settings > Acquisition units
New capabilities have been added to support the use of acquisition units in Agreements and Licenses, but these will be automatically assigned to any users as appropriate as part of existing capability sets. If the user has the capability set to view agreements/licenses, they also have the capabilities to view the acquisition units; If the user has the capability set to edit agreements/licenses, they also have the capabilities to edit the acquisition units assigned to the agreements licenses.
For completeness the new capabilities are:
app-agreements | Erm Accesspolicies | View
app-agreements | Erm Accesspolicies Collection | View
app-agreements | Erm Accesspolicies Enabledengines | View
app-agreements | Erm Accesspolicies Item | View
app-agreements | Erm Accesspolicies Policies | View
app-agreements | Erm Agreements Collection Accesscontrol | View
app-agreements | Erm Agreements Item Accesscontrol | View
app-agreements | Erm Agreements Item Policies | View
app-agreements | Erm Entitlements Collection Accesscontrol | View
app-agreements | Erm Entitlements Item Accesscontrol | View
app-agreements | Erm Entitlements Item Policies | View
app-agreements | Erm Agreements Item Accesscontrol | Execute
app-agreements | Erm Entitlements Item Accesscontrol | Execute
app-licenses | Licenses Accesspolicies | View
app-licenses | Licenses Accesspolicies Collection | View
app-licenses | Licenses Accesspolicies Enabledengines | View
app-licenses | Licenses Accesspolicies Item | View
app-licenses | Licenses Accesspolicies Policies | View
app-licenses | Licenses Licenses Collection Accesscontrol | View
app-licenses | Licenses Licenses Item Accesscontrol | View
app-licenses | Licenses Licenses Item Policies | View
app-licenses | Licenses Amendments Collection Accesscontrol | View
app-licenses | Licenses Amendments Item Accesscontrol | View
app-licenses | Licenses Amendments Item Policies | View
app-licenses | Licenses Licenses Item Accesscontrol | Execute
app-licenses | Licenses Amendments Item Accesscontrol | Execute
Known issues
No known issues
Documentation
https://folio-org.atlassian.net/browse/UXPROD-5188
https://folio-org.atlassian.net/browse/UXPROD-5605
Sprint demos:
New Feature: GOKB remote title search integration (UXPROD-5193, UXPROD-5581)
Summary
A new search interface in Agreements allows users to search for titles directly in GOKb (via the GOKb OpenSearch API) without those titles needing to be present in the local KB. Search results display title availability across packages, with options to synchronise related packages to the local KB and to create agreement lines directly from GOKb titles. Where a title already exists in the local KB, the user is directed to the local information including any existing agreements. Display of GOKb-sourced title data across the Agreements app has also been enhanced, including showing local KB package information for external entitlements and improved resource name display in agreement line listings.
Demonstration
To be added
Notes
Scope
Ability to search for GOKB titles from within Agreements using the GOKB Opensearch API
Display of Agreements information alongside GOKB title information (e.g. list of agreements for a title)
Capabilities/Permissions
Known issues
No known issues
Documentation
https://folio-org.atlassian.net/browse/UXPROD-5193
https://folio-org.atlassian.net/browse/UXPROD-5581
Relevant recordings, sprint demo videos, slide decks, etc.
http://Docs.folio.org pages
Relevant wiki pages
New Feature: Local KB package content deletion (UXPROD-5189)
Summary
It is now possible to delete the content (titles) of a package from the local knowledgebase while retaining the package header information. This is particularly useful for managing the size of the local KB following changes to selective GOKb synchronisation, and for removing data loaded via KBART or JSON file upload.
Package titles (PCIs) that are directly linked to an agreement line will not be deleted. Related metadata (platform title instances, title-level data) is automatically cleaned up when no longer referenced by any remaining package content.
Demonstration
To be added
Notes
Scope
Ability to delete package content and leave the package description in the system
Logic to correctly delete or leave any records attached to the package content (title and platform metadata)
Capabilities/Permissions
New capability set:
app-agreements | ui-agreements resources | delete
New capabilities (included in the ui-agreements resources | delete capability set)
app-agreements | Erm Resource | delete
app-agreements | Erm Resources Delete Collection | execute
app-agreements | Erm Resources MarkForDelete Collection | execute
Known issues
Documentation
https://folio-org.atlassian.net/browse/UXPROD-5189
Relevant recordings, sprint demo videos, slide decks, etc.
http://Docs.folio.org pages
Relevant wiki pages
Feature enhancement: Entitlement log (UXPROD-5636)
Summary
The Entitlement Log (Entitlement Log Documentation) is a log of which resources (from the Agreements Local KB only) have been added to, updated within or removed from a library's collection of electronic resources based on their current agreements. The purpose of the log is to give an external system (such as a discovery system) the ability to keep up to date with the resources available within a library collection by incrementally consuming events from the log over time.
In this release the entitlement log has been enhanced to include additional data in each log entry. Specifically: package identifiers and resource URLs (including URLs modified by proxy or platform URL templates).
Demonstration
To be added
Notes
Scope
Addition of all related package IDs to each entitlement log entry
Addition of all resource URLs, including proxy/platform URLs, to each entitlement log entry
Permissions
Known issues
Documentation
https://folio-org.atlassian.net/browse/UXPROD-5636
Relevant recordings, sprint demo videos, slide decks, etc.
http://Docs.folio.org pages
Relevant wiki pages
General enhancements & bug fixes
https://folio-org.atlassian.net/browse/UXPROD-5256
The publicLookup API (used for non-authenticated queries to discover which agreements cover a resource and what license terms apply) can now be queried by Package UUID, Title UUID, PTI UUID and PCI UUID — with correct results for each. Additionally, querying by resource identifiers such as ISSN, EZBID, ZDBID, ISBN and DOI is now supported. Fixes have also been made to access and active date handling for PCI-based agreement lines.
https://folio-org.atlassian.net/browse/UXPROD-4434
A systematic usability and accessibility review of Agreements and Licenses has been carried out, with resulting changes implemented across both apps.
https://folio-org.atlassian.net/browse/UXPROD-5194
The Agreements display settings (suppress from discovery flags, hidden accordions, eHoldings functionality toggle, and page sizes for MCLs) have been migrated from mod-configuration to app settings stored within mod-agreements. The dependency on the now deprecated mod-configuration has been removed from ui-agreements. NOTE: Existing display settings (suppress from discovery flags, hidden accordions, eHoldings functionality toggle, and page sizes for MCLs) are not migrated from mod-configuration to the new storage, and settings will need re-setting manually after upgrade to Trillium is complete.
https://folio-org.atlassian.net/browse/UXPROD-5383
New read-only API endpoints (GET /erm/identifiers and GET /erm/identifiers/<UUID>) allow direct access to identifiers in the local KB. Identifiers can be searched by namespace and value, supporting use cases such as finding identifiers without any identifier occurrences or retrieving all identifiers in a given namespace.
Bugfixes
All bugs fixed in the Trillium releases of Agreements and Licenses are listed here