Shutdown the current instance of intraLibrary. You can do this by either shutting down the application server that intraLibrary is running on, or by undeploying the web application itself. You will have to restart the application server later, so shutting down now is preferred. If you are using Tomcat and are unsure about stopping and starting, see here for more help.

We strongly advise that you make a copy of your intraLibrary database. If you are using MySQL and are not sure how to back up the database see here for details.

The basis of the intraLibrary web application is the intralibrary.war file file. You can put this archive anywhere on the server, but we'd recommended it to be on the same physical volume as the application server (Tomcat).

To avoid confusion between the new and old versions of the web application, rename the previous war file to intralibrary_old.war. Once you are satisfied that the new version of intraLibrary runs correctly the old war file can be removed completely.

While not essential, we strongly advise that you remove the index folder from within your intraLibrary config dir. There have been instances whereby the index has become out of sync with the contents of the intralibrary database. Removing this directory will prevent any inconsistencies.

This release includes some new properties, if required these can be added to the intralibrary.properties file within your config directory. If you don't require any of the functionality specified below there is no need to add the new properties

• bigThumbnailDimension

  This specifies the width, in pixels, of the big thumbnail shown on the image search results view. The thumbnail is scaled to the appropriate width whilst preserving the aspect ratio. The default value for this property is 200. The maximum value for this property is 300

• smallThumbnailDimension

  This specifies the width and height, in pixels, of the small thumbnail shown on the image search results view. The default value for this property is 75. The minimum value for this property is 30. The maximum value for this property is 200.

• thumbnailQuality

  This specifies the quality of the thumbnail being displayed on the image search results view. The default value for this property is 7. The property is in the range 1-9, with 1 being the lowest quality and 9 being the highest. Note that the higher the quality the slower the rendering of the thumbnail.

• srwIdentifierType

  This specifies the value of the technical location field (or dc identifier field) when results are retrieved using srw/sru. Possible values are 'preview' or 'download', the default value if not specified is 'preview'

Within the intraLibrary config directory there is an emailTemplates folder, ensure that this folder contains the following files. Note that each of these files should also appear in the language specific folders (e.g. en, es) within the emailTemplates directory.

• The text of the publish notification email sent to administrators - (adminPublishNotificationEmail.txt)
• The text of the notification email sent to administrators or librarians when annotations are added to an object - (annotationNotificationEmail.txt)
• The text of the notification email sent to the object owner when a user comments on one of their objects - (objectOwnerAnnotationNotificationEmail.txt)
• The text of the notification email sent to users when an object is moved - (stageChangeEmail.txt)
• The text of the notification email sent to named external users when an object is moved into a certain stage - (stageChangeExternalUserEmail.txt)
• The text of the notification email sent to the object owner when an object is moved into a certain stage - (stageChangeObjectOwnerEmail.txt)
• The text of the publish notification email sent to users - (userPublishNotificationEmail.txt)

If the contents of the emailTemplates directory (or any sub-folders) are incomplete, then you can copy the appropriate files from the emailTemplates folder provided as part of this distribution

There is some new functionality in in this release that includes graphic thumbnail functionality. If you want to make use of this functionality within intraLibrary, the server must be started with the java.awt.headless=true property. If using Tomcat, the easiest way to achieve this is to add the property to the catalina startup script (.sh or .bat) in the Tomcat bin directory:

JAVA_OPTS="-Djava.awt.headless=true"

It's now time to start the application. The first time that intraLibrary is started, any database changes will be applied on the server to ensure compatibility with the new version. The database changes are fairly minor so the amount of time taken to upgrade should be small.

If you wish to monitor the upgrade process, you can monitor the upgradeReport.log file which can be found in the directory specified as 'configDir' in your properties file. This file will tell you when the process is finished by outputting the line 'finished upgrading'.

If you check the output of the server startup, you should see some text resembling the text below.

****************************************

populating learning object cache with 0 objects...
finished populating learning object cache

****************************************
application version: n.n (nnnnn)
database server version:4.0.18-standard
database url:jdbc:mysql://localhost:3306/intralibrary?autoReconnect=true
database driver:MySQL-AB JDBC Driver
max database connections(0=unlimited):0
max upload file size:49Mb
servlet container:Apache Tomcat/4.1.18-LE-jdk14
java version:1.4.2_03
----------------------------------------
configDir location:/Volumes/projects/intralibrary/config
http proxy:no proxy used
mail host:mail.company.com
admin email:admin@company.com
error email:errors@company.com
return email:intralibrary1@company.com
id prefix:com.comapany.intralibrary1
repository name:intralibrary1
object cache size:250
entry page:browse
debug:false
reindexOnStartup:true
----------------------------------------
total memory assigned:26Mb
maximum memory assigned:112Mb
----------------------------------------
licence assigned to:company
max contributors:10
current contributors:1
expires:
----------------------------------------
IntraLibrary started dd-MMM-yyyy hh:nn:ss
****************************************

Assuming that you have no errors in this output then congratulations, you have successfully upgraded your installation of intraLibrary.