...
Functional Area | Change or Addition | Considerations | Action timing, | Comments | Contact person, | ||||||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| Affected app or module | What has been changed or added that should be noted for this release | What challenges may arise related to this change or addition | When can the action be taken (before, during or after upgrade)? If applicable, detail what action(s) must be taken here Is this action required for the next release? | Name of user leaving comment: comment on what you encountered or ask a question @mention Contact person | User name of person that can provide additional detail. Include issue link for bug fix, story or feature that applies | ||||||||||||||||||||||
| Okapi | Old Okapi versions fail with "POST request for mod-permissions-6.2.0 /_/tenantpermissions failed with 400: Collision! A Permission named converter-storage.jobprofile.get is already defined" because mod-data-import-converter-storage has been renamed to mod-di-converter-storage | Before installing/upgrading any modules upgrade Okapi to the latest 5.0.x version. | |||||||||||||||||||||||||
| mod-remote-storage | Hazelcast version is incompatible with the Nolana Hazelcast version | Module fails during startup | When running Nolana and Orchid version of mod-remote-storage in parallel they need distinct Hazelcast configurations. One possibility is the Hazelcast cluster name environment variable: HZ_CLUSTERNAME=nolana | ||||||||||||||||||||||||
| All areas - change in Google Chrome | Google Chrome has changed the way it defines websites that are designed for the web but are also meant to be able to be used like desktop apps (called "Progressive web apps", see very technical information from Mozilla here.) Some versions of Chrome now appear to consider some FOLIO installations to be "progressive web apps." When that happens, Chrome prompts you to install FOLIO to your desktop, with an option in the Chrome menu or in the address bar: | As of April 2023, this has been observed for some users using Nolana environments, and some users using Orchid environments. There is no feasible way to disable the message from appearing, however, end-users can safely ignore the message when they see it. You do not need to install anything extra outside of the Chrome browser to get FOLIO to work as it has been working. | Reported/researched by Erin Nettifee, with assistance from Zak Burke. | ||||||||||||||||||||||||
| Actual cost | The actual cost work begun in Nolana is completed in Orchid. | Carried over from Nolana release notes If you started using actual cost in Nolana, when Orchid is implemented you will need to mark items as “do not bill” on the “Lost items requiring actual cost” processing page if the fee was billed manually. The "Lost item fee policy" includes a setting For lost items not charged a fee/fine, close the loan after <interval>. Using this setting to "expire" actual cost lost items will eliminate the need for this if you set the <interval> to a smaller time period. | This work was completed after the PO, Holly Mistlebauer, retired. | ||||||||||||||||||||||||
| Circulation, Requests | Request status is now a required property. | Technically a breaking change | No action required | While technically being a breaking change, this should not affect anyone because: a) we never create requests without status programmatically b) we scanned DBs of known tenants and did not find a single such request | |||||||||||||||||||||||
| Data import, MARC Authority, Inventory, SRS | New indexes to the DB were added for the "010" and "035" MARC fields, to improve stability and decrease timeouts | Indexes are added automatically during the upgrade process. Default DB configuration implies automatic analyzing of tables. In case it is disabled, execute ANALYZE command on mod-source-record-storage schemas. |
| ||||||||||||||||||||||||
| Data import, MARC Authority, Inventory, SRS | Applicable for systems, where Data Import jobs for update of >5000 MARC records are expected. | Increase database connection pool size for mod-source-record-manager and mod-source-record-storage to 30 (default value is 15). Env variable:
Set the newly provided "DB_CONNECTION_TIMEOUT" env variable to 40 for mod-source-record-storage.
|
| ||||||||||||||||||||||||
| Inventory, Search | Breaking change was introduced in API interfaces:
| If there are any scripts, requests, or any that rely on these API interfaces, then they may be broken. Updated API documentation could be found here. | Instance data in mod-inventory-storage have to be migrated. To initialize migration use endpoint POST /inventory-storage/migrations/jobs with body:
To check the status of migration use endpoint GET /inventory-storage/migrations/jobs/<id> where id - is the id from the POST response. Migration could be done after the upgrade. | ||||||||||||||||||||||||
| Inventory, SRS, Data import | Default MARC-Instance mapping updated to change how the Relator term is populated on an instance record | Libraries should review and decide:
| See Update of mapping to change how Relator term is populated on instance record R1 2023 Orchid release for additional details. Update: 21 April: an update script has been provided. Mandatory change. Note that any revised mappings will only apply to Instances created or updated via MARC Bibs after the map is updated. To refresh existing Instances against the current SRS MARC Bibs and current map, the library may consider running Script 3 described here: Scripts for Inventory, Source Record Storage, and Data Import Cleanup | If the library wants more name relator terms to be standardized, for searching and filtering, this update will help. |
| ||||||||||||||||||||||
| Inventory, SRS, Data import | Default MARC-Instance mapping rule added for MARC 720 field | Libraries should review and decide:
| See Update of mapping to add MARC 720 field R1 2023 Orchid release for additional details. Follow the instruction to update the mapping rules. Optional change. Note that any revised mappings will only apply to Instances created or updated via MARC Bibs after the map is updated. To refresh existing Instances against the current SRS MARC Bibs and current map, the library may consider running Script 3 described here: Scripts for Inventory, Source Record Storage, and Data Import Cleanup |
| |||||||||||||||||||||||
| Data Import | EDIFACT invoice field mapping profile | Library should review | If the account number field is not being populated when an EDIFACT invoice is imported, the library should edit any existing invoice field mapping profiles, to 1) disconnect from the existing vendor and erase any account number, then 2) look up/reconnect the vendor and confirm an account number is filled in (if applicable). |
| |||||||||||||||||||||||
| LDP Reporting app | (text to be added here) | ||||||||||||||||||||||||||
| OAI-PMH (mod-oai-pmh) | For stable operation, mod-oai-pmh requires the following memory configuration. Java: -XX:MetaspaceSize=384m -XX:MaxMetaspaceSize=512m -Xmx2160m. Amazon Container: cpu - 2048, memory - 3072, memoryReservation - 2765. edge-oai-pmh memory settings remain the same as in previous releases. Java: -XX:MetaspaceSize=384m -XX:MaxMetaspaceSize=512m -Xmx1440m. Amazon Container: cpu - 1024, memory - 1512, memoryReservation - 1360. | Multiple concurrent harvests of full library collection are currently not supported. Results of the performance tests when running multiple full harvests can be found here. mod oai-pmh provides APIs for monitoring the harvesting process as documented in the READ.ME file. Additional information: OAI-PMH Best Practices | Magda Zacharska Viachaslau Khandramai
| ||||||||||||||||||||||||
MARC Authority, Inventory, SRS, Data import | Default MARC-Instance mapping rules were updated to support authority linking | Instructions on how to update default MARC-Instance mapping rules are described here: Update to MARC Bib-to-Instance Default map changes to support Authority control feature Update: 21 April: an update script has been provided. Mandatory change. Must be done after the mod-source-record-manager upgrade | |||||||||||||||||||||||||
| mod-settings | (text to be added here) | ||||||||||||||||||||||||||
| Permissions, Circulation | With the permission "Settings (Circ): Can view loan history", the Save button on the Loan anonymization page is no longer visible (UICIRC-767). In addition, a new permission has been created, "Settings (Circ): Can edit loan history", for which the Save button on the Loan anonymization page is visible and can be selected (UICIRC-766). | Please note: The permission names contain the old name of the setting (Loan history), but refer to the circulation setting Loan anonymization. | Update your users' permissions and/or permission sets, as required. | N/A | Edit: UICIRC-766 | ||||||||||||||||||||||
| Search | Inventory search supports now contributors browse. Changes to the Authority search were implemented. | mod-search indices will need to recreate for both instance and authority as described here | During the upgrade process | ||||||||||||||||||||||||
| Settings, Circulation, Loan history | The circulation setting "Loan history" as been updated to "Loan anonymization" | Please note: The permission names have not been updated, and still refer to "Loan history" | N/A | N/A | |||||||||||||||||||||||
| Z39.50 | (text to be added here) | ||||||||||||||||||||||||||
| Inventory single record import/quickMarc derive | DB Read/Write split should be disabled for mod-source-record-manager | In case Read instance is not synchronising fast enough, some single record operations could fail | When mod-source-record-manager is deployed do not pass the environment variables for DB_HOST_READER and DB_PORT_READER (it won't be enabled by default) |
| |||||||||||||||||||||||
| mod-search | Additional cluster-level permissions are required in Opensearch in order to successfully initialize the module for a tenant. | Tenant initialization may fail unless the Opensearch role used by mod-search includes the additional permissions. | Before initializing mod-search 2.0.x for a tenant, add the following cluster-level permissions to the Opensearch role used by mod-search: cluster:admin/script/get | This change may also impact Elasticsearch as well. However, it remains unverified. |
...