Step by Step Installation

From OSPDocs

Jump to: navigation, search

Contents

Help us fill out this path

This install path described is rather limited. We are prescribing a particular set of tools (Tortoise, Eclipse, etc.) all along the path because it is what we use. If you use a different set of tools, please feel free to add how to use them below.

STEP 1 - Prerequisites for Installing the OSP

  • Java >= at least v1.5 aka v5.0 (implementers can use the JRE, developers need the JDK) jdk6
  • MySQL 5.x (We have also found the MySQL GUI Tools very useful.)
  • Tomcat >= at least v5.5 or v6.x
  • The Eclipse IDE (the ones for Java Developers, Java EE Developers or Eclipse Classic should all work fine.)
  • A Subversion client:TortoiseSVN

STEP 2 - Retrieve a Copy of the Source Code

  1. In a file browser window, go to your webapps directory
  2. Create a directory named 'usip_osp'
  3. Right click on the directory you just created and select Tortoise SVN --> SVN Checkout ...
  4. Enter one of the two paths discussed below.
    1. If you contacted us, and became a project member, enter URL as https://opensimplatform.googlecode.com/svn/trunk/, then click OK
    2. If you just want to download a copy and try it out, enter the URL as http://opensimplatform.googlecode.com/svn/trunk/, then click OK
Below is an image of what checking the code out using Tortoise will look like:
Tortoise checkout.PNG

STEP 3 - Create your USIP_OSP_Properties_en_US.properties file

  1. Open a text editor (i.e. Notepad - click Start > Programs > Accessories > Notepad)
  2. Copy-and-paste the template Properties (USIP_OSP_Properties_en_US.properties.template) file from the directory usip_osp/WEB-INF/classes
  3. Save file to USIP_OSP_Properties_en_US.properties
  4. Modify the properties to match the file locations and MySQL data that is appropriate for your platform.

STEP 4 - Build the Code

  • Start Eclipse.exe
  • In the project window (on the left hand side in the Eclipse Java perspective) right click to create a new project.
  • Select 'Java Project' and fill out the form similarly to the image shown below. (Note closely what is selected in the two red dots.)

Install Eclipse1.png

  • Click Next and then select the libraries to install.
  • Install all of the libraries found in the classes/lib and classes/libraries directories.
  • Select Project --> Clean and the entire project should build. (The class files will be located in the same directories as the .java files.)


STEP 5 - Create Your Database Schema

Assumptions and Dependencies:

   * MySQL is running as a service
  • Create the 'root' schema that will hold information regarding all of the schemas you will install and users that will be registered. (BTW, the default 'root' schema name in the properties file is usip_osp.)
  • Create at least one organization database. This database will house all of the information regarding simulations.


STEP 6 - Deploy the OSP and Fill Your Databases

Assumptions and Dependencies:

   * Ensure that Tomcat is running