JBoss

Home \| Table of Contents	JBoss
Prev	Enterprise Server	Next

Installation of CloverETL Server

Get CloverETL Server web archive file (clover.war) which is built for JBoss.
Check if you meet prerequisites
- Oracle JDK or JRE version 1.6.x or higher
- JBoss 6.0 or JBoss 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 [jboss-home]/bin/run.conf (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
See the JBoss manual for details about JBoss server configuration: JBoss Server Configurations Start the Server With Alternate Configuration
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 [jboss-home]/server/[serverConfiguration]/deploy/mysql-ds.xml
```
<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>              
```
  Note
  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 (connection-url, driver-class,user-name and 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 mysql-connector-java-5.1.5-bin.jar to [jboss-home]/server/[serverConfiguration]/lib
Configure CloverETL Server according to description in the next section.
Deploy WAR file
Copy clover.war to [jboss-home]/server/[serverConfiguration]/deploy
Start jboss via [jboss-home]/bin/run.sh (or 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 the temp 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.

	Note
Special characters in the XML file have to be typed in as XML entities. For instance, ampsersand "&" as "&" etc.

Configuration of CloverETL Server on JBoss

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.

Properties File in Specified Location

Create 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.type and datasource.jndiName properties, but set a correct JDBC dialect according to your DB server (Chapter 18, Configuration). Also set path to your license file.
Set system property (or environment property) clover_config_file.
It should contain the full path to the cloverServer.properties file created in the previous step.
The simplest way is seting java parameter in [jboss-home]/bin/run.sh, e.g.:
```
	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 [jboss-home]/bin/run.conf.bat and 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.

Installation of CloverETL Server License

CloverETL Server requires a valid license for executing graphs. You can install CloverETL Server without a license, but no graph will be executed.

Get the license.dat file.
If you only have clover_license.war, extract it as a common zip archive and you will find license.dat in the WEB-INF subdirectory
Fill CloverETL Server parameter license.file with path to license.dat.
The best way how to configure license is setting the license.file property in the cloverServer.properties file as described in the previous section.
There are other ways how to do this. (See Chapter 18, Configuration for description of all possibilities).
Changes in configuration require restarting the app-server.

Note

	Note
CloverETL license can be changed any time by replacing file `license.dat`. Then you have to let CloverETL Server know the license is changed. Go to web GUI → Configuration → CloverETL Info → License Then click Reload license. Alternatively, you can restart CloverETL Server application.

CloverETL license can be changed any time by replacing file license.dat. Then you have to let CloverETL Server know the license is changed.

Go to web GUI → Configuration → CloverETL Info → License
Then click Reload license.
Alternatively, you can restart CloverETL Server application.

Prev	Up	Next
Glassfish / Sun Java System Application Server	Home \| Table of Contents	Oracle WebLogic Server