Introduction
Antelope is a sample application using the Zebra workflow
engine.
It is based on
- Turbine 2.4-Dev
- Hibernate
- Zebra
This application is designed to be used in a development
environment using Eclipse and Maven - it is possible to run and
use this without these but no instructions are provided.
To use
The Headline steps for each item see below for details
- Install software
- Run maven in the antelope folder
- Open the antelope project
- Start tomcat
It should work!
any problems please post to the Zebra Users mailing list http://zebra.tigris.org/servlets/ProjectMailingListList
Install software
Maven should be installed using the installer available from
apache. If you are on unix unzip it, and put maven in the
path. You will need to have Java set up in the path for it
to work
You need to install a Java SDK (not just JRE) Sun have
instructions on this.
Eclipse comes as a zip file, simply get the right zip for
your platform and unzip it. There will be an 'eclipse'
executable in the eclipse folder of the zip.
Install Tomcat using the installer.
Install the sysdeo tomcat plugin by copying it to the
eclipse/plugins folder and restarting eclipse. Once
installed in Window Preferences you must tell eclipse where
you installed tomcat. There is a bug in eclipse M8 that
preferences do not always apply in the tomcat plugin unless
you click both the apply and ok buttons.
Right click on one of the menus and choose customise
perspective. On the commands tab enable the tomcat menus.
(You will need to do this for each Eclipse perspective you
use)
Run maven in the antelope folder
It is recommended to put maven in your path - as it makes it
easier to use.
Change to the folder antelope is in and run
maven antelope:setup-webapp
You will see various Maven related messages and it will
download the jars Antelope needs and setup the /src/webapp directory.
Some jars will fail. Due to licensing issues (they are not
redistributable on their own) they are not on the central
maven sites. Instead you should copy them from the antelope
folder to the maven repository
Your local maven repository will have been created at
HOME_DIRECTORY/.maven/repository
On Windows XP you home directory will be c:\Documents and
Settings\USERNAME
On Linux it will be /home/USERNAME
Copy the contents of ANTELOPE/MavenRepo to your local maven
repo run maven eclipse again. It should succeed.
In Eclipse Windows -> Preferences -> Java -> Build Path
->Classpath Variables Add a variable called MAVEN_REPO
pointing to the folder holding your local maven
repository
By default the project runs using HsqlDB running in
standalone mode. For production it is suggested you change
the hibernate configuration files to point to a slighly
more production database such as Postgresql, Oracle
etc...
To use the database start hsql using startHsql.bat or
startHsql.sh in the bin folder. Note, you may need to edit the paths
in these startup scripts. Then run
maven antelope:setup-database
This will create the database and generate some
sample data. If you change or add hibernate
classes you will need to rerun this to regenerate the database.
Open the antelope project
In eclipse use File -> Import to open the project you have
downloaded.
It should build immediately without any errors.
Start tomcat
Right click the project name and verify you have Tomcat Project
menu option. If you don't, then click properties, and choose
Tomcat option. Click "Is a Tomcat Project" and set the context to
"/antelope". Then mark can update server.xml. Lastly, set the
webapp root to "/src/webapp"
Next we need to register the project with Tomcat by right
clicking on the project name choosing Tomcat Project and
clicking on Update Context in server.xml
From the Tomcat menu choose start. It should start.
Go to http://localhost:TOMCATPORT/antelope Use antelope and
test as the username/password.
Note: These directions assume you already have Tomcat installed and the
Sysdeo Tomcat plugin referencing the installation.
Troubleshooting
Q: Why does eclipse copy some files to a network drive and store
some locally in Windows XP
A: This is because you have pinned the eclipse.exe to the start
menu. Doing this sets the working folder as your home drive.
Instead remove the eclipse.exe from the start menu. Create a
shortcut to it and pin the shortcut to the start menu.