Installation note for WebSphere AS 9

Overview

• Install the WebSphere Application Server

• Create the EBX_HOME directory: copy ebx.properties

• Create a new profile by using the 'WebSphere Customization Toolbox'

• Create a data source and JDBC provider

• Configure the Java Virtual Machine

• Install the EBX.ear application

• Start the EBX® application

Requirements

• WebSphere Application Server 9

• Database and JDBC driver

• EBX® CD

• No CDI features in EBX®'s additional modules (since CDI will be automatically disabled)

Installation

This quick installation example is performed for a Linux operating system.

1. To download WebSphere AS 9, please first download the latest 'Installation Manager' from

   http://www-01.ibm.com/support/docview.wss?uid=swg27025142

2. Run the 'Installation Manager' and add the following repositories:

   • WebSphere Application Server V9.0:

     http://www.ibm.com/software/repositorymanager/V9WASBase

   • WebSphere Application Server Network Deployment V9.0:

     http://www.ibm.com/software/repositorymanager/V9WASND

3. Install the 'WebSphere Application Server Network Deployment'

   For further installation details, please refer to the documentation.

4. Run the 'WebSphere Customization Toolbox' and perform a standard installation with default options:

   1. Create profile: click 'Create' then select 'Application Server', and click 'Next'

   2. Profile Creation Options: select 'Advanced profile creation' and click 'Next'

   3. Optional Application Deployment: select those options:

      • Deploy the 'Administrative Console'

      • Deploy the 'Installation Verification Tool' application

      Then click 'Next'

   4. Profile Name and Location: enter a profile name (example: 'EbxAppSrvProfile') and directory

      /opt/IBM/WebSphere/AppServer/profiles/EbxAppSrvProfile

      further correspond to PROFILE_HOME and click 'Next'

   5. Node and Host Names: enter the node name (example: 'Node1'), the server name (example: 'EbxServer'), the host name (example: 'localhost'), and then click 'Next'

   6. Administrative Security: check 'Enable administrative security' option, enter the user name, the password, and click 'Next'

   7. Security Certificate (part 1): select 'Create a new default personnal certificate' and 'Create a new root signing certificate', and click 'Next'

   8. Security Certificate (part 2): keep as default and click 'Next'

   9. Port Value Assignment: keep as default and click 'Next'

   10. Linux Service Definition: check 'Run the application server process as a Linux service' option, enter the user name (example: 'ebx'), and click 'Next'

   11. Web Server Definition: keep as default and click 'Next'

   12. Profile Creation Summary: keep as default and click 'Create'

   13. Profile Creation Complete: uncheck 'Launch the First steps console' option, and click 'Finish'

Configuration for EBX®

1. Create the EBX_HOME directory, for example /opt/ebx/home

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

   /opt/ebx/home/ebx.properties.

3. Edit the ebx.properties file to override the default database if needed. By default, the standalone H2 database is defined. The property key ebx.persistence.factory must be uncommented for other supported database and it is required to comment the h2.standalone one

4. Create the EBX_LIB directory, for example /opt/ebx/lib

5. Copy third-party library files from the EBX® CD, or from other sources, to the <EBX_LIB> directory. In our example, for a PostgreSQL database, we will have:

   postgresql-X.X.X-driver.jar (coming from another source than the EBX® CD).

   xml-apis-1.4.01.jar (coming from the EBX® CD directory ebx.software/lib/lib-xml-apis/).

   The exact description of these components is given in the chapter Components. If those components are already deployed on the class-loading system, they do not have to be duplicated (ex: javax.mail-1.5.6.jar is already present on the WebSphere Application Server, and the database driver is configured at the data source level).

6. Start the server (for example 'EbxServer'),

   sudo <PROFILE_HOME>/bin/startServer.sh <serverName>

   cd /opt/IBM/WebSphere/AppServer/profiles/EbxAppSrvProfile

   sudo bin/startServer.sh EbxServer.

7. Connect into the 'WebSphere Integrated Solutions Console' using the user name and password typed during the profile creation (Administrative Security step), enter the following url in the browser:

   https://localhost:9043/ibm/console

8. Create a data source and JDBC provider

   1. On the left menu, go to 'Resources > JDBC > Data Sources', to configure your database access. Choose the jdbc 'Scope' (for example use 'Cell'), and click 'New'

   2. Enter basic data source information:

      • Data source name: EBX_REPOSITORY

      • JNDI name: jdbc/EBX_REPOSITORY

      click on 'Next'

   3. Select the JDBC provider: select 'Create new JDBC provider', and click 'Next'

   4. Create a new JDBC provider: (example with a PostgreSQL database)

      • Database type: User-defined

      • Implementation class name: org.postgresql.ds.PGConnectionPoolDataSource

      • Name: PostgreSQL

      and click 'Next'

   5. Enter database class path information: (example with a PostgreSQL database)

      • Class path: /opt/ebx/lib/postgresql-X.X.X-driver.jar

      and click 'Next'

   6. Enter database specific properties for the data source: keep as default and click 'Next'

   7. Setup security aliases: keep as default and click 'Next'

   8. Summary: click 'Finish'

   9. Save the master configuration

9. Configure the data source: jdbc/EBX_REPOSITORY

   1. Click on 'Data Sources > EBX_REPOSITORY'

   2. On the right in the 'Configure additional properties' section, click on 'Additional Properties' and define the database account access:

      • Define user value to the according user

      • Define password value to the according password

   3. Save the master configuration

   4. Test the connection

10. Configure the Java Virtual Machine

    1. Click on 'Application Servers'

    2. Click on the server name (for example: 'EbxServer')

    3. Click on 'Process definition' under 'Server infrastructure > Java Process Management'

    4. Click on 'Java Virtual Machine' under 'Additional Properties'

    5. Enter in 'Generic JVM arguments' the value:

       -Debx.properties=/opt/ebx/home/ebx.properties -Debx.home=/opt/ebx/home

    6. Enter in 'Classpath' the paths to the third-party library files placed in the <EBX_LIB> directory except for the JDBC driver

    7. click 'Ok'

    8. Save the master configuration

Deploying EBX®

1. Copy from the EBX® CD the ebx.software/webapps/ear-packaging/EBX.ear to the EBX_HOME directory. In our example, we will have:

   /opt/ebx/ear/EBX.ear

2. Connect into the 'WebSphere Integrated Solutions Console' using the user name and password typed during the profile creation (Administrative Security step), enter the following url in the browser:

   https://localhost:9043/ibm/console

3. Click on 'WebSphere enterprise applications' under 'Applications > Application Types'

4. Install the EBX® application

   1. New Application: On the right panel, click on 'New Enterprise Application'

   2. Preparing for the application installation: Browse your EBX.ear file, located under /opt/ebx/ear/EBX.ear, then click 'Next'

   3. How do you want to install the application?: Select 'Fast Path...', then click 'Next'

   4. Select installation options: keep as default, then click 'Next'

   5. Map modules to servers: select all modules, then click 'Next'

   6. Map resource references to resources: copy the 'Resource Reference' value and paste it in the 'Target Resource JNDI Name' field, for all modules, then click 'Next'

   7. Warnings will appear related to JNDI:mail/EBX_MAIL_SESSION and JNDI:jms/EBX_JMSConnectorFactory. This behavior is normal since we had not configured these resources. Click 'Continue'

   8. Map resource environment references to resources: Copy the 'Resource Reference' value and paste it to the 'Target Resource JNDI Name' value, for all modules, then click 'Next'

   9. Warnings will appear related to non-available resources. This behavior is normal since we had not configured these resources, then click 'Continue'

   10. Map virtual hosts for Web modules: select all modules and click 'Next'

   11. Summary: keep as default, click 'Finish'

   12. If installation succeeds, it logs 'Application EBX® installed successfully', then click 'Save'

5. On the left menu, go to 'Applications > Enterprise Applications'

6. Change EBX® application's class loader policy

   1. Click on EBX® resource’s name

   2. On the 'configuration' pane, under 'Detail Properties', select 'Class loading and update detection'

   3. Under 'General Properties', change 'Class loader order' to 'Classes loaded with local class loader first (parent last)'

   4. Return to 'Applications > Enterprise Applications'

7. Enterprise Applications: select EBX®, and then click 'Start'

   The EBX® 'Application status' will be changed into a green arrow

Start EBX®

1. After the launch of the WebSphere Server, run the EBX® web application: http://localhost:9080/ebx/

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