Get CloverETL Server web archive file (
which is built for JBoss.
Check if you meet prerequisites
Oracle JDK or JRE version 1.6.x or higher
JBoss AS 6.0 or JBoss AS 5.1 - see http://www.jboss.org/jbossas/downloads
Memory settings for jboss java process. See section the section called “Memory Settings” for details.
You can set the memory limits in
run.conf.bat on Windows OS):
JAVA_OPTS="$JAVA_OPTS -XX:MaxPermSize=512m -Xms128m -Xmx2048m"
On Windows, perform steps analogic to the ones above.
Create separated JBoss server configuration
This step is optional, you can use predefined server configuration, e.g. "default". However it may be useful to use specific JBoss server configuration, when it is necessary to run CloverETL:
isolated from other JBoss applications
with different set of services
with different libraries on the classpath then other applications
Configure DB data source
Since JBoss does not work with embedded derby DB, a DB connection always has to be configured. We used MySQL in this case
Create datasource config file
<datasources> <local-tx-datasource> <jndi-name>CloverETLServerDS</jndi-name> <connection-url>jdbc:mysql://localhost:3306/cloverServerDB</connection-url> <driver-class>com.mysql.jdbc.Driver</driver-class> <user-name>root</user-name> <password></password> </local-tx-datasource> </datasources>
Special characters in the XML file have to be typed in as XML entities. For instance, ampsersand "&" as "&" etc.
JNDI name has to be exactly "CloverETLServerDS". The thing to do here is
to set DB connection parameters (
password) to the created database. The database has to be
empty before the first execution, the server creates its tables itself.
JNDI data source is the only way of configuring CloverETL Server DB connection in JBoss.
Put JDBC driver for your DB to the app server classpath. We copied JDBC driver
Configure CloverETL Server according to description in the next section.
Deploy WAR file
Start jboss via
run.bat on Windows OS)
If you want to run JBoss with specific server configuration, it must be specified as parameter like this:
[jboss-home]/bin/run.sh -c [serverConfiguration]
If the serverConfiguration isn't specified, the "default" is used.
It may take a couple of minutes until all applications are started.
Check JBoss response and CloverETL Server response
JBoss administration console is accessible at http://localhost:8080/ by default. Default username/password is admin/admin
CloverETL Server is accessible at http://localhost:8080/clover by default.
If you like, you can move default and example sandboxes (created automatically in
directory) to a more suitable directory on your filesystem.
These sandboxes are created automatically during the first deployment
and are located in the
web-app directory, which is related to the specific deployment.
If you redeployed the web application for a reason, the directory would be recreated.
That is why it is better to move the sandboxes to a location which will not change.
Default installation (without any configuration) is recommended only for evaluation purposes. For production, configurin at least tha DB data source and SMTP server is recommended.
There are more ways how to set config properties. The most common one is properties file in a specified location.
cloverServer.properties in a suitable directory
datasource.type=JNDI datasource.jndiName=java:/CloverETLServerDS jdbc.dialect=org.hibernate.dialect.MySQLDialect license.file=/home/clover/config/license.dat
Do not change
datasource.jndiName properties, but set a correct
JDBC dialect according to your DB server (Chapter 19, Configuration). Also set path to your license file.
Set system property (or environment property)
It should contain the full path to the
created in the previous step.
The simplest way is seting java parameter in
export JAVA_OPTS="$JAVA_OPTS -Dclover_config_file=/home/clover/config/cloverServer.properties"
Please do not override other settings in the
JAVA_OPTS property. i.e. memory settings described above.
On Windows OS, edit
add this line to the section where options are passed to the JVM:
set JAVA_OPTS=%JAVA_OPTS% -Dclover_config_file=C:\JBoss6\cloverServer.properties
This change requires restarting JBoss.
CloverETL Server requires a valid license for executing graphs. You can install CloverETL Server without a license, but no graph will be executed.
If you only have
extract it as a common
zip archive and you will find
Fill CloverETL Server parameter
license.file with path to
The best way how to configure license is setting
license.file property in the
file as described in the previous section.
There are other ways how to do this. (See Chapter 19, Configuration for description of all possibilities).
Changes in configuration require restarting the app-server.
Alternatively, you can use a web form to install CloverETL Server License. See details in the section called “Installation of CloverETL Server License using a web form”.
CloverETL license can be changed any time by replacing file