TIBCO EBX®
Documentation > Administration Guide > Installation & configuration > Installation notes
Navigation modeDocumentation > Administration Guide > Installation & configuration > Installation notes

Installation note for JBoss EAP 7.1.x

Overview

Attention

  • This chapter describes a quick installation example of TIBCO EBX® on the JBoss Application Server.

  • It does not replace the documentation of this application server.

  • These are not general installation recommendations, as the installation process is determined by architectural decisions such as the technical environment, application mutualization, delivery process, and organizational decisions.

  • The complete description of the components required by EBX® is given in the following chapter: Java EE deployment.

  • In order to avoid unpredictable behavior, the guideline to follow is to avoid any duplicates of ebx.jar or other libraries in the class-loading system.

Requirements

Installation

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

  1. To download JBoss EAP 7.1, please first download Installer jar version 7.1.0 from:

    https://developers.redhat.com/products/eap/download/

  2. Run the Installer using java -jar command line.

    For further installation details, please refer to the documentation .

  3. Perform a standard installation:

    1. Select the language and click 'OK',

    2. Accept the License and click 'Next',

    3. Choose the installation path and click 'Next',

    4. Keep the 'Component Selection' as it is and click 'Next',

    5. Enter 'Admin username', 'Admin password' and click 'Next',

    6. On 'Installation Overview' click 'Next',

    7. On 'Component Installation' click 'Next',

    8. On 'Configure Runtime Environment' leave selection as it is and click 'Next',

    9. When 'Processing finished' appear, click 'Next',

    10. Uncheck 'Create shortcuts in the start menu' and click 'Next',

    11. Generate 'installation script and properties file' at JBoss EAP 7.1 installation root path,

    12. Click on 'done'.

Configuration for EBX®

EBX® home directory creation and 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 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.

Java Virtual Machine properties configuration

  1. Open the standalone.conf configuration file, placed in JBOSS_HOME/bin (or jboss-eap.conf file placed in JBOSS_HOME/bin/init.d for a running server as a service).

  2. Add 'ebx.properties' and 'ebx.home' properties to 'JAVA_OPTS' respectively set with ebx.properties file's path and EBX_HOME directory's path.

JNDI entries configuration

  1. Open the standalone-full.xml file placed in JBOSS_HOME/standalone/configuration.

  2. Add, at least, the following lines to the server tag in messaging-activemq subsystem:

    <connection-factory
        name="jms/EBX_JMSConnectionFactory"
        entries="java:/EBX_JMSConnectionFactory"
        connectors="To Be Defined"/>
    <jms-queue
        name="jms/EBX_D3ReplyQueue"
        entries="java:/jms/EBX_D3ReplyQueue"
        durable="true"/>
    <jms-queue
        name="jms/EBX_QueueIn"
        entries="java:/jms/EBX_QueueIn"
        durable="true"/>
    <jms-queue
        name="jms/EBX_QueueFailure"
        entries="java:/jms/EBX_QueueFailure"
        durable="true"/>
    <jms-queue
        name="jms/EBX_D3MasterQueue"
        entries="java:/jms/EBX_D3MasterQueue"
        durable="true"/>
    <jms-queue
        name="jms/EBX_D3ArchiveQueue"
        entries="java:/jms/EBX_D3ArchiveQueue"
        durable="true"/>
    <jms-queue
        name="jms/EBX_D3CommunicationQueue"
        entries="java:/jms/EBX_D3CommunicationQueue"
        durable="true"/>
    

    Warning: the connectors attribute value, from the connection-factory element, has to be defined. Since the kind of connectors is strongly reliant on the environment infrastructure, a default configuration can not be provided.

    See configuring messaging for more information.

  3. Add, at least, the following line to mail subsystem:

    <mail-session name="mail" debug="false" jndi-name="java:/EBX_MAIL_SESSION"/>

Data source and JDBC provider creation

  1. After the launch of the JBoss Server, run the management CLI without the use of '--connect' or '-c' argument.

  2. Use the 'module add' management CLI command to add the new core module. Sample for PostgreSQL configuration:

    module add \
      --name=org.postgresql \
      --resources=<PATH_TO_JDBC_JAR> \
      --dependencies=javaee.api,sun.jdk,ibm.jdk,javax.api,javax.transaction.api
    
  3. Use the 'connect' management CLI command to connect to the running instance.

  4. Register the JDBC driver. When running in a managed domain, be sure to precede the command with '/profile=<PROFILE_NAME>'. Sample for PostgreSQL configuration:

    /subsystem=\
      datasources/jdbc-driver=\
        postgresql:add(\
          driver-name=postgresql,\
          driver-module-name=org.postgresql,\
          driver-xa-datasource-class-name=org.postgresql.xa.PGXADataSource\
        )
  5. Define the datasource using the 'data-source add' command, specifying the appropriate argument values. Sample for PostgreSQL configuration:

    data-source add \
      --name=jdbc/EBX_REPOSITORY \
      --jndi-name=java:/EBX_REPOSITORY \
      --driver-name=postgresql \
      --connection-url=jdbc:postgresql://<SERVER_NAME>:<PORT>/<DATABASE_NAME> \
      --user-name=<PERSISTENCE_USER> \
      --password=<PERSISTENCE_PASSWORD>

Updating EBX® Enterprise Application aRchive

  1. Copy from EBX® CD the ebx.software/webapps/ear-packaging/EBX.ear file to your working directory.

  2. Uncompress the ear archive to add the application's specific required third-party libraries.

    Mail: see SMTP and emails for more information.

    SSL: see Secure Socket Layer (SSL) for more information.

    JMS: see Java Message Service (JMS) for more information.

    XML Catalog API: see XML Catalog API for more information.

  3. Compress anew the ear archive.

Deploying EBX®

  1. Copy EBX.ear into JBOSS_HOME/standalone/deployments folder.

Start EBX®

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

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

Documentation > Administration Guide > Installation & configuration > Installation notes