This documentation is all community contributed. Feel free to contribute your own documentation to the website so that other users can benefit. If there is no documentation for your operating system please use the windows install docs as a guide and then contribute back the documentation to the community for your operating system.
NOTE: the online documentation contains sections covering installation.
This documention is version specific, and should be consulted for information about the version you are installing.
The OpenVPMS 2.3 installation documentation is located here.
This page contains the package guidelines for OpenVPMS as per the date this file was updated. Where a package mentioned here has been superseded by its maintainer we recommend the use of that new package unless specifically mentioned here.
Oracle Java 8.x - Java Runtime Environment. (ie JRE)
Alternatively
Oracle JDK 8.x
OpenJDK 8.x
Tomcat 7.x
OpenOffice 4.x
Mysql 5.5.x
Mysql Connector for Java 5.x
Mysql Notifier 1.x
MySQL Workbench
JasperSoft Studio 6.x
This tutorial describes one user's step-by-step installation of OpenVPMS 2.x on a PC with a Windows 10 32-bit or 64-bit operating system. Originally written with images for Windows 7, there have been some changes in software upgrades, appearance, links and images will be updated for Windows 10 if there's any significant difference. Update advice: Apps are updated and links are accurate as of 18 November 2021. This guide is not an official OpenVPMS guide.
When installing OpenVPMS you should
Consider taking a System Image of your server before you start - sometimes timewise it's easier to revert to "start over" rather than fix recalcitrant errors.
Execute jre-8u281-windows-x64 (or x86 for 32-bit).exe and accept all defaults.
Right-Click on Computer icon on desktop, then click "Properties".
Click on Advanced System Settings (1), Advanced (2) and then Environment Variables (3):
Under System Variables (lower box - upper box is for User Variables), click on New(4), then enter JAVA_HOME and browse to the Java folder and press OK
The end result should look like this:
Click OK, OK, then close the remaining window.
Click Start | Control Panel | System And Security:
Click on Windows Defender Firewall:
Click on Advanced Settings, then follow images as below:
You've confirmed the new rule, so close the window (click on red x).
If you're going to access OpenVPMS from other computers on a network within the clinic, you'll also need to allow port 8080.
Repeat the steps above, this time typing in 8080 as the TCP Port to allow and name it Openvpms.4. Install MySQL
Double-click on the "mysql-essential-5.5.nn-win32.msi" file you have downloaded and follow the images below:
Be patient: at this point, it may take some time for the progress bar to start moving (on one of my PCs, over three minutes), so just leave the PC to do its work: the following screens should be self-explanatory: press Next when prompted to do so:
At next screen, DO NOT CLICK "Finish" until you read the following steps:
STOP HERE! (Don't click "Finish" just yet)
Leave the above window on the screen.
Why?
You need to set read/write permissions before configuration or the Configuration Wizard will fail at execution, thus:
Open Windows Explorer, browse to ProgramFiles\MySQL\MySQL Server 5.5.
Right-click on the folder and select Properties; un-check Read-Only tab:
Click on Security tab, then Edit, then Users:
Click on Allow | Full Control then click OK:
Ensure "Apply changes..." (1) is checked and click Ok Ok.
Now go ahead and click "Finish" to load the Configuration Wizard (2).
At this screen, click on the drop-down arrow and select \Data:
Your screen should then look like this: if it does, click Next to continue:
You now need to ensure all permissions are enabled. In previous Windows7 installation instructions, this step was placed here. However, in indows 10 pro, if you didn't un-set the read-only flag and set Full Control permissions before configuring MySQL the Configuration app would crash at the "Starting Service" button.
It won't hurt to check your permissions here before continuing.
- Click on "Computer" icon, browse to C:\Program Files\MySQL;
- right-click on MySQL Server 5.5 (1);
- select Properties and then click on Security (2) tab;
- select Users (3);
- then click Edit (4), click Users (5) and click to enable Full Control (6);
- and press OK.
5. Install MySQL GUI Tools
Double-click on the "mysql-gui-tools-5.0-r17-win32.msi" file you have downloaded to commence installation. Whilst this is an older app, you need this to configure MySQL in the next step. This step is essential but is not listed in the official OpenVPMS documentation
Click "Next" all the way through to complete default installation.
6. MySQL Configuration
Click Start | MySql | right-click MySql Administrator | More | Run As Administrator.
Click on the button with the ellipsis (...) arrowed in image below:
Click on New Connection:
Change New Connection to localhost then fill in the fields (root, openvpms, localhost) as per image below and click Apply | Close:
You should now be back at the opening screen: select localhost from the drop-down box and click OK
On the left-hand pane, click Startup Variables (1), then click on the InnoDB Parameters (2) tab.
Scroll down to, and check Buffer Pool Size (3) and type in 1024 (recommended for OpenVPMS with minimum of 4GB RAM).
Scroll down to, and check One File Per Table (4).Click on Advanced Networking tab (5), enable Max. packet size and set to 16 M (6), then click Apply Changes (7) and close the window (8).
7. Apache Installation
Double-click on the "apache-tomcat-9.0.nn.exe" file you have downloaded to commence installation (app hasn't changed in appearance from 7->8->9); click Next;
Click Next;
Fill in User Name as admin and password as openvpms click Next;
Installer should find your Java installation without any intervention by you; if you have more than one, pick highest build number, then click Next
Accept default installation folder and click Install;
8. Configure Apache Tomcat
At this point you would normally click Start, right-click on Configure Tomcat and select Run As Administrator:
But unfortunately you would be presented with this error message:
You need to take two additional steps:
1. disable UAC. Click Start | Control Panel | System and Security | Change User Account Control Settings and set UAC to "Never Notify:
2. Browse to Tomcat 9.0\bin folder, right-click on Tomcat9w.exe and select Run As Administrator:
Click on Java tab. In Java Options, scroll down to the bottom and add the following two lines:
-XX:PermSize=128m
-XincgcSet Initial Memory Pool and Maximum Memory Pool to the same value, depending on the number of users; say 512 at a minimum. Try 1024 for 4GB memory or higher.
Changes required are highlighted in yellow in image below:
Click OK and close.9. OpenOffice Installation
Double-click on the "Apache_OpenOffice_4.n.n_Win_x86_install_en-GB.exe" file you have downloaded to commence installation; accept all default values as per the following images:
Once installed, start OpenOffice, fill in details and from the main menu select Tools | Options:
Click on On-line Update and un-check Check for updates automatically;
Click OK to close options.
Close OpenOffice.
10. Configure OpenOffice Path
Right-Click on Computer icon on desktop, then click "Properties".
Click on Advanced System Settings (1), Advanced (2) and then Environment Variables (3):
Under System Variables (lower box ), click on Path (4), then click Edit (5);
Press New (6), then Browse (7) and select c:\Program Files (x86)\OpenOffice4\program (8) and press Ok (9):
Click OK, then close the remaining window.Test your OpenOffice path configuration.
Click Start | Windows System | Command Prompt:
Type in swriter and press Enter. OpenOffice/Writer should start. Two reasons for doing this:
- If it does start, you've set the path correctly.
- OpenVPMS starts OpenOffice in the background; if OpenOffice is waiting for questions on registration and checking for updates to be answered, letter merging etc. won't work.
Reopening OO makes sure it is not asking for you to participate in surveys etc.
If all's well, close OpenOffice.11. MySQL Database Driver Setup
- Open the downloaded mysql-connector-java-8.0.nn.zip.
- Extract connector file mysql-connector-java-8.0.nn.jar to Tomcat library folder i.e C:\Program Files\Apache Software Foundation\Tomcat 9.0\lib.
- Extract the same connector to c:\OpenVPMS\lib folder.
So far so good, it should only have taken you eight minutes (or less) on an average >2018 PC to get to this point.
12. OpenVPMS Database Setup
Click Start | Windows System | Command Prompt, navigate to C:\OpenVPMS\bin.
Type in toolbox configure and press Enter.
{Note: if using Powershell instead of Command Prompt,you Right-Click-Start | WindowsPowerShell, navigate to C:\OpenVPMS\bin, you will need to type in ./toolbox configure and press Enter .}
Type in toolbox database --create -u root -p openvpms and press Enter.
Type in dataload setup and press Enter. Lots of messages will scroll down the creen - first and last few shown here.
Type in toolbox template --load --size A4 --all and press Enter (type A5 if using that size of paper). Again lots of messages will scroll down the screen.
14. OpenVPMS Web Application Setup
Still at the Command prompt window at c:\openvpms\bin type toolbox war and press Enter.
Copy openvpms.war from c:\openvpms\webapps to c:\Program Files\Apache Software Foundation\Tomcat 9.0\webapps.
Copy the openvpms.war file from c:\openvpms\webapps
to Tomcat Webapps folder at C:\Program Files\Apache Software Foundation\Tomcat 6.0\webapps.
16. Apache Tomcat Service Setup
On the desktop, right-click on Computer icon and select Manage.
In Services and Applications, click on Services, right-click on Apache Tomcat 9 and select Properties. Click on General tab and change Startup type to Automatic.
Click OK to close.Click on Apache Tomcat 9, then click on Restart the service.
One last thing: right-click on Properties again, select General and check Startup Type: make sure it's set to Automatic, then click Ok, then Stop and then Restart the service. (Aggravatingly, after all this setup had been completed, I got a "refused connection" at Step 17 below. I went back to Tomcat Properties and found that the StartupType had reset itself(?) to Manual.)
17. OpenVPMS Application Test/Run
Open up your internet browser this address: http://localhost:8080/openvpms/app
Login to OpenVPMS using user 'admin' and password 'admin'
Eureka! It works!
18. OpenVPMS Application From Other PCs on Network
First, you need to establish the IPv4 address of your server (the PC that your OpenVPMS installation resides on):
Open a Command Prompt (Start | Windows System | Command Prompt) and type ipconfig and press Enter.
Look for the line IPv4 address: in the screenshot below, it's 192.168.1.101:
To start OpenVPMS on another PC on the network, you will need to type in http://IPv4_address:8080/openvpms; in example below, http://192.168.1.101:8080/openvpms:
However, there's a distinct possibility that you are told you can't connect to OpenVPMS.
Windows 10 now throws up another gotcha just when you thought you were home free! By default Windows sets networks as public, so when you try to log in to OpenVPMS from another PC on the network, you are denied access.
You need to set the network to Private on the PC containing OpenVPMS.
Follow these steps.
Click Settings (gear wheel) | Network & Internet:
Click Ethernet (or whatever your network is called):
Click Network:
Select Private as your Network profile and close. OpenVPMS should now load from your workstation machine.
Click here to move on to setting up OpenVPMS for use.
This resource is an openVPMS enduser-created tutorial. Constructive criticism and corrections welcome.
Awesome tutorial!
A couple notes on update.
1) If you use MySQL full install (aka all bells and whistles) as I needed it for other applications, the new *.msi ver 5.5 is broken. To fix change the data path to something else, c:\openvpms\data will work nicely:) Older versions the *.msi works I am told but I wanted the new version as of 11/12.
2) Difficult to run the mysql.exe file from the command prompt for the db imports on windows 7. I would suggest copying the mysql.exe file from c:\program files\mysql\bin to your Openvpms db directory. Then opening command prompt from accessories. Then change directory to your bin directory and then you can run mysql as the tutorial suggests. Perhaps with MySQL ver 5.5 that option as described in the tutorial has been removed??? Anyway that works well.
Other notes:
Anyways, did a little research and found "Jasper Studio" which is made by Jasper iReports and is very user friendly unlike simply iReports. It is made by the same company and open source. It actually will do the little boxes etc lol so more of my cup of tea since I paint as well and am well versed in Corel products. I would highly recommend it for anyone installing or tweaking their reports. I'll post a sticky in the Implementation documentation. I know, I know, another program to download, but well worth it.
Another issue was that the reports were read / write only thanks to Windows 7 security setting (why the primary user doesn't get admin rights seems rather strange, but I suppose if cell phones worked here etc and mobility then it might be useful to prevent tampering.... although I could think of better things to do but c'est la vie. So something to check if you are having problems.
Thanks again,
Don
cc:// implementation documentation
Important Note- when installing OpenVPMS you should be logged in on an account that has administrator privileges!
In order for other applications to be able to find the java installation we need to set an environmental variable on the system.
max_allowed_packet=16M
innodb_file_per_table
-XX:PermSize=128m
-Xincgc
mysql -u root -p
mysql> source createdb.sql;
mysql> use openvpms;
mysql> source db.sql;
mysql> quit;
Based on OpenVPMS Installation (Windows), here is the tasks list with plenty of screen shots I 've made while I installed OpenVPMS on the new computer with Vista (french version).
Hi:
Just wondering if anyone has tried installing this on FreeBSD 7.0 RELEASE?
We have Tomcat5.5, Mysql 5.0.33, Sun JDK 1.5.0_13 running on a FreeBSD Machine and I can't seem to figure out how to get the database loaded.
If anyone has any experience or installation instructions, I would appreciate your help....
Regards,
Fred Schnittke
Install the appropriate Ubuntu Server operating system. If want a GUI you can do this with ubuntu desktop and then install all the dependencies as described. This setup has been tested on Ubuntu 9.10 but should work at least on 8.10 or more recent. If you are installing the server edition install mysql, tomcat6, LAMP stack and printer server when prompted during the installation process.
From a command prompt install the following packages and their dependancies if they are not already installed:
sudo apt-get install mysql-server phpmyadmin tomcat6 tomcat6-admin libmysql-java
sudo nano /etc/php5/apache2/php.ini
Increase upload_max_filesize from 2M to 20M
This will allow you to import the database using phpmyadmin
sudo ln -s /usr/share/java/mysql-connector* /usr/share/tomcat6/lib/
sudo nano /etc/default/tomcat6
sudo nano /etc/tomcat6/tomcat-users.xml
sudo /etc/init.d/apache2 restart
sudo /etc/init.d/tomcat6 restart
Note: if you get the message "Could not reliably determine the server’s fully qualified domain name, using 127.0.1.1 for ServerName" starting Apache, then you need to edit /etc/apache2/httpd.conf (which will initially be empty) to contain the one line
ServerName localhost
Then restart apache and the error should not appear.
Firstly, need to get the IP address of your server? Use the ifconfig command.
OpenVPMS installation instructions to follow
Ubuntu mucks up the path for the log files to be written so by default it is trying to right them in the root directory and gets permission denied so you don't get any output.
To fix it correct the path in the log4.properties file in your OpenVPMS install:
sudo nano /var/lib/tomcat6/webapps/openvpms/WEB-INF/classes/log4j.properties
Change log4j.appender.fileout.File=openvpms.log to log4j.appender.fileout.File=/var/lib/tomcat6/webapps/openvpms.log
and
Change log4j.appender.fullout.File=openvpms-full.log to log4j.appender.fullout.File=/var/lib/tomcat6/webapps/openvpms-full.log
Now save your changes and restart tomcat and your log files should now be there.
It's taken me forever to figure out to get this going so now that I've found it out here's the solution (thanks to this post: http://code.google.com/p/openmeetings/wiki/OpenOfficeConverter#Starting_OO_in_headless_with_Version_OpenOffice_3.0_++)
First of all install the headless openoffice from the repositories:
sudo apt-get install openoffice.org-headless openoffice.org-writer openoffice.org-draw
The 2 latter packages are required or you will get an error message: This url is not supported
Now you need to create a script to start it as a service:
sudo nano /etc/init.d/openoffice.sh
Paste the following code into that file:
#!/bin/bash
# openoffice.org headless server script
#
# chkconfig: 2345 80 30
# description: headless openoffice server script
# processname: openoffice
#
# Author: Vic Vijayakumar
# Modified by Federico Ch. Tomasczik
#
OOo_HOME=/usr/bin
SOFFICE_PATH=$OOo_HOME/soffice
PIDFILE=/var/run/openoffice-server.pidset -e
case "$1" in
start)
if [ -f $PIDFILE ]; then
echo "OpenOffice headless server has already started."
sleep 5
exit
fi
echo "Starting OpenOffice headless server"
$SOFFICE_PATH -headless -nologo -nofirststartwizard -accept="socket,host=127.0.0.1,port=8100;urp" & > /dev/null 2>&1
touch $PIDFILE
;;
stop)
if [ -f $PIDFILE ]; then
echo "Stopping OpenOffice headless server."
killall -9 soffice && killall -9 soffice.bin
rm -f $PIDFILE
exit
fi
echo "Openoffice headless server is not running."
exit
;;
*)
echo "Usage: $0 {start|stop}"
exit 1
esac
exit 0
Exit the nano text editor saving the file as you do.
Now make the script executable:
sudo chmod 0755 /etc/init.d/openoffice.sh
Make it start automatically on reboot by executing this command:
sudo update-rc.d openoffice.sh defaults
Now start the service by running
sudo /etc/init.d/openoffice.sh start
Now all should be good!
This guide describes how to install OpenVPMS on your veterinary clinic.
The guide is intentionally brief and describes the most typical installation for OpenVPMS. After completing the installation, you will be ready to start using OpenVPMS for your veterinary clinic.
OpenVPMS will run on most standard Sun JavaEE environments with an additional component of OpenOffice (used for document generation). You will need to make sure your einvornment includes:
We have tested the following Sun JavaEE environments
Note: Sun JavaEE applications like OpenVPMS can run on many different type of operating systems like Microsoft Windows, Mac OS X, Linux and more!
If you need help installing the prerequiste software, please see the Install Guide for those products.
To perform the installation you will need to download and unpack the OpenVPMS installation files.
Download the latest installation archive from: http://www.openvpms.org/download
After downloading, unpack the ZIP file in a directory - <openvpms_tmp>.
Configures the database to store data using UTF8 (to support english and double-byte characters like Chinese). By default, mysql uses latin1 instead of UTF8 to store data. You need to add a configuration setting into your database so that the server and client does everything by UTF8.
MySQL Configuration - Linux (my.cnf) or Windows (my.ini): [mysqld] character-set-server=utf8 default-collation=utf8_unicode_ci [client] default-character-set=utf8
This populates the database with the database structure.
Linux/Windows: cd <openvpms_tmp> cd db mysql -u root -p mysql> drop database openvpms; mysql> source createdb.sql; mysql> use openvpms; mysql> source db.sql; mysql> quit;
Note: This will create a database "openvpms" with username of "openvpms" and password of "openvpms".
This will load the database with the initial data needed for the application. It will setup a one vet veterinary clinic in Australia.
Linux: cd <openvpms_tmp> cd bin ./dataload.sh setup Windows: cd <openvpms_tmp> cd bin dataload.sh setup
Note: This will create an administrator user account with username of "admin" and password of "admin". Retain this information for later when we first login to the system.
JasperSoft needs to be configured to run in a headless mode for it to generate reports like invoices.
Linux with IBM WebSphere Application Server Community Edition: export GERONIMO_OPTS=-Djava.awt.headless=true Linux with Apache Tomcat: export CATALINA_OPTS=-Djava.awt.headless=true
Note: Suggested to put environmental settings in your shell startup so that you do not need to execute the command at each time before Java Application Server startup.
OpenVPMS uses OpenOffice for form generation. As a result, we have to run OpenOffice in a headless mode so that when we generate form slike vaccinations certificates.
Linux: soffice.bin -headless -nofirststartwizard -accept="socket,port=8100;urp;" &
Note for Linux: It may help that you add soffice.bin in your path and make the OpenOffice daemon a startup service.
OpenVPMS has the ability to automatically import customer and patient records and patient investigations into the system. This daemon uses the automatic scheduling utility ("at" in Microsoft Windows or "cron" in Linux) provided by the operating system.
Linux/Windows: mkdir <openvpms-tmp>/docimport <openvpms-tmp>/docarchive
Within your automatic scheduling utility, set the OpenVPMS document import daemon to run.
Linux: echo "cd <openvpms-tmp>/bin/" > /etc/cron.hourly/openvpms-docimport.sh echo "./docload.sh --byid --source <openvpms-tmp>/docimport --dest <openvpms-tmp>/docarchive --verbose" >> /etc/cron.hourly/openvpms-docimport.sh chmod 755 /etc/cron.hourly/openvpms-docimport.sh
A database type 4 driver is used to connect the Java Application Server to the database.
Download and copy the mySQL connector/j jar file to <java_home>/jre/lib/ext. This will allow you to skip manually modifying your Java classpath.
Follow the startup instructions in your Java Application Server.
Follow the instructions in your Java Application Server to install WARs.
Follow the instructions in your Java Application Server to start WARs.
You're almost done. You'll need to setup Scheduling and Work List and once you're done, you'll have a fully working veterinary practice management software system.
By default, the application would be available at http://localhost:8080/openvpms/. Use the username of "admin" and password of "admin" to first login to the system.
Navigate to "Administration" -> "Organization". Modify the "Main Appointment Schedule" and "Main Surgery Schedule" with start and end hours. Create a new "Schedule View" called "Schedule View". Add the "Main Appointment Schedule" and "Main Surgery Schedule". Click "Ok". Navigate back to "Administration" -> "Organization" and find "Main Clinic". Edit the "Main Clinic" and in the "Scheduling Views", add the "Schedule View" you just created. Save, logout and then re-login and you should be able to navigate to "Scheduling" and be able to add, modify and remove appointments.
Navigate to "Administration" -> "Organization". Create a new "Work List View" called "Work List View". Add the "Main Hospital List" and "Main WaitingList". Click "Ok". Navigate back to "Administration" -> "Organization" and find "Main Clinic". Edit the "Main Clinic" and in the "Work List Views", add the "Work List View" you just created. Save, logout and then re-login and you should be able to navigate to "Work List" and be able to add, modify and remove customers/clients on and off lists.
Note: Stock/Inventory Management module is not enabled by default.
Your veterinary practice management software is now installed!
From this point, here are some other things you might need to customize before "production" use.
Download the latest OpenVPMS Installation files. Create a folder within your home folder to unzip the release into.
The following assumes a user named user: Move the package to ~/user/openvpms and unzip the Installation Pack. This should create a ~/user/openvpmsopenvpms-release-x.x.x folder with the necessary files to install OpenVPMS.
Installing MAMP provides a really easy way to configure and run MySQL. Download from http://www.mamp.info/en/downloads/
The free MAMP is fine, you don't need the paid pro version.
Download tar.gz core binary distribution of Apache Tomcat version 6 from http://tomcat.apache.org/download-60.cgi
Unpack it and then move it to your home directory so it will be in ~/user/apache-tomcat-6.x.x/lib/
Download the connector/J which is needed to connect openvpms to the database. You then extract it and copy the mysql-connector-java-x.x.x-bin.jar to:
Download libreoffice and install it
open a terminal window and edit your .profile file eg. type:
nano .profile
add the following to your .profile file
export JAVA_HOME=/Library/Java/Home export CATALINA_HOME=/users/user/apache-tomcat-6.0.35 export PATH=/Applications/LibreOffice.app/Contents/MacOS:$PATH
Start the mysql database using mamp. Using phpmyadmin (installed with mamp) go the import tab and navigate to ~/user/openvpmsopenvpms-release-x.x.x/db/createdb.sql
Import it and then navigate to ~/user/openvpmsopenvpms-release-x.x.x/db/db.sql and import it as well.
Now in a terminal window cd to ~/user/openvpmsopenvpms-release-x.x.x/bin
run the setup by typing
./dataload.sh setup
Copy the openvpms.war from ~/user/openvpmsopenvpms-release-x.x.x/webapps/ to ~/user/apache-tomcat-6.x.x/webapps/
Hopefully now you are ready to go. I installed this a long time ago so to the best of my knowledge I haven't missed any necessary configuration. To start and stop tomcat cd to ~/user/apache-tomcat-6.x.x/bin and then run
./startup.sh
or
./shutdown.sh
using the terminal
Once it starts up you should be able to access openvpms at http://localhost:8080/openvpms/app