doc/src/docbook/appendix/update_warnings.xml

Code
Comments
Other
Rev Date Author Line
4638 17 Nov 08 nicklas 1 <?xml version="1.0" encoding="UTF-8"?>
4638 17 Nov 08 nicklas 2 <!DOCTYPE appendix PUBLIC 
4638 17 Nov 08 nicklas 3     "-//Dawid Weiss//DTD DocBook V3.1-Based Extension for XML and graphics inclusion//EN" 
4638 17 Nov 08 nicklas 4     "../../../../lib/docbook/preprocess/dweiss-docbook-extensions.dtd">
4638 17 Nov 08 nicklas 5 <!--
4638 17 Nov 08 nicklas 6   $Id$
4638 17 Nov 08 nicklas 7   
4638 17 Nov 08 nicklas 8   Copyright (C) 2007 Peter Johansson, Nicklas Nordborg
4638 17 Nov 08 nicklas 9   
4638 17 Nov 08 nicklas 10   This file is part of BASE - BioArray Software Environment.
4638 17 Nov 08 nicklas 11   Available at http://base.thep.lu.se/
4638 17 Nov 08 nicklas 12   
4638 17 Nov 08 nicklas 13   BASE is free software; you can redistribute it and/or
4638 17 Nov 08 nicklas 14   modify it under the terms of the GNU General Public License
4638 17 Nov 08 nicklas 15   as published by the Free Software Foundation; either version 3
4638 17 Nov 08 nicklas 16   of the License, or (at your option) any later version.
4638 17 Nov 08 nicklas 17   
4638 17 Nov 08 nicklas 18   BASE is distributed in the hope that it will be useful,
4638 17 Nov 08 nicklas 19   but WITHOUT ANY WARRANTY; without even the implied warranty of
4638 17 Nov 08 nicklas 20   MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
4638 17 Nov 08 nicklas 21   GNU General Public License for more details.
4638 17 Nov 08 nicklas 22   
4638 17 Nov 08 nicklas 23   You should have received a copy of the GNU General Public License
4638 17 Nov 08 nicklas 24   along with BASE. If not, see <http://www.gnu.org/licenses/>.
4638 17 Nov 08 nicklas 25 -->
4638 17 Nov 08 nicklas 26
4638 17 Nov 08 nicklas 27 <appendix id="appendix.update_warnings">
5782 04 Oct 11 nicklas 28   <?dbhtml filename="updatewarnings.html" ?>
4638 17 Nov 08 nicklas 29   <title>Things to consider when updating an existing BASE installation</title>
4638 17 Nov 08 nicklas 30   <para>
5677 29 Jun 11 nicklas 31     This document is a list of things that may have to be considered 
4638 17 Nov 08 nicklas 32     when updating a BASE installation to a newer version. The <xref 
5738 15 Sep 11 nicklas 33     linkend="installation.upgrade" /> section only include the most 
4638 17 Nov 08 nicklas 34     recent information that is needed for updating the previous BASE version
4638 17 Nov 08 nicklas 35     to the current version.
4638 17 Nov 08 nicklas 36   </para>
7826 09 Jun 20 nicklas 37
7997 09 Aug 21 nicklas 38
7997 09 Aug 21 nicklas 39   <sect1 id="appendix.update_warnings.3.19">
7997 09 Aug 21 nicklas 40     <title>BASE 3.19</title>
7997 09 Aug 21 nicklas 41     
7997 09 Aug 21 nicklas 42     <bridgehead>Support for MySQL has ended</bridgehead>
7997 09 Aug 21 nicklas 43     <para>
7997 09 Aug 21 nicklas 44       BASE 3.18 was the last release that supported MySQL. Since  
7997 09 Aug 21 nicklas 45       BASE 3.19 we are only testing and supporting PostgreSQL. BASE may still
7997 09 Aug 21 nicklas 46       work with MySQL after that, but we recommend that existing installations 
7997 09 Aug 21 nicklas 47       are migrated to PostgreSQL as soon as possible.
7997 09 Aug 21 nicklas 48     </para>
7997 09 Aug 21 nicklas 49   </sect1>
7997 09 Aug 21 nicklas 50
7997 09 Aug 21 nicklas 51
7916 24 Feb 21 nicklas 52   <sect1 id="appendix.update_warnings.3.18">
7916 24 Feb 21 nicklas 53     <title>BASE 3.18</title>
7916 24 Feb 21 nicklas 54
7916 24 Feb 21 nicklas 55     <bridgehead>Support for MySQL is ending in BASE 3.19</bridgehead>
7916 24 Feb 21 nicklas 56     <para>
7916 24 Feb 21 nicklas 57       This is the last release of BASE that is tested with MySQL 8.0.
7916 24 Feb 21 nicklas 58       Starting with BASE 3.19 we will only test with and support PostgreSQL.
7916 24 Feb 21 nicklas 59       BASE may still work with MySQL after that, but we recommend that 
7916 24 Feb 21 nicklas 60       existing installations are migrated to PostgreSQL as soon as possible.
7916 24 Feb 21 nicklas 61     </para>
7916 24 Feb 21 nicklas 62   
7916 24 Feb 21 nicklas 63   </sect1>
7916 24 Feb 21 nicklas 64
7916 24 Feb 21 nicklas 65
7826 09 Jun 20 nicklas 66   <sect1 id="appendix.update_warnings.3.17">
7826 09 Jun 20 nicklas 67     <title>BASE 3.17</title>
4638 17 Nov 08 nicklas 68   
7826 09 Jun 20 nicklas 69     <bridgehead>MySQL versions before 8.0 are no longer supported</bridgehead>
7826 09 Jun 20 nicklas 70     <para>
7826 09 Jun 20 nicklas 71       Starting with this release, we no longer test BASE with MySQL versions
7826 09 Jun 20 nicklas 72       before 8.0. We are recommending existing installations are upgraded to
7826 09 Jun 20 nicklas 73       use MySQL 8 or migrated to PostgreSQL.
7826 09 Jun 20 nicklas 74     </para>
7826 09 Jun 20 nicklas 75     
7826 09 Jun 20 nicklas 76   </sect1>
7826 09 Jun 20 nicklas 77
7826 09 Jun 20 nicklas 78   
7719 22 May 19 nicklas 79   <sect1 id="appendix.update_warnings.3.16">
7719 22 May 19 nicklas 80     <title>BASE 3.16</title>
7719 22 May 19 nicklas 81   
7719 22 May 19 nicklas 82     <bridgehead>Java 11 or later is now required (OpenJDK)</bridgehead>
7719 22 May 19 nicklas 83     <para>
7719 22 May 19 nicklas 84       Starting with this release, Java 11 is required for running BASE. 
7719 22 May 19 nicklas 85       BASE 3.15 was the last BASE version with support for Java 8. 
7719 22 May 19 nicklas 86       Note that Oracle no longer provide a free JDK or JRE.
7719 22 May 19 nicklas 87       Instead, OpenJDK has to be used, which can be downloaded from 
7719 22 May 19 nicklas 88       <ulink url="https://openjdk.java.net/" />
7719 22 May 19 nicklas 89     </para>
7731 17 Jun 19 nicklas 90     
7731 17 Jun 19 nicklas 91     <bridgehead>Tomcat 8 and PostgreSQL 9 are no longer supported</bridgehead>
7731 17 Jun 19 nicklas 92     <para>
7731 17 Jun 19 nicklas 93       Starting with this release, we no longer test BASE with Tomcat 8
7731 17 Jun 19 nicklas 94       or PostgreSQL 9. Thus, we are recommening that existing installations
7731 17 Jun 19 nicklas 95       are upgraded to at least Tomcat 9 and PostgreSQL 11.
7731 17 Jun 19 nicklas 96     </para>
7731 17 Jun 19 nicklas 97     
7719 22 May 19 nicklas 98   </sect1>
7719 22 May 19 nicklas 99   
7598 22 Feb 19 nicklas 100   <sect1 id="appendix.update_warnings.3.15">
7598 22 Feb 19 nicklas 101     <title>BASE 3.15</title>
7598 22 Feb 19 nicklas 102   
7631 11 Mar 19 nicklas 103     <bridgehead>Consider upgrading to Java 11 (OpenJDK)</bridgehead>
7631 11 Mar 19 nicklas 104     <para>
7631 11 Mar 19 nicklas 105       The next BASE release, BASE 3.16, will only support Java 11 or later. BASE 3.15 is 
7631 11 Mar 19 nicklas 106       the last BASE version that supports Java 8. Our recommendation is to upgrade to
7631 11 Mar 19 nicklas 107       Java 11 as soon as possible. Note that Oracle no longer provide a free JDK or JRE.
7631 11 Mar 19 nicklas 108       Instead, OpenJDK has to be used, which can be downloaded from 
7631 11 Mar 19 nicklas 109       <ulink url="https://openjdk.java.net/" />
7631 11 Mar 19 nicklas 110     </para>
7631 11 Mar 19 nicklas 111     
7631 11 Mar 19 nicklas 112     <para>
7631 11 Mar 19 nicklas 113       If you experience any problems with BASE 3.15 and Java 8
7631 11 Mar 19 nicklas 114       you could try removing the listed files from the <filename>www/WEB-INF/lib</filename>
7631 11 Mar 19 nicklas 115       directory and then restart Tomcat.
7631 11 Mar 19 nicklas 116     </para>
7631 11 Mar 19 nicklas 117     
7631 11 Mar 19 nicklas 118     <itemizedlist>
7631 11 Mar 19 nicklas 119       <listitem><filename>java.activation-api-1.2.0.jar</filename></listitem>
7631 11 Mar 19 nicklas 120       <listitem><filename>jaxb-api-2.3.1.jar</filename></listitem>
7631 11 Mar 19 nicklas 121       <listitem><filename>jaxb-core-2.3.0.1.jar</filename></listitem>
7631 11 Mar 19 nicklas 122       <listitem><filename>jaxb-impl-2.3.1.jar</filename></listitem>
7631 11 Mar 19 nicklas 123     </itemizedlist>
7631 11 Mar 19 nicklas 124   
7614 01 Mar 19 nicklas 125     <bridgehead>Consider upgrading to Tomcat 9 and PostgreSQL 11</bridgehead>
7613 01 Mar 19 nicklas 126     <para>
7614 01 Mar 19 nicklas 127       We have started to test BASE with Tomcat 9 and PostgreSQL 11 and we have 
7614 01 Mar 19 nicklas 128       not found any problems  so far. For new installations we recommend that Tomcat 9 
7614 01 Mar 19 nicklas 129       and PostgreSQL 11 is used. Official support for Tomcat 8 and PostgreSQL 9 will be 
7614 01 Mar 19 nicklas 130       dropped in a future BASE version. For existing installations our recommendation
7614 01 Mar 19 nicklas 131       is to start planning for an upgrade to Tomcat 9 and PostgreSQL 11.
7613 01 Mar 19 nicklas 132     </para>
7613 01 Mar 19 nicklas 133   
7598 22 Feb 19 nicklas 134     <bridgehead>Secondary storage support has been removed</bridgehead>
7598 22 Feb 19 nicklas 135     <para>
7598 22 Feb 19 nicklas 136       The <guilabel>Secondary storage</guilabel> feature has been removed. 
7598 22 Feb 19 nicklas 137       Files that are located in the secondary storage will be marked as offline
7598 22 Feb 19 nicklas 138       by the upgrade script. The recommendation is to replace this feature with 
7598 22 Feb 19 nicklas 139       an external files solution instead.
7598 22 Feb 19 nicklas 140     </para>
7640 11 Mar 19 nicklas 141     
7640 11 Mar 19 nicklas 142     <bridgehead>Spot images support has been removed</bridgehead>
7640 11 Mar 19 nicklas 143     <para>
7640 11 Mar 19 nicklas 144       It is no longer possible to create new spot images or view existing
7640 11 Mar 19 nicklas 145       spot images via the BASE web client. Existing source image files and
7640 11 Mar 19 nicklas 146       zip archives with generated spot images have not been removed.
7640 11 Mar 19 nicklas 147     </para>
7598 22 Feb 19 nicklas 148   
7631 11 Mar 19 nicklas 149     <bridgehead>Customizations made in Tomcat's global web.xml file</bridgehead>
7609 27 Feb 19 nicklas 150     <para>
7609 27 Feb 19 nicklas 151       In the configuration directory for Tomcat there is a <filename>web.xml</filename>
7609 27 Feb 19 nicklas 152       file that define global options for all web applications. The settings in this file
7609 27 Feb 19 nicklas 153       can be overridden per web application in the <filename>WEB-INF/classes/web.xml</filename>.
7609 27 Feb 19 nicklas 154       BASE 3.15 re-defines the <code>jsp</code> <sgmltag class="starttag">servlet</sgmltag>
7609 27 Feb 19 nicklas 155       definition to make sure that JSP files are compiled with proper settings. Changes that
7609 27 Feb 19 nicklas 156       have been made to the global <filename>web.xml</filename> file for the <code>jsp</code>
7609 27 Feb 19 nicklas 157       <sgmltag class="starttag">servlet</sgmltag> must be moved or copied to the 
7609 27 Feb 19 nicklas 158       <filename>web.xml</filename> file for the BASE web application.
7609 27 Feb 19 nicklas 159     </para>
7598 22 Feb 19 nicklas 160   
7598 22 Feb 19 nicklas 161   </sect1>
7598 22 Feb 19 nicklas 162   
7520 05 Nov 18 nicklas 163   <sect1 id="appendix.update_warnings.3.14">
7520 05 Nov 18 nicklas 164     <title>BASE 3.14</title>
7520 05 Nov 18 nicklas 165   
7521 06 Nov 18 nicklas 166     <bridgehead>The db.driver setting is no longer used</bridgehead>
7520 05 Nov 18 nicklas 167     <para>
7521 06 Nov 18 nicklas 168       The JDBC driver to use is now found automatically based on
7521 06 Nov 18 nicklas 169       the <constant>db.url</constant> setting in the <filename>base.config</filename>
7521 06 Nov 18 nicklas 170       file. The <constant>db.driver</constant> setting can be removed.
7520 05 Nov 18 nicklas 171     </para>
7520 05 Nov 18 nicklas 172     
7545 07 Dec 18 nicklas 173     <bridgehead>The (very) old Authenticator API has been removed</bridgehead>
7545 07 Dec 18 nicklas 174     <para>
7545 07 Dec 18 nicklas 175       The <code>net.sf.basedb.core.authentication.Authenticator</code>
7545 07 Dec 18 nicklas 176       interface and other related code that was deprecated in BASE 3.3
7545 07 Dec 18 nicklas 177       has been removed. Systems that still use old authentication code 
7545 07 Dec 18 nicklas 178       need to replace this with a newer version before updating.
7545 07 Dec 18 nicklas 179     </para>
7545 07 Dec 18 nicklas 180
7545 07 Dec 18 nicklas 181     <bridgehead>Changes to the authentication system</bridgehead>
7545 07 Dec 18 nicklas 182     <para>
7545 07 Dec 18 nicklas 183       The authentication system has been updated to make it easier to
7545 07 Dec 18 nicklas 184       install more than one external authentication manager. The changes
7545 07 Dec 18 nicklas 185       are backwards compatible and existing authentication managers should
7545 07 Dec 18 nicklas 186       still work as before as long as they are the only ones installed.
7545 07 Dec 18 nicklas 187       However, the existing authentication managers will probably not work
7545 07 Dec 18 nicklas 188       well if more than one is installed since they lack some features that
7545 07 Dec 18 nicklas 189       are neccessary in order to cooperate with other managers. Before installing
7545 07 Dec 18 nicklas 190       more than one authentication manager it is recommended that they are
7545 07 Dec 18 nicklas 191       updated to newer versions.
7545 07 Dec 18 nicklas 192     </para>
7545 07 Dec 18 nicklas 193     
7545 07 Dec 18 nicklas 194     <para>
7545 07 Dec 18 nicklas 195       Newer authentication managers typically no longer provide support for
7545 07 Dec 18 nicklas 196       password authentication. If the intention is that some users still should be 
7545 07 Dec 18 nicklas 197       able to login with username+password, it is recommended that the 
7545 07 Dec 18 nicklas 198       <guilabel>Password login form</guilabel> is enabled. Go to
7545 07 Dec 18 nicklas 199       <menuchoice>
7545 07 Dec 18 nicklas 200         <guimenu>Administrate</guimenu>
7545 07 Dec 18 nicklas 201         <guisubmenu>Plug-ins &amp; extensions</guisubmenu>
7545 07 Dec 18 nicklas 202         <guimenuitem>Overview</guimenuitem>
7545 07 Dec 18 nicklas 203       </menuchoice> and locate the <guilabel>Login form customization</guilabel>
7545 07 Dec 18 nicklas 204       extension point to find it.
7545 07 Dec 18 nicklas 205     </para>
7545 07 Dec 18 nicklas 206     
7520 05 Nov 18 nicklas 207   </sect1>
7520 05 Nov 18 nicklas 208   
7390 07 Jun 17 nicklas 209   <sect1 id="appendix.update_warnings.3.11.1">
7390 07 Jun 17 nicklas 210     <title>BASE 3.11.1</title>
7390 07 Jun 17 nicklas 211   
7390 07 Jun 17 nicklas 212     <bridgehead>Free wells on bioplates</bridgehead>
7390 07 Jun 17 nicklas 213     <para>
7390 07 Jun 17 nicklas 214       A bug that affected the free wells information on bioplates 
7390 07 Jun 17 nicklas 215       has been fixed. Existing bioplates may have incorrect number of
7390 07 Jun 17 nicklas 216       free wells and can be fixed by running a special script.
7390 07 Jun 17 nicklas 217       
7390 07 Jun 17 nicklas 218       After installing the BASE 3.11.1 update, change directory to 
7390 07 Jun 17 nicklas 219       <filename class="directory">&lt;base-dir&gt;/bin/</filename> 
7390 07 Jun 17 nicklas 220       and issue
7390 07 Jun 17 nicklas 221 <programlisting>
7390 07 Jun 17 nicklas 222 ./onetimefix.sh free_wells -u &lt;root login&gt; -p &lt;root pwd&gt;
7390 07 Jun 17 nicklas 223 </programlisting>
7390 07 Jun 17 nicklas 224     </para>
7390 07 Jun 17 nicklas 225     
7390 07 Jun 17 nicklas 226   </sect1>
7390 07 Jun 17 nicklas 227   
7221 04 Nov 16 nicklas 228   <sect1 id="appendix.update_warnings.3.10">
7221 04 Nov 16 nicklas 229     <title>BASE 3.10</title>
7221 04 Nov 16 nicklas 230   
7221 04 Nov 16 nicklas 231     <bridgehead>Changed permissions for annotating items</bridgehead>
7221 04 Nov 16 nicklas 232     <para>
7221 04 Nov 16 nicklas 233       Before BASE 3.10 a user was able to create/change/delete annotations on
7221 04 Nov 16 nicklas 234       an item if the user has <code>WRITE</code> permission on the item and 
7221 04 Nov 16 nicklas 235       <code>READ</code> permission on the  annotation type. 
7221 04 Nov 16 nicklas 236       In BASE 3.10 several changes has been made:
7221 04 Nov 16 nicklas 237     </para>
7221 04 Nov 16 nicklas 238     
7221 04 Nov 16 nicklas 239     <itemizedlist>
7221 04 Nov 16 nicklas 240       <listitem>
7221 04 Nov 16 nicklas 241         <para>
7221 04 Nov 16 nicklas 242           <code>USE</code> permission is required on the annotation type to be able 
7221 04 Nov 16 nicklas 243           to create/change/delete annotations of that type. This may cause user to no
7221 04 Nov 16 nicklas 244           longer be able to annotate certain items, unless their permissions
7221 04 Nov 16 nicklas 245           are upgraded to <code>USE</code>. Users with <code>READ</code> permission 
7221 04 Nov 16 nicklas 246           can only read the annotation values.
7221 04 Nov 16 nicklas 247         </para>
7221 04 Nov 16 nicklas 248       </listitem>
7221 04 Nov 16 nicklas 249       
7221 04 Nov 16 nicklas 250       <listitem>
7221 04 Nov 16 nicklas 251         <para>
7221 04 Nov 16 nicklas 252           A new permission level, <code>ANNOTATE</code>, has been introduced. 
7221 04 Nov 16 nicklas 253           In the permission hierarchy this sits between the <code>READ</code> 
7221 04 Nov 16 nicklas 254           and <code>WRITE</code> permission and can be used to give users 
7221 04 Nov 16 nicklas 255           permissions to manage annotations but not other properties of an item. 
7221 04 Nov 16 nicklas 256           All users with <code>WRITE</code> permission automatically get 
7221 04 Nov 16 nicklas 257           <code>ANNOTATE</code> permission so this change should not affect current
7221 04 Nov 16 nicklas 258           users.
7221 04 Nov 16 nicklas 259         </para>
7221 04 Nov 16 nicklas 260       </listitem>
7221 04 Nov 16 nicklas 261     </itemizedlist>
7221 04 Nov 16 nicklas 262   
7221 04 Nov 16 nicklas 263   </sect1>
7221 04 Nov 16 nicklas 264   
7221 04 Nov 16 nicklas 265   
7161 27 May 16 nicklas 266   <sect1 id="appendix.update_warnings.3.9">
7161 27 May 16 nicklas 267     <title>BASE 3.9</title>
7161 27 May 16 nicklas 268   
7161 27 May 16 nicklas 269     <bridgehead>Incompatible API change Application API</bridgehead>
7161 27 May 16 nicklas 270     <para>
7161 27 May 16 nicklas 271       The <classname docapi="net.sf.basedb.core">Application.getSessionControl()</classname> 
7161 27 May 16 nicklas 272       method for getting access to an existing session has been deprecated. A new
7161 27 May 16 nicklas 273       version has been implemented that require that an <emphasis>external client id</emphasis>
7161 27 May 16 nicklas 274       is specified. Extensions and other client application may stop working unless
7161 27 May 16 nicklas 275       they are updated. See alos <xref linkend="appendix.incompatible.session-control"/>.
7161 27 May 16 nicklas 276     </para>
7161 27 May 16 nicklas 277   
7161 27 May 16 nicklas 278   </sect1>
7161 27 May 16 nicklas 279   
7161 27 May 16 nicklas 280   
7079 16 Feb 16 nicklas 281   <sect1 id="appendix.update_warnings.3.8">
7079 16 Feb 16 nicklas 282     <title>BASE 3.8</title>
7079 16 Feb 16 nicklas 283   
7079 16 Feb 16 nicklas 284     <bridgehead>updateindexes.sh is no longer needed</bridgehead>
7079 16 Feb 16 nicklas 285     <para>
7079 16 Feb 16 nicklas 286       It is no longer needed to run the <filename>updateindexes.sh</filename>
7079 16 Feb 16 nicklas 287       script as part of the upgrade or installation procedure. The funtionality
7079 16 Feb 16 nicklas 288       has been integrated into the regular <filename>updatedb.sh/initdb.sh</filename>
7079 16 Feb 16 nicklas 289       scripts.
7079 16 Feb 16 nicklas 290     </para>
7079 16 Feb 16 nicklas 291     
7079 16 Feb 16 nicklas 292     <bridgehead>Incompatible API change in ServiceSessionControl</bridgehead>
7079 16 Feb 16 nicklas 293     <para>
7079 16 Feb 16 nicklas 294       The <classname docapi="net.sf.basedb.core">ServiceSessionControl</classname> API for 
7079 16 Feb 16 nicklas 295       configuration and building Hibernate <classname>SessionFactory</classname>
7079 16 Feb 16 nicklas 296       instances has been changed due the Hibernate 5 upgrade. This change affects
7079 16 Feb 16 nicklas 297       extensions that use the API for storing their own data inside the BASE database.
7079 16 Feb 16 nicklas 298       Extensions that use this API must be updated or they will not work with BASE 3.8.
7079 16 Feb 16 nicklas 299     </para>
7079 16 Feb 16 nicklas 300   
7079 16 Feb 16 nicklas 301   </sect1>
7079 16 Feb 16 nicklas 302   
6862 15 Apr 15 nicklas 303   <sect1 id="appendix.update_warnings.3.6">
6862 15 Apr 15 nicklas 304     <title>BASE 3.6</title>
6862 15 Apr 15 nicklas 305   
6862 15 Apr 15 nicklas 306     <bridgehead>Update to Java 8</bridgehead>
6862 15 Apr 15 nicklas 307     <para>
6862 15 Apr 15 nicklas 308       BASE will no longer run with Java 7. Unless you have already
6862 15 Apr 15 nicklas 309       updated to Java 8 you should do so before updating to BASE 3.6.
6863 15 Apr 15 nicklas 310       Note that BASE 3.5 works with both Java 7 and 8 so the Java 
6862 15 Apr 15 nicklas 311       update can be made ahead of time.
6862 15 Apr 15 nicklas 312     </para>
6863 15 Apr 15 nicklas 313     
6863 15 Apr 15 nicklas 314     <bridgehead>Update to Tomcat 8</bridgehead>
6863 15 Apr 15 nicklas 315     <para>
6863 15 Apr 15 nicklas 316       Tomcat 7 is no longer supported. We recommend updating
6863 15 Apr 15 nicklas 317       to Tomcat 8 before updating to BASE 3.6. Note that 
6863 15 Apr 15 nicklas 318       BASE 3.5 works with both Tomcat 7 and 8 so the Tomcat 
6863 15 Apr 15 nicklas 319       update can be made ahead of time.
6863 15 Apr 15 nicklas 320     </para>
6862 15 Apr 15 nicklas 321   
6862 15 Apr 15 nicklas 322   </sect1>
6862 15 Apr 15 nicklas 323   
6807 26 Mar 15 nicklas 324   <sect1 id="appendix.update_warnings.3.5">
6807 26 Mar 15 nicklas 325     <title>BASE 3.5</title>
6807 26 Mar 15 nicklas 326
6807 26 Mar 15 nicklas 327     <bridgehead>Biomaterial lists have been replaced with item lists</bridgehead>
6807 26 Mar 15 nicklas 328     <para>
6891 29 Apr 15 nicklas 329       This is a major change that has caused a binary incompatibility in the BASE core
6807 26 Mar 15 nicklas 330       API. If you depend on custom extensions or plug-ins that use the biomaterial list
6807 26 Mar 15 nicklas 331       API this code must be updated before updating to BASE 3.5. Read more
6807 26 Mar 15 nicklas 332       about the incompatibilities in <xref linkend="appendix.incompatible.itemlists" />.
6807 26 Mar 15 nicklas 333     </para>
6807 26 Mar 15 nicklas 334     
6807 26 Mar 15 nicklas 335     <bridgehead>Consider updating to Java 8</bridgehead>
6807 26 Mar 15 nicklas 336     <para>
6807 26 Mar 15 nicklas 337       Oracle is no longer supporting Java 1.7. We are recommending Java 8
6807 26 Mar 15 nicklas 338       for running BASE. Java 7 is still supported, but will be removed
6807 26 Mar 15 nicklas 339       in the next version (BASE 3.6).
6807 26 Mar 15 nicklas 340     </para>
6807 26 Mar 15 nicklas 341     
6807 26 Mar 15 nicklas 342     <bridgehead>Consider updating to Tomcat 8</bridgehead>
6807 26 Mar 15 nicklas 343     <para>
6807 26 Mar 15 nicklas 344       We have now tested BASE with Tomcat 8 and it seems to work without
6807 26 Mar 15 nicklas 345       any problems. Support for Tomcat 7 will be removed in the next 
6807 26 Mar 15 nicklas 346       version (BASE 3.6).
6807 26 Mar 15 nicklas 347     </para>
6807 26 Mar 15 nicklas 348     
6807 26 Mar 15 nicklas 349   </sect1>
6807 26 Mar 15 nicklas 350   
6465 04 Jun 14 nicklas 351   <sect1 id="appendix.update_warnings.3.4">
6465 04 Jun 14 nicklas 352     <title>BASE 3.4</title>
6465 04 Jun 14 nicklas 353     
6467 05 Jun 14 nicklas 354     <bridgehead>Updating from BASE 2.17 is no longer possible</bridgehead>
6467 05 Jun 14 nicklas 355     <para>
6467 05 Jun 14 nicklas 356       If you are still running an BASE 2.17 (or earlier) BASE version
6467 05 Jun 14 nicklas 357       and want to update to BASE 3.4 you must first update to BASE 3.3
6467 05 Jun 14 nicklas 358       or earlier.
6467 05 Jun 14 nicklas 359     </para>
6467 05 Jun 14 nicklas 360     
6465 04 Jun 14 nicklas 361     <bridgehead>Web services support has been removed</bridgehead>
6465 04 Jun 14 nicklas 362     <para>
6465 04 Jun 14 nicklas 363       As announced earlier web services support has been removed in BASE 3.4.
6465 04 Jun 14 nicklas 364       If anyone require web services support or similar we recommend using the BASE 
6465 04 Jun 14 nicklas 365       extensions mechanism to implement exactly what is needed for that project and 
6465 04 Jun 14 nicklas 366       we also beleive that a simplier API such as JSON is preferable.
6465 04 Jun 14 nicklas 367     </para>
6465 04 Jun 14 nicklas 368     
6479 12 Jun 14 nicklas 369     <bridgehead>PostgreSQL users should change db.dialect</bridgehead>
6479 12 Jun 14 nicklas 370     <para>
6479 12 Jun 14 nicklas 371       In <filename>base.config</filename> there is a <constant>db.config</constant>
6479 12 Jun 14 nicklas 372       setting. Servers running with PostgreSQL as the database should change the
6479 12 Jun 14 nicklas 373       dialect to <classname>org.hibernate.dialect.PostgreSQL9Dialect</classname>
6479 12 Jun 14 nicklas 374       since the <classname>org.hibernate.dialect.PostgreSQLDialect</classname> has
6479 12 Jun 14 nicklas 375       been deprecated.
6479 12 Jun 14 nicklas 376     </para>
6479 12 Jun 14 nicklas 377     
6465 04 Jun 14 nicklas 378   </sect1>
6600 17 Nov 14 nicklas 379
6600 17 Nov 14 nicklas 380   <sect1 id="appendix.update_warnings.3.3.3">
6600 17 Nov 14 nicklas 381     <title>BASE 3.3.3</title>
6126 14 Sep 12 nicklas 382   
6600 17 Nov 14 nicklas 383     <bridgehead>Remaining quantity</bridgehead>
6600 17 Nov 14 nicklas 384     <para>
6600 17 Nov 14 nicklas 385       A bug that affected remaining quantity calculations for 
6600 17 Nov 14 nicklas 386       biomaterial item has been fixed. Existing items may have been
6600 17 Nov 14 nicklas 387       saved with incorrect remaining quantity and must be fixed.
6600 17 Nov 14 nicklas 388       After installing the BASE 3.3.3 update, the existing
6600 17 Nov 14 nicklas 389       remaining quantity values are fix by running a special script.
6600 17 Nov 14 nicklas 390       Change directory to <filename class="directory">&lt;base-dir&gt;/bin/</filename> 
6600 17 Nov 14 nicklas 391       and issue
6600 17 Nov 14 nicklas 392 <programlisting>
6600 17 Nov 14 nicklas 393 ./onetimefix.sh remaining_quantity -u &lt;root login&gt; -p &lt;root pwd&gt;
6600 17 Nov 14 nicklas 394 </programlisting>
6600 17 Nov 14 nicklas 395     </para>
6600 17 Nov 14 nicklas 396     
6600 17 Nov 14 nicklas 397   </sect1>
6600 17 Nov 14 nicklas 398   
6126 14 Sep 12 nicklas 399   <sect1 id="appendix.update_warnings.3.3">
6126 14 Sep 12 nicklas 400     <title>BASE 3.3</title>
6126 14 Sep 12 nicklas 401
6410 31 Jan 14 nicklas 402     <bridgehead>Content security policy</bridgehead>
6410 31 Jan 14 nicklas 403     <para>
6410 31 Jan 14 nicklas 404       The BASE web client now set a rather strict <emphasis>Content 
6410 31 Jan 14 nicklas 405       Security Policy</emphasis> that prevent browsers from executing
6410 31 Jan 14 nicklas 406       code (including JavaScript) that is considered unsafe. Some extensions
6410 31 Jan 14 nicklas 407       may cease to work due to this. Go to
6410 31 Jan 14 nicklas 408       <menuchoice>
6410 31 Jan 14 nicklas 409         <guimenu>Administrate</guimenu>
6410 31 Jan 14 nicklas 410         <guimenuitem>Plug-ins &amp; extensions</guimenuitem>
6410 31 Jan 14 nicklas 411         <guimenuitem>Overview</guimenuitem>
6410 31 Jan 14 nicklas 412       </menuchoice> 
6410 31 Jan 14 nicklas 413       (after upgrading) to see if there are any warnings about this.
6410 31 Jan 14 nicklas 414       Read more in <xref linkend="appendix.web.xml.csp-filter" />
6410 31 Jan 14 nicklas 415       for information about how to relax the policy.
6410 31 Jan 14 nicklas 416     </para>
6410 31 Jan 14 nicklas 417
6126 14 Sep 12 nicklas 418     <bridgehead>Java SE 7 is required</bridgehead>
6126 14 Sep 12 nicklas 419     <para>
6129 14 Sep 12 nicklas 420       BASE now require <ulink url="http://www.oracle.com/technetwork/java/javase/downloads/index.html">Java SE 7</ulink>. 
6129 14 Sep 12 nicklas 421       Servers with Java SE 6 or older should be updated to Java SE 7 before installing BASE 3.3.
6126 14 Sep 12 nicklas 422     </para>
6126 14 Sep 12 nicklas 423
6129 14 Sep 12 nicklas 424     <bridgehead>Tomcat 7 is required</bridgehead>
6129 14 Sep 12 nicklas 425     <para>
6129 14 Sep 12 nicklas 426       BASE now require <ulink url="http://tomcat.apache.org/download-70.cgi">Tomcat 7</ulink>.
6129 14 Sep 12 nicklas 427       Servers with Tomcat 6 or older should be updated to Tomcat 7 before installing BASE 3.3.
6129 14 Sep 12 nicklas 428     </para>
6434 14 Mar 14 nicklas 429     
6434 14 Mar 14 nicklas 430     <bridgehead>Web services support has been deprecated</bridgehead>
6434 14 Mar 14 nicklas 431     <para>
6434 14 Mar 14 nicklas 432       The current implementation is most likely not very useful and has limited
6434 14 Mar 14 nicklas 433       support for accessing information in BASE. Therefore it has been decided to
6434 14 Mar 14 nicklas 434       remove the web services support in BASE 3.4. If anyone require web services
6434 14 Mar 14 nicklas 435       support or similar we recommend using the BASE extensions mechanism to implement
6434 14 Mar 14 nicklas 436       exactly what is needed for that project and we also beleive that a simplier
6434 14 Mar 14 nicklas 437       API such as JSON is preferable.
6434 14 Mar 14 nicklas 438     </para>
6129 14 Sep 12 nicklas 439
6126 14 Sep 12 nicklas 440   </sect1>
6126 14 Sep 12 nicklas 441   
6081 08 Aug 12 nicklas 442   <sect1 id="appendix.update_warnings.3.2">
6081 08 Aug 12 nicklas 443     <title>BASE 3.2</title>
6081 08 Aug 12 nicklas 444   
6081 08 Aug 12 nicklas 445     <bridgehead>Custom logging implementations must be updated</bridgehead>
6081 08 Aug 12 nicklas 446     <para>
6081 08 Aug 12 nicklas 447       The plug-in functionality for custom logging has been converted
6081 08 Aug 12 nicklas 448       to an extension point. The default database logging will continue
6081 08 Aug 12 nicklas 449       to function, but custom logging implementations must be converted
6081 08 Aug 12 nicklas 450       to an extension. See <xref linkend="appendix.incompatible.3.2" /> and 
6081 08 Aug 12 nicklas 451       <xref linkend="extensions_developer.logging" /> for more information.
6081 08 Aug 12 nicklas 452     </para>
6081 08 Aug 12 nicklas 453   
6081 08 Aug 12 nicklas 454   </sect1>
6081 08 Aug 12 nicklas 455   
6081 08 Aug 12 nicklas 456   <sect1 id="appendix.update_warnings.3.0">
6081 08 Aug 12 nicklas 457     <title>BASE 3.0</title>
6081 08 Aug 12 nicklas 458     
6081 08 Aug 12 nicklas 459     <note>
6133 14 Sep 12 nicklas 460       <title>Upgrading to BASE 3 is possible from BASE 2.17 only</title>
6081 08 Aug 12 nicklas 461       <para>
6081 08 Aug 12 nicklas 462         If your BASE is an older 2.x version you'll need to upgrade
6133 14 Sep 12 nicklas 463         to BASE 2.17 before an upgrade to BASE 3 is possible. Also note
6133 14 Sep 12 nicklas 464         that since BASE 3.3 we no longer actively test the upgrade
6133 14 Sep 12 nicklas 465         script. If upgrading doesn't work for a particular BASE 3.x version 
6133 14 Sep 12 nicklas 466         (where x &gt; 2) please try to upgrade to BASE 3.2 first and then 
6133 14 Sep 12 nicklas 467         from BASE 3.2 to BASE 3.x.
6081 08 Aug 12 nicklas 468       </para>
6081 08 Aug 12 nicklas 469     </note>
6081 08 Aug 12 nicklas 470
6081 08 Aug 12 nicklas 471     <warning>
6081 08 Aug 12 nicklas 472       <title>Make sure that you have a recent backup of the BASE 2.17 database</title>
6081 08 Aug 12 nicklas 473       <para>
6081 08 Aug 12 nicklas 474         Before starting the upgrade from BASE 2.17 to BASE 3 ensure that you
6081 08 Aug 12 nicklas 475         have a recent backup. If the upgrade fails you must restore the 
6081 08 Aug 12 nicklas 476         2.17 database before you can try again. The upgrade only changes the
6081 08 Aug 12 nicklas 477         'static' part of the database, so you do not have to restore the
6081 08 Aug 12 nicklas 478         'dynamic' part or the uploaded files.
6081 08 Aug 12 nicklas 479       </para>
6081 08 Aug 12 nicklas 480     </warning>
6081 08 Aug 12 nicklas 481
6081 08 Aug 12 nicklas 482     <bridgehead>Old plug-ins and extensions may not work</bridgehead>
6081 08 Aug 12 nicklas 483     <para>
6081 08 Aug 12 nicklas 484       The BASE API has changed in several places and it is not certain that
6081 08 Aug 12 nicklas 485       plug-ins and extensions developed for BASE 2 works with BASE 3. The
6081 08 Aug 12 nicklas 486       upgrade will disable all plug-ins and extensions that are currently installed.
6081 08 Aug 12 nicklas 487       Before you upgrade we recommend that you go through all (external) plug-ins
6081 08 Aug 12 nicklas 488       and check if there is an updated version. The recommended approach
6081 08 Aug 12 nicklas 489       is to first upgrade BASE and then install updated versions of plug-ins
6081 08 Aug 12 nicklas 490       and extensions following the instructions in <xref 
6081 08 Aug 12 nicklas 491       linkend="plugins.installation"/>.
6081 08 Aug 12 nicklas 492     </para>
6081 08 Aug 12 nicklas 493     
6081 08 Aug 12 nicklas 494     <para>
6081 08 Aug 12 nicklas 495       If there is no updated version of a specific plug-in you may try 
6081 08 Aug 12 nicklas 496       a manual re-installation of the old plug-ins. Follow the instructions
6081 08 Aug 12 nicklas 497       in <xref linkend="plugins.installation.manual" />.
6081 08 Aug 12 nicklas 498     </para>
6081 08 Aug 12 nicklas 499     
6081 08 Aug 12 nicklas 500     <para>
6081 08 Aug 12 nicklas 501       If there is no updated version and the old plug-in doesn't work with
6081 08 Aug 12 nicklas 502       BASE 3, you'll need to decide if you really need the plug-in or if
6081 08 Aug 12 nicklas 503       the upgrade should wait until a new version of the plug-in 
6081 08 Aug 12 nicklas 504       has been released.
6081 08 Aug 12 nicklas 505     </para>
6081 08 Aug 12 nicklas 506     
6081 08 Aug 12 nicklas 507     <bridgehead>Batch item importer changes</bridgehead>
6081 08 Aug 12 nicklas 508     <para>
6081 08 Aug 12 nicklas 509       There are several changes to batch item importers that may affect
6081 08 Aug 12 nicklas 510       current workflows and file templates used for importing data.
6081 08 Aug 12 nicklas 511     </para>
6081 08 Aug 12 nicklas 512     
6081 08 Aug 12 nicklas 513     <itemizedlist>
6081 08 Aug 12 nicklas 514       <listitem>
6081 08 Aug 12 nicklas 515         <para>
6081 08 Aug 12 nicklas 516           Sample and extract importers: The 'pooled' column is no longer used.
6081 08 Aug 12 nicklas 517           Instead a 'parent type' column should be used with
6081 08 Aug 12 nicklas 518           the parent type as a string value (BIOSOURCE, SAMPLE or EXTRACT). 
6081 08 Aug 12 nicklas 519           Existing importer configurations and file templates may have to be 
6081 08 Aug 12 nicklas 520           updated. If no parent type is specified the sample importer assumes
6081 08 Aug 12 nicklas 521           a biosource and the extract importer assumes a sample.
6081 08 Aug 12 nicklas 522         </para>
6081 08 Aug 12 nicklas 523       </listitem>
6081 08 Aug 12 nicklas 524       <listitem>
6081 08 Aug 12 nicklas 525         <para>
6081 08 Aug 12 nicklas 526           Labeled extract importer: This has been deprecated and it is recommended
6081 08 Aug 12 nicklas 527           that the <emphasis>Extract importer</emphasis> is used instead. 
6081 08 Aug 12 nicklas 528           We recommend that existing labeled extract importer configurations are re-created as extract 
6081 08 Aug 12 nicklas 529           importer configurations. The old labeled extract importer can be 
6081 08 Aug 12 nicklas 530           re-enabled, but note that the existing configurations still need
6081 08 Aug 12 nicklas 531           to be changed due to the 'pooled' column is no longer used.
6081 08 Aug 12 nicklas 532         </para>
6081 08 Aug 12 nicklas 533       </listitem>
6081 08 Aug 12 nicklas 534       <listitem>
6081 08 Aug 12 nicklas 535         <para>
6081 08 Aug 12 nicklas 536           Hybridization importer: This has been deprecated and we recommend
6081 08 Aug 12 nicklas 537           that the <emphasis>Physical bioassay importer</emphasis> is used instead. 
6081 08 Aug 12 nicklas 538           Existing hybridization importer configurations should be re-created as 
6081 08 Aug 12 nicklas 539           physical bioassay importer configurations. 
6081 08 Aug 12 nicklas 540         </para>
6081 08 Aug 12 nicklas 541       </listitem>
6081 08 Aug 12 nicklas 542       <listitem>
6081 08 Aug 12 nicklas 543         <para>
6081 08 Aug 12 nicklas 544           Scan importer: This has been deprecated and it is recommended
6081 08 Aug 12 nicklas 545           that the <emphasis>Derived bioassay importer</emphasis> is used instead. 
6081 08 Aug 12 nicklas 546           Existing scan importer configurations should be re-created as derived 
6081 08 Aug 12 nicklas 547           bioassay importer configurations.
6081 08 Aug 12 nicklas 548         </para>
6081 08 Aug 12 nicklas 549       </listitem>
6081 08 Aug 12 nicklas 550     </itemizedlist>
6081 08 Aug 12 nicklas 551     
6081 08 Aug 12 nicklas 552     <note>
6081 08 Aug 12 nicklas 553       The deprecated importers can be re-enabled by an administrator from the 
6081 08 Aug 12 nicklas 554       <menuchoice>
6081 08 Aug 12 nicklas 555         <guimenu>Administrate</guimenu>
6081 08 Aug 12 nicklas 556         <guisubmenu>Plug-ins &amp; extensions</guisubmenu>
6081 08 Aug 12 nicklas 557         <guimenuitem>Overview</guimenuitem>
6081 08 Aug 12 nicklas 558       </menuchoice> page, but they are
6081 08 Aug 12 nicklas 559       lacking features that are available in the new importers so this is not
6081 08 Aug 12 nicklas 560       something that we recommend.
6081 08 Aug 12 nicklas 561     </note>
6081 08 Aug 12 nicklas 562     
6081 08 Aug 12 nicklas 563     <bridgehead>MySQL and PostgreSQL versions</bridgehead>
6081 08 Aug 12 nicklas 564     <para>
6081 08 Aug 12 nicklas 565       We have only tested BASE 3 with PostgreSQL 9.1. If anyone
6081 08 Aug 12 nicklas 566       experiences any issues with earlier PostgreSQL versions, we 
6081 08 Aug 12 nicklas 567       recommend an upgrade to PostgreSQL 9.1. This is a change since
6081 08 Aug 12 nicklas 568       BASE 2 which was tested with PostgreSQL 8.4. Even though BASE 3 
6081 08 Aug 12 nicklas 569       may work with older PostgreSQL versions, we don't have the resources 
6081 08 Aug 12 nicklas 570       needed to test and provide support for it.
6081 08 Aug 12 nicklas 571     </para>
6081 08 Aug 12 nicklas 572     
6081 08 Aug 12 nicklas 573     <para>
6081 08 Aug 12 nicklas 574       We have only tested BASE 3 with MySQL 5.1 (no change since BASE 2). 
6081 08 Aug 12 nicklas 575       If anyone experiences any issues with earlier (or later) MySQL versions, 
6081 08 Aug 12 nicklas 576       we recommend an upgrade/downgrade to MySQL 5.1.
6081 08 Aug 12 nicklas 577     </para>
6081 08 Aug 12 nicklas 578   
6081 08 Aug 12 nicklas 579   </sect1>
6081 08 Aug 12 nicklas 580   
5677 29 Jun 11 nicklas 581   <sect1 id="appendix.update_warnings.2.x">
5677 29 Jun 11 nicklas 582     <title>All BASE 2.x releases</title>
4638 17 Nov 08 nicklas 583     
4638 17 Nov 08 nicklas 584     <para>
5677 29 Jun 11 nicklas 585       We only support updating to BASE 3 from BASE 2.17. If you have an older BASE
5677 29 Jun 11 nicklas 586       version and wish to update to BASE 3, you first have to upgrade to BASE 2.17.
7982 14 Jun 21 nicklas 587       BASE 2.17 can be downloaded from the <ulink url="https://base.thep.lu.se/wiki/DownloadPage">BASE 
5677 29 Jun 11 nicklas 588       download page</ulink>. Documentation for BASE 2.17 is available as part of the
7982 14 Jun 21 nicklas 589       download and at <ulink url="https://base.thep.lu.se/chrome/site/2.17/html/index.html"
7982 14 Jun 21 nicklas 590       >https://base.thep.lu.se/chrome/site/2.17/html/index.html</ulink>.
4638 17 Nov 08 nicklas 591     </para>
4638 17 Nov 08 nicklas 592
4638 17 Nov 08 nicklas 593   </sect1>
4638 17 Nov 08 nicklas 594   
4638 17 Nov 08 nicklas 595 </appendix>
4638 17 Nov 08 nicklas 596

Generated on Sat Oct  7 02:27:13 2023 (UTC) by svndigest 0.11.2pre (dev build 1672)