Installation note for WebSphere AS 9

Overview

Requirements

• WebSphere Application Server 9

• Database and JDBC driver

• EBX® CD

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

WebSphere Application Server installation

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

1. Download WebSphere AS 9 Installation Manager latest version from:

   https://www.ibm.com/support/pages/node/609575

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, 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

      Click 'Next'

   4. Profile Name and Location: enter a profile name (example: 'EbxAppSrvProfile') and a directory. In our example, we will get:

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

      Further, it will correspond to <PROFILE_HOME>.

      Click 'Next'

   5. Node and Host Names: enter the node name (example: 'Node1'), the server name (example: 'EbxServer'), the host name (example: 'localhost'), and 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 personal 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'

WebSphere Application Server and EBX® home directory configuration

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 have the following file:

   /opt/ebx/home/ebx.properties.

3. If needed, edit the ebx.properties file to override the default database. By default the standalone H2 database is defined. The property key ebx.persistence.factory must be uncommented for other supported databases and the h2.standalone one must be commented.

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

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

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

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

   ebx-lz4.jar (coming from the ebx.software/lib/ directory of the EBX® CD).

   The complete description of these components is given in the chapter Java EE deployment. 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).

Data source and JDBC provider configuration

1. Start the server with the following command line:

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

   where:

   <PROFILE_HOME> corresponds to the previously created profile home directory. In our example, we will get: /opt/IBM/WebSphere/AppServer/profiles/EbxAppSrvProfile.

   <serverName> corresponds to the server to start. In our example, we will get: EbxServer.

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

   https://localhost:9043/ibm/console

3. On the left menu, go to 'Resources > JDBC > Data Sources', choose the JDBC 'Scope' (for example use 'Cell'), and click 'New'

4. Enter basic data source information:

   • Data source name: EBX_REPOSITORY

   • JNDI name: jdbc/EBX_REPOSITORY

   Click 'Next'

5. Select 'Create new JDBC provider', and click 'Next'

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

   • Database type: User-defined

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

   • Name: PostgreSQL

   Click 'Next'

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

   • Class path: <EBX_LIB>/postgresql-X.X.X-driver.jar

     In our example, <EBX_LIB> corresponds to /opt/ebx/home/lib.

   Click 'Next'

8. Keep database specific properties for the data source as default and click 'Next'

9. Keep setup security aliases as default and click 'Next'

10. Click 'Finish'

11. Save the master configuration

12. Click on 'Data Sources > EBX_REPOSITORY'

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

    • Define the user value to the according user

    • Define the password value to the according password

14. Save the master configuration

15. Test the connection

Java Virtual Machine configuration

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. Add 'ebx.properties' and 'ebx.home' properties, in the 'Generic JVM arguments' section, respectively set to ebx.properties file's path and EBX_HOME directory's path.

6. Add, in the 'Classpath' section, the paths to the third-party libraries placed in the EBX_LIB directory except for the JDBC driver. In our example, we will get:

   /opt/ebx/home/lib/xml-apis-1.4.01.jar
   /opt/ebx/home/lib/ebx-lz4.jar

   Note

   Every library's path declaration must be on a separate line.

7. Click 'Ok'

8. Save the master configuration

EBX® application deployment

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

   /opt/ebx/home/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), by entering 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.ear

   1. Enterprise Applications: click on 'Install'

   2. Preparing for the application installation: Browse to the EBX.ear file. In our example, it is located under the /opt/ebx/home/ear directory.

      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 every 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 these resources had not been configured.

      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 every modules, then click 'Next'

   9. Warnings will appear related to unavailable resources. This behavior is normal since these resources had not been configured.

      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, 'Application EBX® installed successfully' is logged.

       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', click on 'Class loading and update detection'

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

   4. Save the master configuration

7. On the left menu, go to 'Applications > Enterprise Applications', select EBX®, then click 'Start'

   The EBX® 'Application status' will changed to a green arrow.

EBX® application start

1. After the launch of the WebSphere application Server, run the EBX® web application by entering the following URL in the browser:

   http://localhost:9080/ebx/

   or

   https://localhost:9443/ebx/

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