Q3 2020 (Honeysuckle) Release Notes






Important Upgrade Considerations

This section outlines all changes that require special consideration for customers in production.  Configuration changes may be needed to prevent operational interruptions.  See checklist for guidelines on how to fill this out. 

Changes and Required Actions


Functional AreaChange or AdditionConsiderationsAction requiredAction timingContact personCommentsRelated JIRA issues
Affected app or moduleWhat has been changed or added that should be noted for this releaseWhat challenges may arise related to this change or additionIf applicable, detail what action(s) must be taken hereWhen can the action be taken (before, during or after upgrade)User name of person that can provide additional detailName of user leaving comment: comment on what you encountered or ask a question @mention Contact personInclude issue link for bug fix, story or feature that applies
edge-rtacNew endpoints have been added to edge-rtacNgnx configuration needs to be updated in every environment, where edge-rtac is used

The nginx proxy for edge modules in the environments needs to be able to route to two different paths on the edge-rtac module:

* /prod/rtac/folioRTAC
* /rtac
Before upgradehttps://github.com/folio-org/edge-rtac#configuration

FOLIO-2835 - Getting issue details... STATUS

ui-agreementsIf a EBSCO KB customer,  please go to Settings > Agreements > Display settings and uncheck the settings under "Display "Suppress from discovery" setting on." These settings are not applicable. 

Change can be done before or after upgrade. 

Permissions - Finance

The following were replaced by more granular permissions: Finance: all permissions for View and Edit ledgers, funds, budgets and fiscal years

Finance: View groups, ledgers, funds, budgets and fiscal years

The permission should still display in your instance as no script was written to delete them.You are advised to update your finance related permissions sets, if you have any, and your users perms. simply remove the old ones and add the desired finance perms in the new format.Anytime after upgrade

UIF-228 - Getting issue details... STATUS

ui-ordersWhen creating an order the "Re-encumber" toggle is set to active by default. Once fiscal year rollover is implemented in R1, if you choose to rollover encumbrances for the type of order. The system will then look to this field to determine if each individual "Open" order of that type will be encumber in the upcoming year.Order templates will potentially override this setting. If you want to re-encumber these orders you should revise your order templates and confirm this box is checked. This way when applying the order template the re-encumber toggle will still be active by default.Could be done before or after upgrade. The sooner the better

UIOR-622 - Getting issue details... STATUS

mod-data-import/mod-data-export

Previously these modules did not support running in HA mode(more than 1 instance of the module running)


It has been agreed that it will be the hoster's responsibility to create a persistent shared volume that can be shared between the tasks to run the modules in HA mode

Both these modules will be considered Horizontally Scalable

If mod-data-import or mod-data-export are being run with multiple tasks, then a persistent shared volume must be configured to save the files. The files are temporary and will be auto-deleted using a timer job periodically


  • data-export : The file storage path used in the module is 

    "./storage/files" (for now this cannot be changed)

Change can be done anytime, just that any jobs triggered will fail if multiple tasks are running

Kruthi Vuppala (data-export)
Taras Spashchenko (data-import)

https://github.com/folio-org/mod-data-import#module-properties-to-set-up-at-mod-configuration

Horizontal Scalability Document

Presented in tech-leads meeting: /wiki/spaces/TLG/pages/754196

ui-eholdings/mod-kb-ebsco-javaDatabase schema restructuring was doneWhen multiple tenants are deployed to an environment or when a new tenant is installed that has not been setup with accurate HoldingsIQ credentials prior to upgrade, eHoldings app becomes non-functional. For the multiple tenants situation, newer version of mod-kb-ebsco-java is needed v.3.6.4 or v3.6.5(hotfix-1 version)

For single tenant on a fresh install, HoldingsIQ credentials can be configured from the UI using a PUT/PATCH request like below:

PUT https://{okapi-url}/eholdings/kb-credentials/80898dee-449f-44dd-9c8e-37d5eb469b1d with request body like

{
"data": {
"id": "80898dee-449f-44dd-9c8e-37d5eb469b1d",
"type": "kbCredentials",
"attributes": {
"name": "Knowledge Base",
"apiKey": "****",
"url": "https://api.ebsco.io" or "https://sandbox.ebsco.io", - based on whether its sandbox account or prod account
"customerId": "***"
}
}
}
After the upgrade

MODKBEKBJ-537 - Getting issue details... STATUS MODKBEKBJ-550 - Getting issue details... STATUS

mod-agreementsSupplementary Document cleanupWhen upgrading from Goldenrod consider running the Supplementary Document cleanup job on initialising the module in the tenant. This is to fix an issue that could lead to a single supplementary document being linked to multiple agreements. The cleanup job will detect this situation and duplicate the document so each agreement is linked to it's own copy of the document

On installing the module in the tenant, include

cleanSupplementaryDocs%3Dtrue

in the tenantParameters.

e.g.

/_/proxy/tenants/diku/install?tenantParameters=cleanSupplementaryDocs%3Dtrue
After the upgradeOwen Stephens

ERM-1114 - Getting issue details... STATUS


New Apps

Circulation log

The Circulation log displays a report of circulation actions. Circulation actions can be viewed through filters like user barcode, item barcode, date range, loan actions, request actions and more.

ERM comparisons

Permissions Updates

Here link to Wayne Schneider 's spreadsheet which compare the permissions for Goldenrod and for Honeysuckle - https://docs.google.com/spreadsheets/d/1l8Bq0ptxIS7NYPwMwq-34Rx7hrnqkMofRtuE5QktnLw/edit?usp=sharing 

AppNew PermissionsDeprecated PermissionsProduct Owner
eholdings
  • Settings (eHoldings): Can delete knowledge base credentials
  • Settings (eholdings): Can create, edit, view, and delete custom labels
  • Settings (eholdings): Can view custom labels

Inventory
  • Fast add: Create
  • Inventory: Move holdings
  • Inventory: Move items
  • Settings (Inventory): Edit fast add settings

Users
  • Settings (Users): View departments
  • Settings (Users): Create, edit, and view departments
  • Settings (Users): Create, edit, view, and delete departments

Circulation
  • Circulation log: All

Stephanie Buck
Finance
  • Finance: View fiscal year
  • Finance: View, edit fiscal year
  • Finance: View, edit, create fiscal year
  • Finance: View, edit, delete fiscal year
  • Finance: View ledger
  • Finance: View, edit ledger
  • Finance: View, edit, create ledger
  • Finance: View, edit, delete ledger
  • Finance: View group
  • Finance: View, edit group
  • Finance: View, edit, create group
  • Finance: View, edit, delete group
  • Finance: View fund and budget
  • Finance: View, edit fund and budget
  • Finance: View, edit, create fund and budget
  • Finance: View, edit, delete fund and budget

Finance: all permissions for View and Edit ledgers, funds, budgets, and fiscal years

Finance: View groups, ledgers, funds, budgets and fiscal years

ERM comparison
  • ERM Comparisons: Create jobs
  • ERM Comparisons: Delete jobs
  • ERM comparisons: View jobs


Known Issues

Circulation log

  • Fees/fines filter "Partial refund" will not load results. Manual refunds were not implemented for Honeysuckle.
  • Requests filter "Pickup expired" does not load results. A bug has been filed and will be released with R1 Iris. 

Data Import

Inventory

  • Item with Lost and paid item status throws an error when marked as Withdrawn (UIIN-1362)
  • Ability to maintain relationships between other apps when holdings/items are moved (UXPROD-1647); e.g. sync of data between Inventory and Orders, Inventory and Request.

Orders:

  • Orders with NO fund distribution can not be unopened. Workaround is to add a Fund distribution and then unopen the order and remove it. This has already been resolved for future releases.
  • MODORDERS-502 - Getting issue details... STATUS  If users "Unopen" orders that have "Manually add pieces for receiving" = true. If they have created any pieces they will not be able to open the order again without deleting pieces from the receiving area. System will force user to delete as part of open order process. Not you can delete and recreate the necessary records after the fact. 

Organizations:

  • If user wants to edit EDI scheduling date in organization record, it must be done without editing any other fields at the same time. Otherwise it will produce an error and force user to start over. This is already resolved in the R1 2021 release because the organizations CRUD forms have been migrated to React-final-form. The EDI scheduling is not yet active in the Q3 release so this was not considered a critical issue for Q3.  UIORGS-214 - Getting issue details... STATUS   UIORGS-200 - Getting issue details... STATUS

PubSub

  • Multiple versions of mod-PubSub in the same environment may consume events for all tenants. This can only be resolved by deleting all previous versions of mod-pubsub, then upgrading to the newest version after release 

OAI-PMH

  • Initial instance load for a ListRecords request using the marc21_withholdings metadata prefix can cause a large number of database connections to be created. It is not recommended to use this feature. The problem will be addressed in the R1 2021 release.

Automated patron blocks

  • Events which took place before first mod-patron-blocks deployment are NOT taken into account while calculating automated patron blocks. In order to make mod-patron-blocks recognize these events, a full event synchronization must be executed:

    POST /automated-patron-blocks/synchronization/job
    {
      "scope": "full"
    }

    "id" returned in the response is the synchronization job ID which can then be used to track the job status:

    GET /automated-patron-blocks/synchronization/job/{syncJobId}

    This synchronization procedure has to be performed only once per environment. See MODPATBLK-41 for details.


General

Notes on functionality

Data Import

  • Supported in Honeysuckle:
    • Import of MARC Bibliographic records, Inventory Instances, Inventory Holdings, and Inventory Items
    • Create and update of the above record types
    • Ability to remove data from an existing Inventory record field
    • Refined handling of the Item record Status field during import
    • Refined the field mapping for repeatable fields to allow for: Add to existing, Remove all, Remove the specified one(s), Remove all and replace with the specified one(s)
    • Matching from MARC Bibliographic record to Instance, Holdings, and Item HRIDs and UUIDs
    • Ability to modify MARC records at point of import to add, delete, edit, or move fields, subfields, and the data in them
    • New setting to protect specific MARC fields from being updated
    • Ability to override the MARC field protections and update protected MARC fields in specific import jobs
    • Ability to stop/end a job that is stuck in Running
    • Landing page updates to move the file upload area to the top left and reorganize the columns of the import log
    • Ability to update individual MARC fields in an existing record, instead of replacing the entire record

Inventory

  • Supported in Honeysuckle:
    • Distinct Holdings statements notes as either Public or Staff only notes
    • Easy way to copy HRIDs in Inventory (instance, holdings, item)

    • Implement new Source data element in the holdings record to support MARC and MFHD
    • Move holdings and/or items - when the change is triggered by external source

    • Move of holdings and items from one instance to another instance 
    • Move of items from one holdings to another holdings within the same instance
    • New Fast Add template for circulation staff to create instance, holdings and item records on the fly. Access to template from  Inventory and the Check out screen
    • UI Improvements of display of Holdings and Item list in the top of the Instance record. Add copy number

Requests

  • Supported in Honeysuckle:
    • View list of all items in an instance along with the number of open requests on each (click "view requests" in Instance Actions menu)
    • Add staff notes to request record
    • Filter requests by pickup service point

Agreements

  • Supported in Honeysuckle:
    • Suppress from Discovery flag on Titles in local KB
    • Ability to add Agreement lines which are not linked to a resource to enable recording of agreements for resources not described in one of the available knowledgebases
    • New (additional) workflow for creating, viewing and deleting Agreement lines
    • Improved validation of supplementary property values
    • New "publication type" property for resources in the internal knowledgebase, with user defined values
    • Updated search options including
      • text search supports both phrase and non-phrase searching
      • text search search to include agreement description
      • separate filters for organisations and organisation roles
      • filter for new "publication type" property
    • Notes on organisation links

Local KB Admin

  • Supported in Honeysuckle:
    • Improvements to error and information logging for data loads to the Agreements local KB

ERM comparisons

  • Supported in Honeysuckle:
    • Comparison of the content (i.e. resources included) of agreements and/or packages where these are based on resources described in the Agreements local knowledgebase
    • Compare agreements and packages to each other, or themselves, on specific dates

Licenses

  • Supported in Honeysuckle:
    • Updated search options including
      • text search supports both phrase and non-phrase searching
      • text search search to include license description
      • separate filters for organisations and organisation roles
    • Improved validation of license term values
    • Notes on organisation links

Post-Release Hotfixes

Hot fix release #1 - RELEASED AT JANUARY 27

Tickets list

key summary type assignee priority resolution reporter
Loading...
Refresh

Modules list


The Jira server didn't understand your search query. If you entered JQL, please ensure that it's correctly formed. If you entered an issue key, ensure that it exists and you have permission to view it.

+mod-user-import


Hot fix release #2 - RELEASED AT FEBRUARY 11

Tickets list

key summary type assignee priority resolution reporter
Loading...
Refresh

Modules list


The Jira server didn't understand your search query. If you entered JQL, please ensure that it's correctly formed. If you entered an issue key, ensure that it exists and you have permission to view it.

Hot fix release #3 - RELEASED AT MARCH 11

Tickets list

key summary type assignee priority resolution reporter
Loading...
Refresh

Modules list


The Jira server didn't understand your search query. If you entered JQL, please ensure that it's correctly formed. If you entered an issue key, ensure that it exists and you have permission to view it.

New Features by Epic (Sub-Project)

key summary
Loading...
Refresh

Closed Bugs

Project Priority
P1P1 P2P2 P3P3 P4P4 P5P5 TBDTBD T:
ARCHIVED: mod-aes 0 0 0 0 0 5 5
Chalmers 0 0 5 1 0 33 39
ERM Platform 6 7 5 1 0 60 79
FOLIO 1 6 7 1 0 12 27
LDP Query 0 0 0 0 0 1 1
Okapi 5 9 4 1 0 23 42
RAML Module Builder 3 16 26 0 0 2 47
Reporting Tools 0 0 0 0 0 1 1
Stripes 1 1 3 0 0 1 6
Support 0 4 1 0 0 1 6
Z39.50 1 0 0 0 0 0 1
data-import-processing-core 0 10 3 0 0 0 13
edge-common 0 0 1 0 0 0 1
edge-oai-pmh 0 0 0 0 0 1 1
edge-rtac 0 1 0 0 0 0 1
folio-custom-fields 0 0 1 0 0 0 1
mod-audit 1 2 6 0 0 1 10
mod-authtoken 0 0 0 0 0 1 1
mod-circulation 3 33 12 3 0 3 54
mod-circulation-storage 0 4 2 0 0 0 6
mod-configuration 0 0 1 0 0 0 1
mod-courses 1 0 0 0 0 0 1
mod-data-export 2 8 12 0 0 0 22
mod-data-import 2 3 1 0 0 0 6
mod-di-converter-storage 1 0 0 0 0 0 1
mod-erm-usage 0 1 0 0 0 5 6
mod-erm-usage-harvester 0 0 0 0 0 1 1
mod-eusage-counter 0 0 0 0 0 1 1
mod-feesfines 0 6 5 0 0 1 12
mod-finance 1 0 3 0 0 0 4
mod-finance-storage 0 4 4 0 0 0 8
mod-gobi 0 1 1 0 0 0 2
mod-graphql 0 0 0 0 0 1 1
mod-inventory 1 9 3 0 0 1 14
mod-inventory-storage 3 10 4 1 0 3 21
mod-invoice 0 5 5 0 0 0 10
mod-invoice-storage 0 1 1 0 0 0 2
mod-kb-ebsco-java 0 2 1 0 0 0 3
mod-login 0 0 0 0 0 2 2
mod-login-saml 0 3 1 0 0 0 4
mod-ncip 0 1 0 0 0 0 1
mod-notes 0 1 0 0 0 0 1
mod-notify 0 0 0 0 0 1 1
mod-oai-pmh 7 4 3 2 0 4 20
mod-orders 0 8 6 0 0 1 15
mod-orders-storage 1 1 2 0 0 0 4
mod-organizations 0 1 0 0 0 0 1
mod-organizations-storage 0 1 0 0 0 0 1
mod-patron-blocks 0 19 1 0 0 0 20
mod-permissions 0 3 1 2 0 3 9
mod-pubsub 3 2 1 0 0 0 6
mod-quick-marc 0 3 0 0 0 1 4
mod-rtac 2 1 0 0 0 0 3
mod-source-record-manager 1 9 3 0 0 0 13
mod-source-record-storage 0 7 1 0 0 0 8
mod-template-engine 0 1 1 0 0 0 2
mod-user-import 0 0 2 0 0 0 2
mod-users 0 2 2 0 0 1 5
mod-users-bl 0 1 3 0 0 1 5
stripes-acq-components 0 1 1 1 0 0 3
stripes-cli 0 0 1 0 0 1 2
stripes-components 0 3 21 0 0 0 24
stripes-connect 0 0 1 0 0 0 1
stripes-core 1 2 3 2 0 3 11
stripes-data-transfer-components 0 1 0 0 0 0 1
stripes-form 0 1 0 0 0 0 1
stripes-smart-components 0 7 26 0 0 1 34
ui-calendar 0 2 1 0 0 0 3
ui-checkin 1 3 2 1 0 0 7
ui-checkout 0 5 1 0 0 1 7
ui-circulation 0 10 5 1 0 0 16
ui-circulation-log 0 0 1 0 0 0 1
ui-courses