Ace Operator Source Distribution

At this point, this web site has only limited information about Ace Operator source code, its design and architecture. We will be placing more and more information in the coming weeks and months. Please visit again soon for additional information.

Ace Operator is available in two distributions: source and binary. If you want to simply install and run operator, download the Ace Operator binary distribution by clicking here.

If you are a developer and you want to look at the source code or make modifications to the source code, or contribute the development of Ace Operator, please read the downloading and installation instructions below. Note that Ace Operator contains third-party software libraries and binary packages. Please make sure that you understand and accept the terms and conditions of the licenses. Click here to read the license agreements.

Ace Operator is written entirely in the Java programming language. In addition to Java, there are a number of shell scripts (in the form of sh or bat files) that are used to start/stop Ace Operator. It also contains shell scripts to build and manage the Ace Operator source code. The run-time requires the following third-party packages:

• Java run-time environment from Sun Microsystems*.
• Tomcat servlet container from Apache (included with Ace Operator binary download only).
• MySQL database from MySQL AB*.

*See system requirements for details on pre-requisite Java and MySQL software needed to run Ace Operator.

See below for details on Tomcat requirements.

The source distribution is packaged in one file:

• ace.tar.gz
  This file contains the Ace Operator source code and libraries from 3rd party vendors. Download the file by clicking here. On some browsers you may need to press the shift key, then click.

Installing the Source Code

Download the above file. To extract the file in the Linux environment, enter the following command:

$ tar xvzf ace.tar.gz

The above command will create the directory ace under the current working directory.

On the Windows environment, use the zip file extraction tool included with the operating system or use third-party tools like WINZIP (http://www.winzip.com). Extract the file and it will create the folder ace where you extracted the file.

The Source Directory Tree

The ace directory contains various sub-directories. The important directories are listed below. Note that we have used "/" as the path delimiter. Windows users use "\" instead.

• src : Contains the source code
• sh : Contains shell scripts to build and maintain the package
• data/local : Contains the configuration data organized into XML configuration files.
• data/global/www : Contains the web page content (webapp).
• sql contains the SQL statements required to setup the database and other database utilities.

Building Binary Packages from the Source

We have provided two shell scripts for building the source code into binary packages - one for the Linux environment, and the other for the Windows environment. Unfortunately, the build scripts only run on the Linux environment. We are planning to provide a Windows version of the script that builds the Windows binary. In the meantime, you will need a Linux system to perform the binary builds for Linux as well as for Windows.

In order to build the binary package from source, you will need some additional packages that are required to perform the build. They are:

• RPM: This tool is required for building the Linux package. Most Linux distributions include the RPM tool. If your system does not have the tool, you can download it from http://www.rpm.org.
• Java 2 SDK: The Java 2 SDK is required to compile and build the Java sources. You can download the SDK from http://www.javasoft.com. Please download and use J2SDK 1.4.
• Ant: The Ant tool is required to perform builds. You can download a binary version of Ant from http://ant.apache.org.
• Tomcat: Tomcat 4.1.x (the later the better) from Apache is required to perform builds. You can download a binary version of Tomcat from http://jakarta.apache.org/tomcat.

Follow the installation instructions for installing the above tools as specified in the web pages for these tools.

To start the build, you need to specify these environment variables:

• ACE_HOME : Set this variable to specify the  location of the ace directory.
• JAVA_HOME : Set this variable to specify the location where Java is installed.
• JAVA3_HOME:  Set this variable to specify the location where Java is installed.
• ANT_HOME : Set this variable to specify the location where Ant is installed.
• TOMCAT_HOME: Set this variable to specify the location where Tomcat is installed..

You can setup the environment variables by using either the setenv command or the export command. For example:

$ export JAVA_HOME=/usr/java/j2sdk1.4.2_03

Your home directory must have at least 150MB of free disk space in order to perform the build.

To run the shell scripts, enter the following commands from a shell (terminal):

$ cd $ACE_HOME/sh
$  ./build_rpm.sh       # to build the Linux binary RPM
$ ./build_windows.sh    # to build the Windows binary ZIP.

The binaries will be placed in your home directory. The binary names are quikj-ace-$version.i386.rpm (linux) and quikj-ace-$version-win.zip (Windows) where $version is the Ace Operator release version number.

The documentation provided with Ace Operator (ace_operator_system_manual.pdf) explains how to install the binary and setup the system.

Search this website 

Send questions or comments about this web site to webmaster@quik-j.com.
Copyright © 2005, QUIK Computing, Inc..

Top of page