This Confluence has been LDAP enabled, if you are an ASF Committer, please use your LDAP Credentials to login. Any problems file an INFRA jira ticket please.

Access to add and change pages is restricted. See:

Skip to end of metadata
Go to start of metadata



This is deprecated with last versions, for instance the appserver component has been moved first from framework to specialpurpose and then recently to OFBiz Attic#Appserver


As of OFBiz revision 663736 new templates have been added to the appserver component in OFBiz. This component contains necessary code to generate configuration files for deploying ofbiz inside various application servers.

The new templates are included in the directory framework/appserver/templates/jboss422.

Included here are several files:

1. - A template to generate a shell script to package and deploy OFBiz.
2. application.xml - A template to generate an applcation.xml file for the deployment of OFBiz web applications.
3. run.conf - A template which modifies the standard jboss run.conf file to include OFBIZ_HOME and memory settings.

To generate the configuration, install OFBiz into a permanent location on the same server where JBoss is installed. Make sure the revision is greater than or equal to 663736. This directory will become OFBIZ_HOME.

A patch is included here which updates to not attempt to load log4j.xml. This file is removed during deployment to not conflict with the log4j configuration which comes with JBoss. This patch will need to be applied before compiling OFBiz

Once OFBiz is installed, compile (using ant) and run the following command from the OFBiz directory:

$ java -jar ofbiz.jar -setup jboss422

The last argument is the name of the directory which contains the templates. If the desire to generate configuration files for other servers, use the name of the directory inside the template directory as this argument.

When this command finishes, a new directory will be created in the ofbiz home directory called 'setup'. Inside this directory will be subdirectories for each of the groups of templates (jboss422).

Create a new directory for the ofbiz deployment inside the JBoss deploy directory. Name this directory 'ofbiz.ear'; then copy the file OFBIZ_HOME/setup/jboss422/ to this new directory.

$ mkdir JBOSS_HOME/server/default/deploy/ofbiz.ear

From this location, run This must be run from inside the directory you wish to deploy OFBiz into. The script will package and deploy all the necessary libraries, webapps and configuration files into the JBoss exploded EAR (directory).

$ ./

Replace run.conf (in JBOSS_HOME/bin) with the generated in OFBIZ_HOME/setup/jboss422/run.conf. Or you can edit the existing file, setting a JAVA_OPTS '-Dofbiz.home=OFBIZ_HOME' (replace OFBIZ_HOME with the full path from above).

Start/restart JBoss for the changes to take effect.


The will execute the patch command on entityengine.xml using the patch file jboss-ee-cfg.patch (which is located in framework/appserver/templates/jboss422/patches) to output a new file named entityengine-jboss422.xml. If this file already exists, the script will not clobber the file in case it has been modified for customized deployment. Once deployed, the configuration will be found in framework.entity.config.jar.

The special entityengine-jboss422.xml file is only deployed when the script is run. This becomes the entityengine.xml which gets archived in the framework.entity.config.jar configuration library.

Once this file is generated, it can be edited. The edits will NOT be replaced each time the deployment script runs.

This new configuration file is then used when deploying OFBiz using the script and contains the following changes:

  1. Configures the Entity Engine to use JBoss Transaction Manager from JNDI.
  2. Configures the default delegator to use a Derby data source managed by JBoss and available via JNDI.

In addition to creating the entityengine.xml configuration, the script will also copy the derby-version.jar library and the derby-plugin.jar file into the JBoss lib directory.

Two datasources for JBoss are also configured using the templates found in framework/appserver/templates/jboss422/patches. These are derby-ds.xml and derby-ol-ds.xml. These get referenced in the custom entityengine.xml.


To install seed data you will need to run OFBiz in standalone mode; using the command:

$ java -jar ofbiz.jar -install [options]

Be sure the proper datasource and transaction manager are configured for standalone mode. Seed data cannot currently be loaded through JBoss.