JRaceman is a meet/race/regatta manager written in Java and distributed under the GPL.
Go to the JRaceman home page to download the latest version of JRaceman.
The Tutorial Wizard, available from the Help menu, walks you through the basic of using JRaceman.
The Users Guide gives an overview of how the program is used and details about specific parts of the program.
The javadoc-generated API Reference provides detailed documentation on the packages and classes used in JRaceman (available after you have unpacked the source).
|Processor||500 MHz||Starting JRaceman will take about one minute on a 500MHz processor. Faster processors will of course give better results.|
|Memory||128 MB||Graphical Java programs tend to use a lot of memory. With anything less than 128MB, your computer will run considerably slower due to swapping. 256MB or more is recommended.|
plus up to 250 MB
to install Java
|If you already have Java installed, installing JRaceman will take about 10MB, and creating the database will take about 5MB. Larger databases will require more space. Installing Java takes 100MB or more, depending on which version you install, and whether or not you install the documentation.|
|Java||JRE 1.5||JRaceman uses Swing and other features of Java which are not supported in earlier versions of JRE than 1.2. JRaceman versions 0.3.0 and later use features in JRE 1.4. Proper support for Style Sheets in reports in version 1.0.0 and later requires JRE 1.5. The web interface in JRaceman versions 1.0.0 and later requires JRE 1.5 in order to compile against and use the Java Server Faces library.|
|Windows, MacOS, Linux,
or any other OS that
supports Java 1.5
|For a list of platforms on which Java is available, visit Sun's Java Platform Ports page.|
To install Java on your system, download JRE 5.0 from Sun's Java web site and follow those installation directions. When you are at that download page, look for the section labeled Jave Runtime Environment (JRE) 5.0 Update 12 (or possibly 13 or later) and click on the Download button. Accept the License Agreement, find the download appropriate for your computer, and click on that link. If the installer does not automatically start, execute the downloaded program by double-clicking on it.
JRaceman is delivered in a self-extracting JAR file. You must have Java running on your system (see previous section) in order to extract and install JRaceman.
NOTE: If you are upgrading to a newer version of JRaceman, be sure to back up your database before installing the newer version, in case there are database format changes. In particular, you should create an export file from your database which can be used to import your data into a new database if required. See the section below on Upgrading JRaceman for details.
To install JRaceman from the installation JAR file (.jar extension), double-click on the JAR file, or run the command
This will open a dialog allowing you to specify a destination directory, and it will create a directory called jraceman-N_N_N in the specified directory, where N_N_N is replaced by the JRaceman version number.
java -jar jraceman-N_N_N.jar
If you are running on Windows and double-clicking on the JRaceman jar file opens a file browser window or does nothing, you probably need to associate the jar file extension with Java. On Windows XP (from support.microsoft.com article 307859):
Always use the selected program to open this kind of filecheckbox.
If you have problems running the installer, you can try running it with the debugging flag turned on, which will cause it to print more information:
java -Djraceman.install.debug -jar jraceman-N_N_N.jar
If you double-click on the installer in Windows and nothing happens, open a DOS window, cd to the folder into which you downloaded the installer, and enter the java command shown above. Any error messages should now show up in the DOS window.
Unpacking the JRaceman Source
If you want to build JRaceman yourself, or just look at the source code,
you will have to unpack the source files from the
archive file with the commands
This will create a
srcdirectory with all of the Java files, as well as adding a few other files (such as a build.xml file) to your jraceman directory. You must have the ant program installed on your system in order to build JRaceman from source files.
If you want to look at the Javadoc-generated API documentation
for the Java classes, you must first unpack those html files from
apidoc.zip archive file with the commands
This will create the directory doc/api with all of the API documentation in it. Alternatively, you can unpack
src.zipand then run the command
to run javadoc and create the API documents from the source files (you must have the ant program installed on your system in order to create the documentation using this command).
If you want to look at the source to the JRaceman Users Guide,
or if you want to generate the PDF or HTML files yourself,
you must first unpack the xml source files for the Users Guide from
xml.zip archive file with the commands
This will create the directory xml with all of the source files for the JRaceman Users Guide.
The JRaceman kit does not include the source to the Mckoi database. You can download the Mckoi database source from the Mckoi web site, or from the same location from which you downloaded JRaceman. You do not need the Mckoi source to compile JRaceman; the mckoidb.jar file included in the JRaceman kit is sufficient.
The JRaceman kit does not include the source to the jRegistryKey package. You can download the jRegistryKey source from the jRegistryKey web site, or from the same location from which you downloaded JRaceman. You do not need the jRegistryKey source to compile JRaceman; the jRegisgtryKey.jar file included in the JRaceman kit is sufficient.
The JRaceman kit does not include the source to the JShortcut package. You can download the JShortcut source from the JShortcut web site, or from the same location from which you downloaded JRaceman. You do not need the JShortcut source to compile JRaceman; the JShortcut.jar file included in the JRaceman kit is sufficient.
The JRaceman kit does not include the source to the JXL Excel spreadsheet reader. You can download the JXL source from the JXL web site, or from the same location from which you downloaded JRaceman. You do not need the JXL source to compile JRaceman; the jxl.jar file included in the JRaceman kit is sufficient.
The JRaceman kit does not include the source to JSF, the servlet or jsp APIs, or the commons file uploade package, all of which are used in the web registration interface.
If you have not already done so, you must install Java.
On Windows, double-click on the shortcut set up by the installer, or CD to the main JRaceman directory and run
If you told the installer not to create a shortcut, you can manually set up a shortcut to jraceman.jar in the main JRaceman directory, with the Start-In directory of the shortcut set to the JRaceman directory.
java -jar jraceman.jar
If the java binary is not in your PATH, you can explicitly specify the path to it. For example, if you have installed JDK1.5.0 into
java -jar jraceman.jar
/usr/local/jdk1.5.0, you can run jraceman with the command
/usr/local/jdk1.5.0/bin/java -jar jraceman.jar
On Solaris 2.6 or later, you can directly run jraceman.jar.
When you install a newer version of JRaceman, you may need to upgrade your database. Starting with v0.3.10, JRaceman attempts to automatically determine if you need to upgrade your database, and opens a dialog offering to do so when needed. However, this may not work if your database is too old.
With an older database, you may receive a message something like this:
The state store for this database doesn't exist. This means the database version is pre version 1.0. Please see the README for the details for converting this database.This message comes from the Mckoi database engine, and indicates that the Mckoi database format has changed. The README file referred to in that message is the Mckoi README file, which tells how to perform the Mckoi database upgrade. Rather than doing this, you should probably export from your old database and import into a newly created database.
For more information about upgrading, see the Upgrading section in the Users Guide.
Using the Web Registration Module
JRaceman includes an integrated web registration interface. This interface is implemented using JSF version 1.2 and was tested on Tomcat version 6.
In order to use this interface, you must have a web server with a web applet container that support JSP 2.0 (required by JSF 1.2), such as Tomcat version 6. A discussion of what this means and how to set it up is beyond the scope of this document.
Once you have an appropriate web container, download the WAR file from the same site from which you downloaded the JRaceman package. If you are adventurous, you can try building the war file yourself by unpacking the source and running "ant war".
After downloading the war file, rename it to "jraceman.war", or to some other .war name to be used on your web site. If you built your own war file from source, it will be named jraceman.war. Copy the war file into your container's webapp directory.
You will need to configure your JRaceman database to support the web registration webapp, which you can do by editing values in the Database/Options and Database/ContextOptions tabs. Until this is better documented in the Users Guide, you can look in the HISTORY file for references to WebRegistration or you can contact the author.
Once the above setup steps have been done, start the JRaceman database server on the same machine running the JRaceman webapp, then access the webapp from your browser using the URL that matches the name of your war file, or the name as you have configured that war file in your web server. You should see a JRaceman login page.
Bug Reports and Feedback
If you have a comment about JRaceman, or would like to report a bug, please send email to jraceman at the domain j.jimmc.org
Author and Contributors
JRaceman was written by Jim McBeath.
The Hungarian translation was contributed by Dr. Novotny László.