JBoss.orgCommunity Documentation

Chapter 1. Installation Guide

1.1. Installation
1.2. CXF Installation
1.3. Directory Structure Explained
1.3.1. /deploy/teiid/teiid-jboss-beans.xml
1.3.2. /deploy/teiid/connectors
1.3.3. /conf/props
1.3.4. /conf/jboss-teiid-log4j.xml
1.3.5. admin-console.war
1.3.6. /deployers/teiid.deployer
1.3.7. lib
1.3.8. teiid-examples
1.3.9. teiid-docs

Starting with the 7.0 release Teiid needs to be installed into an existing JBoss AS installation, which is entirely different from previous versions.


Teiid does not support the "embedded" mode in 7.2 version. ("embedded" will be coming in a future release).

Steps to install Teiid

  1. Download the JBoss AS 5.1.0 application server. Install the server by unzipping into a known location. Ex: /apps/jboss-5.1.0

  2. Download Teiid 7.2. Unzip the downloaded artifact inside any "profile" in the JBoss AS installation. Teiid 7.2 uses a JBoss AS service called the "profile service" that is only installed in "default" and "all" profiles, so installing into one of these profiles is required. The default profile is the typical installation location, for example "<jboss-install>/server/default". The Teiid runtime directory structure matches JBoss profiles directly - it is just an overlay.

  3. Start the JBoss AS server by executing "<jboss-install>/bin/run.sh" if you installed in the "default" profile. Otherwise use "<jboss-install>/bin/run.sh -c <profilename>"

  4. That it!. JBoss AS and Teiid are now installed and running. See below instructions to customize various settings.

  5. Once VDBs have been deployed, users can now connect their JDBC applications to Teiid. If you need help on connecting your application to the Teiid using JDBC check out the "Client Developer's Guide".

The usage of CXF is expected for utilizing Salesforce and Web Services connectivity through Teiid. If you do not plan on integrating either of these features, then you may leave JBoss AS with the default "native" web services stack.

  1. Download JBossWS-CXF 3.1.2 and unzip to a temporary location.

  2. From the jbossws-cxf-bin-dist directory, save the ant.properties.example file as ant.properties and change the values for jboss510.home, jbossws.integration.target, jboss.server.instance, jboss.bind.address accordingly:

    # The JBoss server under test. This can be [jboss500|jboss501|jboss510|jboss600]
    # The JBoss settings
    jboss.bind.address=<bind address>

    The jboss-install location should be the root directory of your AS installation, profile (typically default) should indicate the profile selected for your Teiid installation, and the bind address should be the bind address used when launching JBoss AS (use the value localhost if you do not set the bind address when launching JBoss AS).

  3. From the jbossws-cxf-bin-dist directory, install JBossWS-CXF by running the ANT build script:

    $ant deploy-jboss510
  4. Optionally run tests to verify that there are no errors with the installation:

    $ant tests