Release Notes This page documents the manual steps required to upgrade an existing eMuseum installation.
Previous Version Changes
Before applying changes specific to eMuseum 6. found in the sections below, all changes required to upgrade earlier versions of 6.0, 6.1, 6.2 and 6.3 must be applied. Those changes can be found in the corresponding release notes.
6.4
System Requirements
In addition to Java 11, Java 17 is now supported
In addition to Solr 8, Solr 9 is now supported
Database Changes
Database changes are now handled by the application at startup. No manual steps are required.
Solr Changes
If the data folder within the eMuseum home directory is used (<EMUSEUM_HOME>/solr/), adjust the Solr configuration to point to <EMUSEUM_HOME>/solr/solr8 for Solr 8 or to <EMUSEUM_HOME>/solr/solr8 for Solr 9.
If a separate Solr data folder is used (instead of <EMUSEUM_HOME>/solr/), copy over the files from <EMUSEUM_HOME>/solr/solr8 for Solr8 or from <EMUSEUM_HOME>/solr/solr9 for Solr 9.
Template Changes
Template updates are only required for custom skins.
For each custom skin (sub-folders in the <EMUSEUM_HOME>/skins/ folder), apply the following changes. Please note that custom skins only contain files for custom changes. If a mentioned file does not exist in the custom skin’s folder, no changes need to be done.
Merge changes on the following template files (if present):
com/gallerysystems/emuseum/core/base/components/AbstractReportsController.tml
com/gallerysystems/emuseum/core/base/components/AbstractViewFieldConfig.tml
com/gallerysystems/emuseum/core/base/pages/AbstractModuleConfigurationPage.tml
com/gallerysystems/emuseum/core/base/view/page/AbstractViewPage.tml
com/gallerysystems/emuseum/core/components/AdvancedSearchLink.tml
com/gallerysystems/emuseum/core/components/AsImagesGrid.tml
com/gallerysystems/emuseum/core/components/AsListGrid.tml
com/gallerysystems/emuseum/core/components/AsTableGrid.tml
com/gallerysystems/emuseum/core/components/DetailActions.tml
com/gallerysystems/emuseum/core/components/DetailsBlock.tml
com/gallerysystems/emuseum/core/components/GroupChooser.tml
com/gallerysystems/emuseum/core/components/IIIFLink.tml
com/gallerysystems/emuseum/core/components/Layout.tml
com/gallerysystems/emuseum/core/components/ThesaurusTerms.tml
com/gallerysystems/emuseum/core/components/ThesaurusTermsPath.tml
com/gallerysystems/emuseum/core/components/admin/EnvironmentWidget.tml
com/gallerysystems/emuseum/core/components/admin/MemoryWidget.tml
com/gallerysystems/emuseum/core/components/configuration/ConfigLayout.tml
com/gallerysystems/emuseum/core/components/configuration/HistoryCleanupForm.tml
com/gallerysystems/emuseum/core/components/media/Media.tml
com/gallerysystems/emuseum/core/components/media/MediaDownload.tml
com/gallerysystems/emuseum/core/components/media/viewers/AudioViewer.tml
com/gallerysystems/emuseum/core/components/media/viewers/DocumentViewer.tml
com/gallerysystems/emuseum/core/components/media/viewers/ImageViewer.tml
com/gallerysystems/emuseum/core/components/media/viewers/VideoViewer.tml
com/gallerysystems/emuseum/core/components/pageviews/bibliography/Detail.tml
com/gallerysystems/emuseum/core/components/pageviews/bibliography/Images.tml
com/gallerysystems/emuseum/core/components/pageviews/bibliography/List.tml
com/gallerysystems/emuseum/core/components/pageviews/bibliography/Table.tml
com/gallerysystems/emuseum/core/components/pageviews/events/Detail.tml
com/gallerysystems/emuseum/core/components/pageviews/events/Images.tml
com/gallerysystems/emuseum/core/components/pageviews/events/List.tml
com/gallerysystems/emuseum/core/components/pageviews/events/Table.tml
com/gallerysystems/emuseum/core/components/pageviews/exhibitions/Detail.tml
com/gallerysystems/emuseum/core/components/pageviews/exhibitions/Images.tml
com/gallerysystems/emuseum/core/components/pageviews/exhibitions/List.tml
com/gallerysystems/emuseum/core/components/pageviews/exhibitions/Table.tml
com/gallerysystems/emuseum/core/components/pageviews/loans/Detail.tml
com/gallerysystems/emuseum/core/components/pageviews/loans/Images.tml
com/gallerysystems/emuseum/core/components/pageviews/loans/List.tml
com/gallerysystems/emuseum/core/components/pageviews/loans/Table.tml
com/gallerysystems/emuseum/core/components/pageviews/media/Detail.tml
com/gallerysystems/emuseum/core/components/pageviews/media/Images.tml
com/gallerysystems/emuseum/core/components/pageviews/media/List.tml
com/gallerysystems/emuseum/core/components/pageviews/media/Table.tml
com/gallerysystems/emuseum/core/components/pageviews/objects/Detail.tml
com/gallerysystems/emuseum/core/components/pageviews/objects/Images.tml
com/gallerysystems/emuseum/core/components/pageviews/objects/List.tml
com/gallerysystems/emuseum/core/components/pageviews/objects/Table.tml
com/gallerysystems/emuseum/core/components/pageviews/people/Detail.tml
com/gallerysystems/emuseum/core/components/pageviews/people/Images.tml
com/gallerysystems/emuseum/core/components/pageviews/people/List.tml
com/gallerysystems/emuseum/core/components/pageviews/people/Table.tml
com/gallerysystems/emuseum/core/components/pageviews/sites/Detail.tml
com/gallerysystems/emuseum/core/components/pageviews/sites/Images.tml
com/gallerysystems/emuseum/core/components/pageviews/sites/List.tml
com/gallerysystems/emuseum/core/components/pageviews/sites/Table.tml
com/gallerysystems/emuseum/core/components/profile/AddCustomFieldConfigModal.tml
com/gallerysystems/emuseum/core/components/profile/AddFieldConfigModal.tml
com/gallerysystems/emuseum/core/components/profile/CustomFields.tml
com/gallerysystems/emuseum/core/components/profile/DefaultFields.tml
com/gallerysystems/emuseum/core/components/profile/QuickSearchFieldConfig.tml
com/gallerysystems/emuseum/core/components/profile/SimilarFieldConfig.tml
com/gallerysystems/emuseum/core/components/profile/ViewConfigFieldConfig.tml
com/gallerysystems/emuseum/core/components/related/RecordBibliography.tml
com/gallerysystems/emuseum/core/components/related/RecordEvents.tml
com/gallerysystems/emuseum/core/components/related/RecordExhibitions.tml
com/gallerysystems/emuseum/core/components/related/RecordLoans.tml
com/gallerysystems/emuseum/core/components/related/RecordObjects.tml
com/gallerysystems/emuseum/core/components/related/RecordSites.tml
com/gallerysystems/emuseum/core/components/search/AdvancedSearchForm.tml
com/gallerysystems/emuseum/core/components/search/QuickSearchForm.tml
com/gallerysystems/emuseum/core/pages/admin/indexing/AdminIndexingIndex.tml
com/gallerysystems/emuseum/core/pages/admin/indexing/AdminIndexingVocabularies.tml
com/gallerysystems/emuseum/core/pages/admin/nodes/NodesIndex.tml
com/gallerysystems/emuseum/core/pages/advancedsearch/AdvancedsearchIndex.tml
com/gallerysystems/emuseum/core/pages/advancedsearch/AdvancedsearchResults.tml
com/gallerysystems/emuseum/core/pages/collections/CollectionsDetails.tml
com/gallerysystems/emuseum/core/pages/collections/CollectionsIndex.tml
com/gallerysystems/emuseum/core/pages/configuration/ConfigurationApplication.tml
com/gallerysystems/emuseum/core/pages/configuration/ConfigurationField.tml
com/gallerysystems/emuseum/core/pages/configuration/ConfigurationLiterals.tml
com/gallerysystems/emuseum/core/pages/configuration/ConfigurationLogo.tml
com/gallerysystems/emuseum/core/pages/configuration/ConfigurationMedia.tml
com/gallerysystems/emuseum/core/pages/configuration/ConfigurationMetadata.tml
com/gallerysystems/emuseum/core/pages/configuration/groups/ConfigurationGroupsCreate.tml
com/gallerysystems/emuseum/core/pages/configuration/groups/ConfigurationGroupsEdit.tml
com/gallerysystems/emuseum/core/pages/configuration/modules/ModulesIndex.tml
com/gallerysystems/emuseum/core/pages/configuration/reports/ReportsReport.tml
com/gallerysystems/emuseum/core/pages/favorites/FavoritesIndex.tml
com/gallerysystems/emuseum/core/pages/favorites/FavoritesPublic.tml
com/gallerysystems/emuseum/core/pages/groups/GroupsCategory.tml
com/gallerysystems/emuseum/core/pages/groups/GroupsDetails.tml
com/gallerysystems/emuseum/core/pages/groups/GroupsIndex.tml
com/gallerysystems/emuseum/core/pages/internal/ThesTree.tml
com/gallerysystems/emuseum/core/pages/search/SearchResults.tml
com/gallerysystems/emuseum/core/pages/vocabularies/Thesaurus.tml
6.4.2
Solr Changes
If a separate Solr data folder is used (instead of <EMUSEUM_HOME>/solr/solr8) for Solr 8, copy over the following files:
<EMUSEUM_HOME>/solr/solr8/records/conf/solrconfig.xml
<EMUSEUM_HOME>/solr/solr8/vocabularies/conf/solrconfig.xml
6.4.3
Solr Changes
If a separate Solr data folder is used (instead of <EMUSEUM_HOME>/solr/solrX), copy over the following files (adjust X to your Solr version):
<EMUSEUM_HOME>/solr/solrX/records/conf/solrconfig.xml
<EMUSEUM_HOME>/solr/solrX/vocabularies/conf/solrconfig.xml
Template Changes
Template updates are only required for custom skins.
For each custom skin (sub-folders in the <EMUSEUM_HOME>/skins/ folder), merge changes on the following template files (if present):
com/gallerysystems/emuseum/core/components/admin/MemoryWidget.tml
com/gallerysystems/emuseum/core/components/pageviews/objects/Detail.tml
com/gallerysystems/emuseum/core/components/profile/AddCustomFieldConfigModal.tml
com/gallerysystems/emuseum/core/components/profile/SimilarFieldConfig.tml
com/gallerysystems/emuseum/core/pages/admin/nodes/NodesIndex.tml
6.4.5
Template Changes
Template updates are only required for custom skins.
For each custom skin (sub-folders in the <EMUSEUM_HOME>/skins/ folder), merge changes on the following template files (if present):
com/gallerysystems/emuseum/core/components/DetailActions.tml
com/gallerysystems/emuseum/core/components/IIIFLink.tml
com/gallerysystems/emuseum/core/components/Layout.tml
com/gallerysystems/emuseum/core/components/favorites/FavoritesBar.tml
6.4.6
Template Changes
Template updates are only required for custom skins.
For each custom skin (sub-folders in the <EMUSEUM_HOME>/skins/ folder), merge changes on the following template files (if present):
com/gallerysystems/emuseum/core/pages/advancedsearch/AdvancedsearchResults.tml
com/gallerysystems/emuseum/core/pages/search/SearchResults.tml
6.4.7
Solr Changes
If a separate Solr data folder is used (instead of <EMUSEUM_HOME>/solr/solr8) for Solr 8, copy over the following files:
<EMUSEUM_HOME>/solr/solr8/records/conf/solrconfig.xml
<EMUSEUM_HOME>/solr/solr8/vocabularies/conf/solrconfig.xml
6.4.9
Template Changes
Template updates are only required for custom skins.
For each custom skin (sub-folders in the <EMUSEUM_HOME>/skins/ folder), merge changes on the following template files (if present):
com/gallerysystems/emuseum/core/base/view/page/AbstractViewPage.tml
com/gallerysystems/emuseum/core/components/pageviews/events/Detail.tml
com/gallerysystems/emuseum/core/components/pageviews/media/Detail.tml
com/gallerysystems/emuseum/core/components/profile/QuickSearchFieldConfig.tml
com/gallerysystems/emuseum/core/pages/advancedsearch/AdvancedsearchResults.tml
com/gallerysystems/emuseum/core/pages/search/SearchResults.tml
com/gallerysystems/emuseum/core/pages/users/UsersIndex.tml
6.4.10
Solr Changes
If a separate Solr data folder is used (instead of <EMUSEUM_HOME>/solr/solrX), copy over the following files (adjust X to your Solr version):
<EMUSEUM_HOME>/solr/solrX/records/conf/schema.xml
<EMUSEUM_HOME>/solr/solrX/records/conf/solrconfig.xml
<EMUSEUM_HOME>/solr/solrX/vocabularies/conf/schema.xml
<EMUSEUM_HOME>/solr/solrX/vocabularies/conf/solrconfig.xml
Profile Changes
If a custom Profile for the People module exists (file <EMUSEUM_HOME>/profiles/people.xml), locate the field “letter” and change its attribute “type” to “keyword”:
<field id="letter" type="keyword">
Run a full indexing after the changes above.
Template Changes
Template updates are only required for custom skins.
For each custom skin (sub-folders in the <EMUSEUM_HOME>/skins/ folder), merge changes on the following template files (if present):
com/gallerysystems/emuseum/core/components/pageviews/people/Detail.tml
6.4.11
Solr Changes
If a separate Solr data folder is used (instead of <EMUSEUM_HOME>/solr/solrX), copy over the following files (adjust X to your Solr version):
<EMUSEUM_HOME>/solr/solrX/records/conf/schema.xml
<EMUSEUM_HOME>/solr/solrX/records/conf/solrconfig.xml
<EMUSEUM_HOME>/solr/solrX/vocabularies/conf/schema.xml
<EMUSEUM_HOME>/solr/solrX/vocabularies/conf/solrconfig.xml
Template Changes
Template updates are only required for custom skins.
For each custom skin (sub-folders in the <EMUSEUM_HOME>/skins/ folder), merge changes on the following template files (if present):
com/gallerysystems/emuseum/core/components/media/viewers/DocumentViewer.tml
6.4.13
Profile Changes
Navigate to Configuration → Data and Search Settings → Field Configuration, select the Objects module, open Search → Quick Search, click on the cog wheel of the “invno” field and uncheck the Search Suggestions option “tokenized”.
Run a full indexing after making these changes.
Template Changes
Template updates are only required for custom skins.
For each custom skin (sub-folders in the <EMUSEUM_HOME>/skins/ folder), merge changes on the following template files (if present):
com/gallerysystems/emuseum/core/components/DetailsBlock.tml
6.4.14
Solr Changes
If a separate Solr data folder is used (instead of <EMUSEUM_HOME>/solr/solr9) for Solr 9, copy over the following files:
<EMUSEUM_HOME>/solr/solr9/records/conf/schema.xml
Profile Changes
If a custom Profile for the People module exists (file <EMUSEUM_HOME>/profiles/people.xml), change the label of the field “alphaSort” to “Alpha Sort”.