This chapter describes a quick installation example of TIBCO EBX® on Tomcat Application Server.
It does not replace the documentation of this application server.
They 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.
Tomcat 10.x is not supported.
The complete description of the components needed by EBX® is given in 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.
The description below uses the variable name $CATALINA_HOME to refer to the directory into which you have installed Tomcat, and from which most relative paths are resolved. However, if you have configured Tomcat for multiple instances by setting a $CATALINA_BASE directory, you should use $CATALINA_BASE instead of $CATALINA_HOME for each of these references.
Create EBX_HOME directory: copy ebx.properties
Copy EBX® and third-party libraries: add libraries (jar files) to Tomcat lib directory
Configure JVM arguments (Java system properties): create the JAVA_OPTS environment variable
Deploy EBX® application: copy all war files to Tomcat webapps directory
Java SE 8 or 11
Apache Tomcat 8.x
Database and JDBC driver
EBX® CD
To download Tomcat 8.x, choose a core binary distributions from https://tomcat.apache.org/download-80.cgi
Run the installer or extract the archive and perform standard installation with default options
Create EBX_HOME directory, for example C:\EBX\home, or /home/ebx
Copy from EBX® CD the ebx.software\files\ebx.properties file to EBX_HOME. In our example, we will then have the following file:
C:\EBX\home\ebx.properties, or /home/ebx/ebx.properties, a text file
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 databases and it is required to comment the h2.standalone one.
Copy third-party library files to $CATALINA_HOME\lib\ (or $CATALINA_BASE\lib\) directory. In our example, we will have:
$CATALINA_HOME\lib\mail.jar
$CATALINA_HOME\lib\h2.jar (default persistence factory)
$CATALINA_HOME\lib\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 chapter Components. Obviously, if those components are already deployed on the class-loading system, they do not have to be duplicated
Modify the $CATALINA_HOME\conf\server.xml (or $CATALINA_BASE\conf\server.xml) file. Add the following line to the <Host> element
<Context path="/ebx" crossContext="true" docBase="ebx.war"/>
After this modification, we will have:
<Host name=...>
... ...
<Context path="/ebx" crossContext="true" docBase="ebx.war"/>
... ...
</Host>
Modify the $CATALINA_HOME\conf\catalina.properties (or $CATALINA_BASE\conf\catalina.properties) file. Add the following lines to the tomcat.util.scan.DefaultJarScanner.jarsToSkip property:
ebx.jar,\
ebx-addons.jar,\
Configure the launch properties
If our Tomcat is launched by a command in Windows' Command Prompt or Unix shell, we can create another launcher file:
For Windows, edit the launcher file %CATALINA_HOME%\bin\startup.bat, and add the following command lines:
set EBX_HOME="<path_to_the_directory_ebx_home>" set EBX_OPTS="-Debx.home=%EBX_HOME% -Debx.properties=%EBX_HOME%\ebx.properties" set JAVA_OPTS="%EBX_OPTS% %JAVA_OPTS%"
or for Linux, edit the launcher file $CATALINA_HOME/bin/startup.sh, and add the following command lines:
EBX_HOME="<path_to_the_directory_ebx_home>"
EBX_OPTS="-Debx.home=${EBX_HOME} -Debx.properties=${EBX_HOME}/ebx.properties"
export JAVA_OPTS="${EBX_OPTS} ${JAVA_OPTS}"
(!) Accounts used to launch EBX® must have create/update/delete rights on EBX_HOME directory.
Windows users that have installed Tomcat as a service may set Java options through the Tomcat service manager GUI (Java tab).
Be sure to set options on separate lines in the Java Options field of the GUI:
-Debx.home=<path_to_the_directory_ebx_home> -Debx.properties=<path_to_the_directory_ebx_home>\ebx.properties
where <path_to_the_directory_ebx_home> is the directory where we copied ebx.properties. In our example, it is C:\EBX\home, or /home/ebx
Copy from EBX® CD the ebx.software\lib\ebx.jar file to $CATALINA_HOME\lib\ (or $CATALINA_BASE\lib\) directory. In our example, we will have:
$CATALINA_HOME\lib\ebx.jar
Copy from EBX® CD the war files in ebx.software\webapps\wars-packaging to the $CATALINA_HOME\webapps\ (or $CATALINA_BASE\webapps\) directory. In our example, we will have:
$CATALINA_HOME\webapps\ebx.war: Initialization servlet for EBX® applications
$CATALINA_HOME\webapps\ebx-root-1.0.war: Provides a common default module for data models
$CATALINA_HOME\webapps\ebx-manager.war: Master Data Management web application
$CATALINA_HOME\webapps\ebx-dataservices.war: Data Services web application
$CATALINA_HOME\webapps\ebx-dma.war: Data Model Assistant web application
$CATALINA_HOME\webapps\ebx-ui.war: User Interface web application
After Tomcat launch, run EBX® web application: http://localhost:8080/ebx/
At first launch, EBX® Wizard helps you to configure the default properties of your initial repository.