Install Guide

Hardware/OS

Minimum spec for one combined server is as follows:

• CPU: 2 GHz single-core Intel or AMD opteron Dual core 2 GHz 64 bit
• Disk space: 10 GB
• Memory: 2 GB
• OS: Windows, 2003/XP/Vista or Linux (Kernel 2.6 or later)

For simplicity, this guide will cover installing FOXOpen by using an example of a single server on Windows XP/Vista.

Software

Before installing FOXOpen, make sure the following components are installed in the following order and working:

1. Oracle Server 10g: Oracle Express can be downloaded from here. Install and create a database with two users SYS and SYSTEM. Note down the passwords that you enter for them.
   
2. Java Virtual Machine: Go here and click on the "Do I have Java?" link. If it says 'Congratulations', click on the "Test your Java Virtual Machine" link. This test must succeed to enable Tomcat to run successfully. If you do not have Java installed, download and install it, then run the above checks again to confirm.
   
3. Tomcat: Available from here (note we have tested on 5.5 so that is recommended). While installing, on the Configuration page, set the Port to 8888. Alternatively you can edit server.xml and changing the following line

Database build

From the command line:

• Ensure Oracle commands sqlplus and imp work from the command line (hint: set oracle home, path and oracle_sid)
  • set ORACLE_HOME to C:\oraclexe\app\product\oracle\10.2.0\server or similar
  • set PATH to ORACLE_HOME\bin
  • set ORACLE_SID to 'XE'
• Change directory to the foxopen_source directory (above)
• Edit FOXMGR_DATA_RESOURCE_MASTER.SQL and replace the host kirribilli with the hostname of your server. Note do not use localhost as you hostname, create a new hostname entry if required. [NB. To find your machine's hostname, type hostname on the command line].
• Run the install:
  
  From windows:
  

  >foxopen_build_All.bat
  

  
  From Linux
  

  $ . ./foxopen_build_All.sh
  

  
  Enter the sys password when prompted (3 times)
  

• Check the .log files for errors (Note: ignore any already exists errors as some definitions are executed twice to resolve dependencies).
• If the build is successful then the only invalid objects in the final report should be some synonyms (we will get rid of these one day).
  
  

War build

Note you can skip this step and use the supplied war file for most environments

• Add the file “xmltask-v1.15.1.jar” to lib directory under ANT_HOME, e.g. D:\ant\apache-ant-1.7.1\lib
• Create new directory 'C:\pvcswork\Libraries\XML\ApacheXerces' (remove the space between Apache & Xerces)
• Create new directory ‘FOXxerces2.7.1’ under “ApacheXerces”
• Copy jar files xercesImpl.jar and xml-apis.jar into the directory
• To minimise the setup time, create directory “C:/workspace/foxdemo” (optional)
• Unzip foxopen.zip in the directory created above.
• Go to the directory “foxopen”
• Update the “build.properties” to match the build/deploy environment of choice(very important!).
• Execute the script by entering “ant” in the command line (assumed $ANT_HOME/bin is in the PATH). This will execute the default target – “build-distribution”.
  
  

Note: The ant script will update the web host and oracle host in the FOXBoot.xml with the information provided in the build.properties. There is no need to handcraft the FOXBoot.xml yourself.

War install (Tomcat)

Ensure the database and Tomcat are up and running.

• Copy the 3 libraries from the c:\foxopen_source\endorsed directory to Tomcat "endorsed" directory.
  Note this may depend on how your jdk is setup and could be in jdk\jre\lib\endorsed
  or C:\Program Files\Apache Software Foundation\Tomcat 5.5\common\endorsed) for V5 Tomcat
  or Create endorsed directory for V6 Tomcat
  
• Copy xmlparserv2.jar from the c:\foxopen_source\lib directory to your Tomcat lib directory (e.g. to C:\Program Files\Apache Software Foundation\Tomcat 5.5\common\lib)
• Copy c:\foxopen_source\foxopen.war to the webapps directory (e.g. to C:\Program Files\Apache Software Foundation\Tomcat 5.5\webapps)
• Check that Tomcat unpacks the war file to webapps\foxopen
• Shutdown Tomcat
• Edit webapps\foxopen\WEB-INF\FoxBoot.xml and replace the host kirribilli and the IP address with the hostname and IP address of your server
• Startup Tomcat
• Test FOXOpen by entering the following URL
  http://<yourserver>:8888/foxopen/fox/foxopen/
  
  If you can see the FOXOpen logo, then you have successfully installed FOXOpen!
  
• NB if you get an error message like unable to find xalan or parse xml, re-check the endorsed and lib directory files.

War install (IBM WebSphere 7.0.0.9)

Ensure the database and WebSphere are up and running.

• Copy the 3 libraries from the .../foxopen_source/endorsed directory to .../WebSphere/AppServer/java/jre/lib
• Go to the Integrated Solutions Console and log in (http://server-location:9043/ibm/console/login.do)
• Expand the Applications section on the left hand menu and click on New Application to choose a new Enterprise Application
• Browse to the WAR file location either locally or remotely (e.g. .../foxopen_source/foxopen.war)
• Click next to get to the configuration options choosing the default selected Fast Path
• Click next to keep the defaults on the first stage
• Check the select box for the war in steps 2 and 3
• Set the context root to whatever it should be (e.g. /englive) Note that the preceding slash is required! on Stage 4
• Click finish to install the application and click save when the link appears
• Go to the Applications section on the left hand menu, expand Application Types to click on WebSphere enterprise application
• Select the application you created and click start if isn't running already

To alter the memory limits in WebSphere 7:

• You might want to alter memory limits, click on Servers, then Application Servers on the left hand side
• Select the server to see its configuration options
• On the right in Server Infrastructure which has an expandable Java and Process Management section with a Process Definition sub-section
• In the Processes Definition page, on the right, is a link to Java Virtual Machine properties
• In the JVM properties page are a couple of boxes for heap size

Unzip the foxopen_demo.zip into the ROOT folder of your Apache webapps folder.

This documentation will be available at:

This shows simple examples of different aspects of FoxOpen coding in a menu on the left. Clicking on each option displays an explanation of how the code works, the XML required, and a mini-demo.

Clicking on the Documentation link at the top takes you to the Fox Worksheets Index. This is a detailed step-by-step training course for Fox, which takes you from the basics all the way to creating a Search screen. [Hint: You will need to use some XML files from the foxopen_demo.zip]

There is a demo application available at:

This should display a Login page.

Valid Users and passwords (with different user profiles) are :

chrisc / foxopen
benb / foxopen
dthompson / foxopen

This is a demo Trading application with examples of a variety of screens created using FoxOpen.

FOXAdmin allows developer/system admin to manage the FOXOpen configurable resources in one place. FOXAdmin currently supports configuration of two key FOXOpen resources, namely, FoxBoot.xml (resides in foxopen.war) and MasterResource (resides in the database).

War install

Download and expand FoxOpen-bin-x-xx-xx.zip

Copy foxadmin.war to the Tomcat "webapps" directory

Access URL: "http://<yourserver>:8080/foxadmin"

War Build from sources

Note you can skip this step and use the supplied war file for most environments

*Note the sources to this new component are being bundled up in the next Beta4 release*

Required software:

1. JDK1.5 or above
2. Tomcat6.x
3. Apache Ant 1.7.1 or above
   

Environment Parameters:

1. Ensure JAVA_HOME is set to the right version of JDK.
2. Ensure ANT_HOME is set to the right version of ANT and $ANT_HOME/bin is in the $PATH.
   
   

Setup instructions:

1. Download and expand the foxadmin source zip file.
2. Go to the "foxadmin/trunk" directory, update the "build.properties" to match build/deploy of choice.
3. To build the distribution artifacts, use the default ANT target. The built artifacts will be placed to the "foxadmin/trunk/build/dist" directory.
4. Copy foxadmin.war from the "foxadmin/trunk/build/dist" directory to the Tomcat "webapps" directory.
5. Access URL: "http://<yourserver>:8080/foxadmin"
   

Note: Prior to running FOXOpen, it is a good idea to run FOXAdmin to ensure FOXOpen resources have been setup correctly in your environment.