Home > Installation

Install Note for WebSphere 6

Warnings

  • This chapter describes a quick installation example of EBX.Platform on IBM WebSphere 6 Application Server.
  • It does not replace the documentation of this application server.
  • It is not a general installation recommendation, since actual 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 this document, we do not deploy an additional EBX.Platform module. For this, a good practice would be to rebuild an EAR with the EBX.Platform module as a Web application at the same level as other EBX.Platform Web applications. In this case, the web application must declare its class-path dependency in the standard manner specified by Java™ 2 Platform Enterprise Edition Specification, v1.4:

    J2EE.8.2 Optional Package Support

    (...)

    A JAR format file (such as a .jar file, .war file, or .rar file) can reference a .jar file by naming the referenced .jar file in a Class-Path header in the referencing JAR file’s Manifest file. The referenced .jar file is named using a URL relative to the URL of the referencing JAR file. The Manifest file is named META-INF/MANIFEST.MF in the JAR file. The Class-Path entry in the Manifest file is of the form:

    Class-Path: list-of-jar-files-separated-by-spaces

    In an "industrialized" process, we strongly recommend to develop a script that automatically builds the EAR with: the specific EBX.Platform module(s), the EBX.Platform Web applications and also all the shared libraries needed.

  • 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.

Warning: Using a DataSource v5 in Websphere 6

  • The mechanism used by Websphere for retrieving a DataSource v5 is not backwards compatible with the Servlet 2.2 specification. Therefore, using a DataSource v5 requires the Deployer to modify the DTD reference in the deployment descriptor of the "ebx" Web application,

    by replacing:

    <!DOCTYPE web-app PUBLIC "-//Sun Microsystems, Inc.//DTD Web Application 2.2//EN" "http://java.sun.com/j2ee/dtds/web-app_2_2.dtd">

    with:

    <!DOCTYPE web-app PUBLIC "-//Sun Microsystems, Inc.//DTD Web Application 2.3//EN" "http://java.sun.com/dtd/web-app_2_3.dtd">

Overview

  1. Create EBX_HOME directory and unzip ebx_home.zip
  2. Install EBX.Platform library: Websphere Server Application - First steps, Environment, Shared Libraries
  3. Configure JVM arguments (Java system properties): Servers, Application servers, Java and Process Management, Process Definition, Java Virtual Machine, Additional Properties, Generic JVM arguments
  4. Deploy EBX.Platform application: Applications, Install New Application

Detail

  1. Create EBX_HOME directory, in our example it is C:\ebx.software\home
  2. Create EBX_LIB directory, in our example it is C:\ebx.software\lib
  3. Create EBX_EAR directory, in our example it is C:\ebx.software\ear
  4. Uncompress the file ebx_home.zip to EBX_HOME. In our example, we will then have the following files:

    5. C:\ebx.software\home\schemas, a directory
    C:\ebx.software\home\ebx.properties, a text file

  5. Copy third-party library files to EBX_LIB directory. In our example, we will have:

    6. C:\ebx.software\lib\activation.jar
    C:\ebx.software\lib\mail.jar
    C:\ebx.software\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.

  6. Copy the file ebx.software/webapps/ear-packaging/ebxPlatform.ear to EBX_EAR. In our example, we will have:

    7. C:\ebx.software\ear\ebxPlatform.ear

  7. Launch the "Websphere Server Application - Fist steps" console
  8. Start the server
  9. Launch the administration console and login
  10. Specify the EBX.Platform library:
    1. In the menu on the left, click on"Environment"
    2. Click on "Shared Libraries"
    3. In the "Shared Libraries" page , click on the button "New". The "Shared Libraries > New" page is displayed.
    4. In the field *Name, enter the library name, in our example it is lib_of_ebx
    5. In the field *Classpath, enter the EBX_LIB path, in our example it is C:\ebx.software\lib
    6. Click on the button "OK"
    7. Save modifications by clicking on "Save" in the "Messages" panel at the bottom of the page "Shared Libraries".
    8. Click on the button "Save"
  11. Specify the EBX.Platform configuration file path:
    1. In the menu on the left, click on "Servers"
    2. Click on "Application servers"
    3. In the page "Application servers", click on the server name. In our example, the server name is server1.
    4. In the configuration page of "Application servers > server ", click on "Java and Process Management", which is a sub-menu of "Server Infrastructure"
    5. Click on "Process Definition"
    6. Click on "Java Virtual Machine", which is a sub-menu of "Additional Properties"
    7. In the field "Generic JVM arguments", enter:
      -Debx.home=C:\ebx.software\home -Debx.properties=C:\ebx.software\home\ebx.properties
    8. Here, ebx.home is the directory for EBX_HOME, ebx.properties is the configuration file of EBX. In our example, they are respectively C:\ebx.software\home and C:\ebx.software\home\ebx.properties
    9. Click on the button "OK", at the bottom of the page "Application servers > server1 > Java Virtual Machine"
    10. Save modifications by clicking on "Save" in the "Messages" panel at the top of the page "Application servers > server1 > Java Virtual Machine".
  12. Deploy Web Applications:
    1. In the menu on the left, click on "Applications"
    2. Click on "Install New Application"
    3. In the page "Preparing for the application installation", in the field "Specify path", select ebxPlatform.ear file. In our example, it is C:\ebx.software\ear\ebxPlatform.ear
    4. Click on the button "Next" at the bottom of the page "Preparing for the application installation"
    5. Select "Use default virtual host name for Web modules"
    6. Click on the button "Next"
    7. Click on the button "Continue"
    8. In the page "Install new Application, Step 1 Select installation options", the field "Directory to install application" is the installation directory of EBX.Platform. In our example, it is "C:\ebx.software\ear"
    9. Click on the button "Next"
    10. In the page "Install new Application, Step 2 Map modules to servers", click on the button "Next"
    11. In the page "Install new Application, Step 3 Map resource references to resources", as we don't use JNDI resource in this example, input DefaultDatasource, click on the button "Next"
    12. In the page "Install new Application, Step 4 Map virtual hosts for Web modules", map all modules: ebx.war, ebx-root-1.0.war, ebx-manager-1.0.war au default_host.
    13. Click on the button "Next"
    14. Click on the button "Finish"
    15. The page "Installing… " is displayed. The message "Application EBX.Platform installed successfully" will be displayed at the bottom of the page.
    16. Click on "Save to Master Configuration" at the bottom of the page
    17. Click on the button "Save"
  13. Link Web Applications to the EBX.Platform library
    1. In the menu on the left, click on "Applications"
    2. Click on "Enterprise Applications"
    3. In the page "Enterprise Applications", click on EBX.Platform
    4. In the page "Enterprise Applications > EBX.Platform", click on "Libraries", which is below "Additional Properties"
    5. Click on the button "Add"
    6. Select the library we add in step 10.4, which is lib_of_ebx
    7. Click on the button "OK"
    8. Save modifications by clicking on "Save" in the "Messages" panel at the top of the page "Enterprise Applications"
    9. Click on the button "Save"
  14. In the console "Websphere Server Application - First steps", stop the server
  15. In the console "Websphere Server Application - First steps", start the server
  16. Restart the administration console, in the menu on the left, click on "Applications"
  17. Click on "Enterprise Applications"
  18. In the page "Enterprise Applications", select EBX.Platform
  19. Click on the button "Start"
  20. Run EBX.Platform.

    21. Run EBX.Manager Web application: http://localhost:9080/ebx/.

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

Note d'installation pour WebSphere 6

Avertissements

  • Ce chapitre décrit un exemple d'installation rapide de EBX.Platform sur IBM WebSphere Application Server v6.
  • 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.
  • Dans cet exemple, nous ne déployons pas un module EBX.Platform tiers. Pour cela, une bonne pratique est de construire un EAR qui inclut le module EBX.Platform en tant qu'application Web au même niveau que les applications Web de EBX. En ce cas, les fichiers war doivent déclarer leurs dépendances de la manière standard qui est spécifiée par le document "Java™ 2 Platform Enterprise Edition Specification, v1.4" :

    J2EE.8.2 Optional Package Support

    (...)

    A JAR format file (such as a .jar file, .war file, or .rar file) can reference a .jar file by naming the referenced .jar file in a Class-Path header in the referencing JAR file’s Manifest file. The referenced .jar file is named using a URL relative to the URL of the referencing JAR file. The Manifest file is named META-INF/MANIFEST.MF in the JAR file. The Class-Path entry in the Manifest file is of the form

    Class-Path: list-of-jar-files-separated-by-spaces

    Pour un processus "industrialisé", nous recommandons fortement de développer un script qui construit automatiquement l'EAR, en y incluant les modules EBX.Platform spécifiques, les applications Web EBX.Platform fournies ainsi que toutes les bibliothèques nécessaires.

  • 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.

Avertissement : Utilisation d'une DataSource v5 dans Websphere 6

  • Le mécanisme utilisé par Websphere pour retrouver une DataSource v5 n'est pas rétro-compatible avec la spécification Servlet 2.2. Par conséquent, l'utilisation d'une DataSource v5 nécessite de modifier le descripteur de déploiement de la Web application "ebx",

    en remplaçant

    <!DOCTYPE web-app PUBLIC "-//Sun Microsystems, Inc.//DTD Web Application 2.2//EN" "http://java.sun.com/j2ee/dtds/web-app_2_2.dtd">

    par

    <!DOCTYPE web-app PUBLIC "-//Sun Microsystems, Inc.//DTD Web Application 2.3//EN" "http://java.sun.com/dtd/web-app_2_3.dtd">

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

  1. Créer le répertoire EBX_HOME et y décompresser ebx_home.zip
  2. Installer la librairie EBX.Platform: Websphere Server Application - Premiers pas, Environment, Shared Libraries
  3. Configurer les arguments JVM (Java system properties) : Servers, Application servers, Java and Process Management, Process Definition, Java Virtual Machine, Additional Properties, Generic JVM arguments
  4. Déployer l’application EBX.Platform : Applications, Install New Application

Détail d'un exemple de procédure

  1. Créer un répertoire en tant que EBX_HOME, par exemple C:\ebx.software\home
  2. Créer un répertoire en tant que EBX_LIB, par exemple C:\ebx.software\lib
  3. Créer un répertoire en tant que EBX_EAR, par exemple C:\ebx.software\ear
  4. Décompresser le fichier ebx_home.zip vers EBX_HOME. Dans notre exemple, après la décompression, nous aurons les fichiers suivants :

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

  5. Copier les bibliothèques partagées dans le répertoire EBX_LIB. Dans notre exemple, nous aurons :

    6. C:\ebx.software\lib\activation.jar
    C:\ebx.software\lib\mail.jar
    C:\ebx.software\lib\hsqldb.jar

    Ces librairies tierces sont décrites de manière plus détaillée au chapitre Composants. Evidemment, elles ne sont pas à installer si elles sont déjà intégrées au système de class-loading du serveur.
  6. Copier le fichier ebx.software/webapps/ear-packaging/ebxPlatform.ear vers le répertoire EBX_EAR. Dans notre exemple, nous aurons :

    7. C:\ebx.software\ear\ebxPlatform.ear

  7. Lancer la console "Websphere Server Application - Premiers pas"
  8. Démarrer le serveur
  9. Lancer la console d’administration et s’identifier
  10. Spécifier la bibliothèque EBX.Platform :
    1. Sur le menu de gauche, cliquer sur "Environment"
    2. Cliquer sur "Shared Libraries"
    3. Dans la page de "Shared Libraries", cliquer sur le bouton "New". La page "Shared Libraries > New" s’affiche
    4. Dans le champ *Name, entrer le nom de la librairie, par exemple lib_of_ebx
    5. Dans le champ *Classpath, entrer le chemin de EBX_LIB. Dans notre exemple, c’est C:\ebx.software\lib
    6. Cliquer sur le bouton "OK"
    7. Sauvegarder les modifications en cliquant "Save" du panneau "Messages" situé en haut de la page "Shared Libraries".
    8. Cliquer sur le bouton "Save"
  11. Spécifier le chemin du fichier de configuration EBX.Platform :
    1. Sur le menu de gauche, cliquer sur "Servers"
    2. Cliquer sur "Application servers"
    3. Dans la page "Application servers", cliquer sur le nom du serveur. Dans notre exemple, le nom du serveur est server1.
    4. Dans la page de Configuration de "Application servers > server1", cliquer sur "Java and Process Management", qui est un sous-menu de "Server Infrastructure"
    5. Cliquer sur "Process Definition"
    6. Cliquer sur "Java Virtual Machine", qui est un sous-menu de "Additional Properties"
    7. Dans le champ "Generic JVM arguments", entrer :
      -Debx.home=C:\ebx.software\home -Debx.properties=C:\ebx.software\home\ebx.properties
    8. Ici, ebx.home est le répertoire de EBX_HOME, ebx.properties est le fichier de configuration de EBX. Dans notre exemple, ce sont respectivement les répertoires : C:\ebx.software\home et C:\ebx.software\home\ebx.properties
    9. Cliquer sur le bouton "OK", qui se situe en bas de la page "Application servers > server1 > Java Virtual Machine"
    10. Sauvegarder les modifications en cliquant "Save" du panneau "Messages" situé en haut de la page "Application servers > server1 > Java Virtual Machine".
  12. Déployer les applications Web :
    1. Sur les menus de gauche, cliquer sur "Applications"
    2. Cliquer sur "Install New Application"
    3. Dans la page "Preparing for the application installation", dans le champ "Specify path", sélectionner le fichier ebxPlatform.ear. Dans notre exemple, c'est C:\ebx.software\ear\ebxPlatform.ear
    4. Cliquer sur le bouton "Next" en bas de la page "Preparing for the application installation"
    5. Sélectionner "Use default virtual host name for Web modules"
    6. Cliquer sur le bouton "Next"
    7. Cliquer sur le bouton "Continue"
    8. Dans la page "Install new Application, Step 1 Select installation options", le champ "Directory to install application" est le répertoire d’installation de EBX.Platform. Dans notre exemple, c'est "C:\ebx.software\ear"
    9. Cliquer sur le bouton "Next"
    10. Dans la page "Install new Application, Step 2 Map modules to servers", cliquer sur le bouton "Next"
    11. Dans la page "Install new Application, Step 3 Map resource references to resources", comme nous n'utilisons pas de ressource JNDI dans cet exemple, saisir DefaultDatasource, puis cliquer sur le bouton "Next"
    12. Dans la page "Install new Application, Step 4 Map virtual hosts for Web modules", mapper tous les modules : ebx.war, ebx-root-1.0.war, ebx-manager-1.0.war au default_host
    13. Cliquer sur le bouton "Next"
    14. Cliquer sur le bouton "Finish"
    15. La page "Installing… " s’affiche. Le message "Application EBX.Platform installed successfully" s’affichera en bas de page
    16. Cliquer sur "Save to Master Configuration" en bas de la page
    17. Cliquer sur le bouton "Save"
  13. 13. Lier les applications Web à la bibliothèque EBX.Platform
    1. Sur les menus de gauche, cliquer sur "Applications"
    2. Cliquer sur "Enterprise Applications"
    3. Dans la page "Enterprise Applications", cliquer sur EBX.Platform
    4. Dans la page "Enterprise Applications > EBX.Platform", cliquer sur "Libraries", qui est en-dessous de "Additional Properties"
    5. Cliquer sur le bouton "Add"
    6. Sélectionner la libraire que nous avons ajoutée à l' étape 10.4 lib_of_ebx
    7. Cliquer sur le bouton "OK"
    8. Sauvegarder les modifications en cliquant "Save" du panel "Messages" situé en haut de la page "Enterprise Applications"
    9. Cliquer sur le bouton "Save"
  14. Dans la console "Websphere Server Application - Premiers pas", arrêter le serveur
  15. Dans la console "Websphere Server Application - Premiers pas", démarrer le serveur
  16. Relancer la console d’administration, sur les menus de gauche, cliquer sur "Applications"
  17. Cliquer sur "Enterprise Applications"
  18. Dans la page "Enterprise Applications", sélectionner EBX.Platform
  19. Cliquer sur le bouton "Start"
  20. Valider votre installation.

    21. Lancez l'application Web EBX.Manager : http://localhost:9080/ebx/ .

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

 

Home > Installation