OpenVPMS 1.7-SNAPSHOT Release ========================== 1. Installation Notes See section 2 if you are upgrading and existing system rather than installing. Note that in this text the directory or folder separator character is shown as / following the unix usage. If you are using Windows, then you will be using \ so that paths shown as say /lib will in fact be \lib. 1.1 Requirements - OpenVPMS requires the following to be installed: - Java 1.6.x or higher See http://www.oracle.com/technetwork/java/javase/downloads/index.html - MySQL 5.0.24a or higher See http://www.mysql.org/downloads/mysql/5.0.html - MySQL Connector/J JDBC driver See http://dev.mysql.com/downloads/connector/j/5.1.html - Tomcat 6.0 or higher See http://tomcat.apache.org/download-60.cgi - OpenOffice 2.2.1 or higher See http://download.openoffice.org/ - MySQL: - should be on the same host as Tomcat - should accept connections on port 3306 - include the following lines in my.ini max_allowed_packet=16M innodb_file_per_table 1.2 Directory structure The OpenVPMS installation has a single top-level directory named openvpms-release-1.7-SNAPSHOT This will be referred to as in the remainder of this document. This directory has the following sub-directories: - bin contains a number of tool scripts used to load data into OpenVPMS - conf contains configuration files for the tools in bin/ - db contains MySQL SQL scripts to create the initial database - import contains data to import into OpenVPMS - lib contains jars used by the tools in bin/ - reports contains document templates for reporting - update contains data and scripts to migrate from earlier versions of OpenVPMS - webapps contains the OpenVPMS web applications 1.3 JDBC driver installation The MySQL Connector/J JDBC driver needs to be downloaded from: http://dev.mysql.com/downloads/connector/j/5.1.html It is typically named mysql-connector-java-5.1..zip or mysql-connector-java-5.1..tar.gz where represents the minor version number. The JDBC driver in the archive is named: mysql-connector-java-5.1.-bin.jar. This needs to be copied to: * the Apache Tomcat library directory: /lib * the OpenVPMS library directory: /lib In the above, refers to the directory where Apache Tomcat is installed. On Windows, this will be something like: C:\Program Files\Apache Software Foundation\Tomcat 6.0 1.4 Database setup To create the OpenVPMS MySQL database, run the following in a shell prompt > cd /db > mysql -u admin -p < createdb.sql > mysql -u admin -p openvpms < db.sql NOTE: replace 'admin' with a user that has administrator priviledges in MySQL Next, run the 'dataload' script. This provides two options, 'base' and 'setup'. The former loads a base database setup in preparation for data migration. The latter contains a default setup suitable for a new installation. E.g: > cd /bin > dataload setup 1.5. Web application installation To install the OpenVPMS web application: 1. Copy /webapps/openvpms.war to the /webapps directory. 2. Start Apache Tomcat if it is not running 1.6 Testing the installation To test the installation, open up your Internet Browser and enter the address: http://localhost:8080/openvpms/app Login to OpenVPMS using user admin and password admin 2. Upgrading This section details the upgrade procedure. 2.1 Release compatibility The following table shows the upgrade path to the current release: From version Remarks 1.7 (earlier build) As per steps 2.2 and following 1.6 As per steps 2.2 and following 1.5 ?????????? 1.4 ?????????? 2.2 Preparation If you are reading this file, then your will have already unzipped the OpenVPMS package. Hopefully you have not overwritten your previous contents but instead have renamed it. (Note that a common practice is to hold the current release in say C:\OpenVPMS\Current-release (rather than C:\OpenVPMS\openvpms-release-VVV where VVV is the version, eg 1.6 so that scripts that you have do not have to be updated). Here it is assumed that your previous version is now in . 2.3 MySql connector Copy the MySQL JDBC driver mysql-connector-java-5.1.-bin.jar from /lib to /lib 2.4 Web application The existing web application should be removed before installing the new version. To do this: 1. Shut down Apache Tomcat if it is already running. 2. Delete the directory: /webapps/openvpms or better rename it to /webapps/openvpms-prev 3. Delete the file: /webapps/openvpms.war 4. Copy /webapps/openvpms.war to the directory /webapps 5. Start Apache Tomcat - this will extract stuff from /webapps/openvpms.war and build /webapps/openvpms 2.5 Customisation If you have customised version of propercase.properties, help.properties, or messages.properties you need to install these in /webapps/openvpms/WEB-INF/classes/localisation You can simply overwrite the default propercase.properties with your own version. However, help.properties and messages.properties will need to be edited to bring your adjustments into the current versions. NOTE - as at build 5415 of 1.7Alpha, you need to extract messages.properties from /webapps/openvpms/WEB-INF/lib/openvpms-web-component-1.7-SNAPSHOT.jar because it is not currently shipped in the localisation directory /webapps/openvpms/WEB-INF/classes/localisation If you have a customised default.stylesheet, then the version in /webapps/openvpms/WEB-INF/classes/style will need to be edited to incorporate your changes. Now restart Apache Tomcat so the above customisations get picked up and login and see that things are as they should be. 2.6 Kettle If you use Pentaho Data Integration (see 4 below) then you need perform its steps 1,2 and 3 to upgrade the OpenVPMS components. 3. Subscription OpenVPMS relies on user subscriptions to fund development. Your subscription status is displayed on the OpenVPMS login screen. If you have not paid, a link to a payment page is displayed. On payment, a subscription key will be mailed to you. If you have a current subscription, you can request a subscription key be emailing a copy of your receipt to subscription@openvpms.org. To update your subscription status, edit the Practice in the Administration -> Organisation workspace and upload the new subscription key. 4. Data Migration OpenVPMS doesn't directly support data migration from other veterinary practice systems. It does however provide a plugin for Pentaho Data Integration (PDI, aka Kettle) that can be used to get data into OpenVPMS. At this stage, only PDI 3.2 is supported. This can be obtained from: http://sourceforge.net/projects/pentaho/files/Data%20Integration/3.2.0-stable/pdi-ce-3.2.0-stable.zip/download Extract this zip file to a directory. This will be referred to as . To install the OpenVPMSLoader plugin: 1. Extract /import/plugin/OpenVPMSLoader.zip to /plugins/steps/OpenVPMSLoader 2. Remove /libext/spring/spring-core.jar 3. Copy the OpenVPMS jars to libext/spring i.e. copy plugins/steps/OpenVPMSLoader/*.jar libext/spring/ 5. Browser Compatibility OpenVPMS is designed to be used with Firefox, Chrome or Safari. The Context Sensitive Help facility provides help when you press Alt-F1 on almost all screens. By default, the help is displayed in a separate browser window. If you want it displayed in a tab rather than a new window then you will need a browser add-in to accomplish this. The following appear to work: - for Firefox, the 'Open Link in New Tab' add-on - for Chrome the 'One Window' extension - for Safari ????????