Home > Installation

Install Note for Tomcat (Version 5.0.* or 5.5.*)

Warnings

  • This chapter describes a quick installation example of EBX.Platform on Tomcat Application Server.

  • It does not replace the documentation of this application server.

  • It is not a general installation recommendation, since current installation process is fixed by architecture choices (technical environment, applications mutualization, delivery process, company choices, etc.).

  • The complete description of the components needed by EBX.Platform is given in chapter Components. 

  • In order to avoid unpredictable behavior, the minimal rule to follow is to avoid any duplication of ebx.jar or other libraries on the class-loading system.

  • The description below uses the variable name $CATALINA_HOME to refer to the directory into which you have installed Tomcat 5, and from which most relative paths are resolved. However, if you have configured Tomcat 5 for multiple instances by setting a CATALINA_BASE directory, you should use $CATALINA_BASE instead of $CATALINA_HOME for each of these references.

Installation Example Overview

  • Create EBX_HOME directory: copy ebx.properties

  • Install EBX.Platform libraries: add libraries ( jar files ) to tomcat shared lib directory

  • Configure JVM arguments (Java system properties): create the JAVA_OPTS environment variable

  • Deploy EBX.Platform application: copy all war files to tomcat webapps directory

Installation Example Detail

  1. Create EBX_HOME directory, for example C:\EBX\home, or /home/ebx.

  2. Copy ebx.software\files\ebx.properties file to EBX_HOME. In our example, we will then have the following file:

    C:\EBX\home\ebx.properties, a text file

  3. Copy ebx.jar to $CATALINA_HOME\shared\lib\ (or $CATALINA_BASE\shared\lib\) directory. The file ebx.jar is provided in the directory ebx.software\lib\. In our example, we will have:

    $CATALINA_HOME\shared\lib\ebx.jar

  4. Copy third-party library files to $CATALINA_HOME\shared\lib\ (or $CATALINA_BASE\shared\lib\) directory. In our example, we will have:

    $CATALINA_HOME\shared\lib\activation.jar

    $CATALINA_HOME\shared\lib\mail.jar

    $CATALINA_HOME\shared\lib\hsqldb.jar

    The exact description of these components is given in chapter Components. Obviously, if those components are already deployed on the class-loading system, they don't have to be duplicated.

  5. Copy the war files in ebx.software\webapps\wars-packaging to the $CATALINA_HOME\webapps\ (or $CATALINA_BASE\webapps\) directory. In our example, we will have:

    $CATALINA_HOME\webapps\ebx.war: Initialization servlet for EBX.Platform applications

    $CATALINA_HOME\webapps\ebx-root-1.0.war: Provides a common default configuration for adaptation models and adaptations

    $CATALINA_HOME\webapps\ebx-manager-1.0.war: Master Data Management Web application

  6. Modify $CATALINA_HOME\conf\server.xml (or $CATALINA_BASE\conf\server.xml) file. Add the following line to the <Host> element.

    <Context path="/ebx" crossContext="true" docBase="ebx.war"/>

    After this modification, we will have:

    <Host name=...>

    ... ...

    <Context path="/ebx" crossContext="true" docBase="ebx.war"/>

    ... ...

    </Host>

  7. Configure launch properties.

    If our tomcat is launched by a command in Windows' DOS console or Unix shell, we can create another launcher file:

    In Windows, the launcher file can be start_ebx.bat, which will have the following command lines:

    set EBX_HOME=<path_to_the_directory_ebx_home>

    set JAVA_OPTS=-Debx.home=%EBX_HOME% -Debx.properties=%EBX_HOME%\ebx.properties

    call %CATALINA_HOME%\bin\startup.bat

    In Unix, the launcher file can be start_ebx.sh, which will have the following command lines:

    export EBX_HOME=<path_to_the_directory_ebx_home>

    export JAVA_OPTS="$JAVA_OPTS -Debx.properties=$EBX_HOME/ebx.properties -Debx.home=$EBX_HOME"

    exec $CATALINA_HOME/bin/startup.sh

    (!) Accounts used to launch EBX.Platform must have create/update/delete rights on $EBX_HOME directory.

    Windows users that have installed Tomcat as a service may set Java options through the Tomcat service manager GUI (Java tab).

    Be sure to set options on separate lines in the Java Options field of the GUI. e.g.:

    -Debx.home=<path_to_the_directory_ebx_home>
    -Debx.properties=<path_to_the_directory_ebx_home>\ebx.properties

    where <path_to_the_directory_ebx_home> is the directory where we copied ebx.properties. In our example, it is C:\EBX\home.

  8. Run EBX.Platform.

    After Tomcat launch, run EBX.Manager Web application: http://localhost:8080/ebx/. 

    At first launch, EBX.Platform Wizard helps you to configure the default properties of your initial repository.

 

Home > Installation