Orchid (R1 2023) Release Notes
- 1 Notes on functionality
- 2 Important Upgrade Considerations
- 3 Post-Release Hotfixes and Patches
- 3.1 Critical Service Patch #1- released at June 8
- 3.1.1 Approval Log
- 3.1.2 Tickets list
- 3.1.3 Modules list
- 3.1.4 Release tag
- 3.2 Critical Service Patch #2- released at 26 June
- 3.2.1 Approval Log
- 3.2.2 Tickets list
- 3.2.3 Modules list
- 3.2.4 Release tag
- 3.3 Critical Service Patch #3- released at 18 July
- 3.3.1 Approval Log
- 3.3.2 Tickets list
- 3.3.3 Modules list
- 3.3.4 Release tag
- 3.4 Critical Service Patch #4- Released at August 1
- 3.4.1 Approval Log
- 3.4.2 Tickets list
- 3.4.3 Modules list
- 3.4.4 Release tag
- 3.5 Critical Service Patch #5- released at August 17
- 3.5.1 Approval Log
- 3.5.2 Tickets list
- 3.5.3 Modules list
- 3.5.4 Release tag
- 3.6 Critical Service Patch #6- To be released at September 29
- 3.6.1 Approval Log
- 3.6.2 Tickets list
- 3.6.3 Modules list
- 3.6.4 Release tag
- 3.7 Critical Service Patch #7- released at December 1
- 3.7.1 Approval Log
- 3.7.2 Tickets list
- 3.7.3 Modules list
- 3.7.4 Release tag
- 3.1 Critical Service Patch #1- released at June 8
- 4 New Features
- 5 New Features by Epic (Sub-Project)
- 6 Closed Bugs
- 7 All Closed Bugs and Stories
- 8 Remaining Open Bugs at Time of Release
- 9 Support Period
Notes on functionality
PO Release Presentations
Presentation | Presentation date | Presenter | SIG meeting (link) | Notes |
|---|---|---|---|---|
| @Owen Stephens |
| These are the slides and screencasts for the release digest | |
3/23/2023 | @Khalilah Gambrell | (starting at 20:16 in the meeting recording) | ||
3/30/23 | @Charlotte Whitt | (starting at 7:50 in the meeting recording) | ||
4/6/2023 | @Magda Zacharska | (starting at 12:30 in the meeting recording) | ||
4/13/2023 | @Ann-Marie Breaux (Deactivated) | (starting at 28:30 in the meeting recording) | ||
2/21/2023 | @Dennis Bridges |
| This link to video that seems to review this on 18-Apr-2023 |
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 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. | ||
Okapi | Old Okapi versions fail with " |
| Before installing/upgrading any modules upgrade Okapi to the latest 5.0.x version. |
| @Julian Ladisch | ||
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:
|
| @Julian Ladisch | ||
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. |
| 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 | This work was completed after the PO, Holly Mistlebauer, retired. | @Stephanie Buck | ||
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 | CIRCSTORE-353 | ||
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.
|
| @Kateryna Senchenko @Ann-Marie Breaux (Deactivated) | ||
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.
|
| @Kateryna Senchenko @Ann-Marie Breaux (Deactivated) | ||
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: {
"migrations": [
"subjectSeriesMigration"
],
"affectedEntities": [
"INSTANCE"
]
}
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. |
| @Pavlo Smahin | ||
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. | @Ann-Marie Breaux (Deactivated)
| ||
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 |
| @Ann-Marie Breaux (Deactivated) | ||
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). |
| @Ann-Marie Breaux (Deactivated) | ||
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 (Deactivated) | ||
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 |
| @Pavlo Smahin | ||
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). | 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 @julie.bickle | ||
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 |
| @Pavlo Smahin | ||
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 | @Holly Mistlebauer / @Stephanie Buck | ||
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) |
| @Kateryna Senchenko
| ||
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. | @Pavlo Smahin @John Malconian | ||
quickMARC | mod-entities-links module must be manually restarted for quickMARC to function. |
| Each Orchid version upgrade |
| @Khalilah Gambrell @Pavlo Smahin | ||
MARC (quickMARC/ data import) | To support authority linking, subfield 9 is not allowed on linkable bib fields (100/110/111/130/600/610/611/630/700/710/711/730/800/810/811/830) | Any libraries that have subfield 9 on these fields will need to change to another subfield. Recommendation: subfield 0. |
|
|
| ||
SRM, Data Import |
| Default limit for retrieving settings for mapping during DI is set to 1000. | If library contains more data in the specified settings override the property srm.mapping.parameters.settings.limit (default=1000) when mod-source-record-manager is deployed. |
| @Kateryna Senchenko | ||
SRS, Data import (marc record matching) |
|
| The scripts to populate marc_indexers version should be run after upgrading mod-source-record-storage to v5.6.11. |
| @Kateryna Senchenko https://folio-org.atlassian.net/browse/MODSOURCE-655 | ||
Data Import (order creation) | Orchid CSP 5 release to fix the retrieval of more than 20,000 organizations for 1) the total count in the Organizations app, and 2) the lookup of organizations by Data Import when creating orders. Tested with 80,000+ organizations in Orchid BF. This resolves a problem where orders were being created via Data Import, but with no designated Vendor. |
| No additional action required by libraries. |
| @Ann-Marie Breaux (Deactivated) @Dennis Bridges | ||
mod-agreements | The migration adds a foreign key for content_type.ct_content_type_fk referencing refdata_value.rdv_id. If rdv_id record has been deleted migration will fail with
|
|