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: unzip ebx_home.zip
  • 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

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

    C:\EBX\home\schemas, a directory
    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 have unzipped ebx_home.zip. 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.

Note d'installation sur Tomcat (version 5.0.* ou 5.5.*)

Avertissements

  • Ce chapitre décrit un exemple d'installation rapide de EBX.Platform sur Tomcat Application Server.
  • Il ne remplace pas la documentation de ce serveur d'application.
  • Ce n'est pas une recommandation générale d'installation, puisque le processus réel d'installation est basé sur des choix d'architecture (environnement technique, mutualisation des applications, procédures de livraison, choix d'entreprise, etc.).
  • La description des composants requis et optionnels pour EBX.Platform est fournie dans le chapitre Composants.
  • Afin d'éviter tout comportement imprévisible, la règle minimale à suivre est d'éviter toute duplication du fichier ebx.jar ou de toute autre bibliothèque sur le système de class-loading du serveur d'application.
  • La description ci-dessous emploie le nom de variable CATALINA_HOME pour se rapporter au répertoire dans lequel vous avez installé Tomcat 5, et par rapport auquel la plupart des chemins relatifs sont résolus. Cependant, si vous avez configuré Tomcat 5 pour gérer des instances multiples en décrivant un répertoire CATALINA_BASE, vous devriez employer CATALINA_BASE au lieu de CATALINA_HOME pour chacune de ces références.

Résumé d'un exemple de procédure

  • Créer le répertoire EBX_HOME: décompresser ebx_home.zip
  • Installer les librairies de EBX.Platform  : ajouter les librairies (fichiers jar) au répertoire des bibliothèques partagées de tomcat
  • Configurer JVM arguments (Java system properties) : créer la variable d’environnement, JAVA_OPTS
  • Déployer l’application EBX.Platform : copier les fichiers war dans le répertoire webapps de tomcat

Détail d'un exemple de procédure

  1. Créer un répertoire en tant que EBX_HOME, par exemple, C:\EBX\home

  2. Décompresser le fichier ebx.software\files\ebx_home.zip vers EBX_HOME. Dans notre exemple, après la décompression, nous aurons les fichiers suivants:

    C:\EBX\home\schemas, un répertoire
    C:\EBX\home\ebx.properties, un fichier texte

  3. Copier le fichier ebx.jar dans le répertoire $CATALINA_HOME\shared\lib\ (ou $CATALINA_BASE\shared\lib\). Le fichier se trouve dans le répertoire ebx.software\lib\. Dans notre example, nous aurons:

    $CATALINA_HOME\shared\lib\ebx.jar

  4. Copier les librairies tierces dans le répertoire $CATALINA_HOME\shared\lib\ (ou $CATALINA_BASE\shared\lib\). Dans notre exemple, nous aurons:

    $CATALINA_HOME\shared\lib\activation.jar
    $CATALINA_HOME\shared\lib\mail.jar
    $CATALINA_HOME\shared\lib\hsqldb.jar

    Ces librairies tierces sont décrites de manière plus détaillée dans le chapitre Composants. Evidemment elles ne sont pas à installer si elles sont déjà intégrées au système de class-loading du serveur.

  5. Copier les fichiers war qui se trouvent dans le répertoire ebx.software\webapps\wars-packaging vers le répertoire $CATALINA_HOME\webapps\. Dans notre example, nous aurons:

    $CATALINA_HOME\webapps\ebx.war : Servlet d'entrée commune aux outils EBX.Platform
    $CATALINA_HOME\webapps\ebx-root-1.0.war : Ensemble de fichiers qui permettent de fournir une configuration par défaut aux modèles d'adaptation (schémas XML) et adaptations
    $CATALINA_HOME\webapps\ebx-manager-1.0.war : Application web de gestion des données EBX.Manager

  6. Modifier le fichier $CATALINA_HOME\conf\server.xml (ou $CATALINA_BASE\conf\server.xml). Ajouter la ligne suivante dans l'élement <Host> :

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

    Après cette modification, nous aurons :

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

  7. Configuration des propriétés de lancement.

    Si tomcat est lancé à partir d'une commande, dans une console DOS de Windows ou un shell Unix, nous pouvons créer un nouveau fichier de lancement :

    Dans le cas de Windows, ce fichier de lancement, par example start_ebx.bat, aura les lignes suivantes :

    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

    Dans le cas d'Unix, ce fichier de lancement, par example start_ebx.sh, aura les lignes suivantes :

    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

    (!) Le compte utilisé au lancement de EBX.Platform doit avoir les droits suffisants sur le répertoire $EBX_HOME (création, modification, suppression).

    Les utilisateurs ayant installé Tomcat en service doivent définir les options de lancement Java dans la console de configuration (onglet Java).
    Attention : ne définir qu'une option par ligne du champ Options Java de l'interface, i.e. :

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

    ou <path_to_the_directory_ebx_home> est ici le répertoire où nous avons décompressé le fichier ebx_home.zip. Dans notre exemple, c'est le répertoire C:\EBX\home.

  8. Démarrer EBX.Platform.

    Après démarrage de Tomcat, lancez l'application Web EBX.Manager : http://localhost:8080/ebx/ .

    Au premier lancement, EBX.Platform fournit un assistant permettant de configurer un référentiel de démarrage.

 

Home > Installation