Home > Installation

Install Note for WebSphere 5.1

Warnings

  • This chapter describes a quick installation example of EBX.Platform on IBM WebSphere 5.1 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 that, 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.

Installation Example Overview

  • Create the EBX_HOME directory: Copy ebx.properties

  • Install EBX.Platform library: Websphere Server Application - First steps, Environment, Shared Libraries

  • Configure JVM arguments (Java system properties): Servers, Application servers, server1, Process Definition, Java Virtual Machine, Generic JVM arguments

  • Deploy EBX.Platform application: Applications, Install New Application

Installation Example Detail

  1. Create a EBX_HOME directory, for example C:\EBX\home

  2. Create a EBX_LIB directory, for example C:\EBX\lib

  3. Create a EBX_EAR directory, for example C:\EBX\ear

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

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

    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:

    C:\EBX\ear\ebxPlatform.ear

  7. Launch "Websphere Server Application - First 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 Librarie > New " page is then 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\lib

    6. Click on the button "OK"

    7. Save modifications by clicking on "Save" in the "Messages" panel on top of the "Shared Libraries" page

    8. Click on the button "Save "

  11. In the menu on the left, click on "Servers"

  12. Click on "Application servers"

  13. In the "Application servers" page, click on the server name. In our example, the server name is server1. 

  14. In the configuration page of "Application servers > server1", click on "Process Definition"

  15. Click on "Java Virtual Machine", which is a sub-menu of "Additional Properties"

  16. In the field "Generic JVM arguments", enter:

    -Debx.home=C:\EBX\home -Debx.properties=C:\EBX\home\ebx.properties

    Here, ebx.home is the directory of EBX_HOME, ebx.properties is the configuration file of EBX. In our example, they are respectively C:\EBX\home and C:\EBX\home\ebx.properties

  17. Click on the button "OK", at the bottom of the page

  18. Save modifications by click on "Save" in the "Messages" panel at the top of the page, then click on the button "Save"

  19. In the menu on the left, click on "Applications"

  20. Click on "Install New Application"

  21. In the page "Preparing for the application installation", in the field "Local path", select ebxPlatform.ear file. In our example, it is C:\EBX\ear\ebxPlatform.ear

  22. Click on the button "Next" at the bottom of the page "Preparing for the application installation"

  23. Select "Default virtual host name for Web modules"

  24. Click on the button "Next"

  25. Click on the button "Continue"

  26. In the page "Install new Application, Step 1: Provide options to perform the installation", the field "Directory to install application" is the installation directory of EBX.Platform. In our example, it is "C:\EBX\ear"

  27. Click on the button "Next"

  28. In the page "Install new Application, Step 2: Map virtual hosts for web modules", click on the button "Next"

  29. 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", then click on the button "Next"

  30. In the page "Install new Application, Step 4: Map modules to application servers", select all modules: ebx.war, ebx-root-1.0.war, ebx-manager-1.0.war

  31. Click on the button "Next"

  32. Click on the button "Finish"

  33. The page "Installing… " is displayed. The message "Application EBX.Platform installed successfully" will be displayed at the bottom of the page

  34. In the menu on the left, click on "Applications"

  35. Click on "Enterprise Applications"

  36. In the page "Enterprise Applications", click on EBX.Platform

  37. In the page "Enterprise Applications > EBX.Platform", click on "Libraries", below "Additional Properties"

  38. Click on the button "Add"

  39. Select the library we added in step 10.4: lib_of_ebx

  40. Click on the button "OK"

  41. Save modifications by clicking on "Save" in the "Messages" panel at the top of the "Enterprise Applications" page

  42. Click on the button "Save"

  43. In the "Websphere Server Application - First steps" console, stop the server

  44. In the "Websphere Server Application - First steps", start the server

  45. Restart the administration console, in the menu on the left, click on "Applications"

  46. Click on "Enterprise Applications"

  47. In the page "Enterprise Applications", select EBX.Platform

  48. Click on the button "Start".

  49. Run EBX.Platform.

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.

 

Home > Installation