Skip to end of metadata
Go to start of metadata

Teiid needs to be installed into an existing JBoss AS 7.1.1 installation.

Teiid provides an embedded kit, however it should be considered a tech preview as its APIs will likely evolve and there is sparse documentation.

Steps to install Teiid

  • Download the JBoss AS application server. Install the server by unzipping into a known location. Ex: /apps/jboss-7.1.1
You may also choose to use an existing AS installation. However if a previous version of Teiid was already installed, you must remove the old Teiid distribution artifacts before installing the new version.
  • Download Teiid. Unzip the downloaded artifact inside the JBoss AS installation. Teiid 8.3 directory structure matches JBoss AS directly - it is just an overlay. This will add necessary modules and configuration files to install Teiid in JBoss AS 7.1.1 in both Standalone and Domain modes. Teiid provides separate configuration files for both standalone mode and domain mode. Based on mode type you selected to run JBoss AS, you may have to run a CLI script to complete the Teiid installation.

The "Domain" mode recommended in a clustered environment to take advantage of clustered caching and cluster safe distribution of events. Teiid's default configuration for Domain mode through CLI script configured for high availability and clustered caching.

Standalone Mode

if you want to start the "standalone" profile, execute the following command

Installing Teiid using CLI script
The above is starting JBoss AS in a separate Teiid specific configuration that is based standalone.xml. However, if you already working with a predefined configuration for example default standalone.xml and would like to install Teiid into that configuration, then you can execute the following JBoss CLI script. First, start the server

then in a separate console window execute

this will install Teiid subsystem into the running configuration of the JBoss AS in standalone mode.

Domain Mode

To start the server in "Domain" mode, install the JBoss AS 7.1.1 and Teiid 8.3 on all the servers in are going to be part of the cluster. Select one of the server as the "master" domain controller, the rest of the servers will be slaves that connect to the "master" domain controller for all the administrative operations. Please refer to JBoss AS provided documentation for full details.

Once you configured all the servers, start the "master" node with following command

and on "slave" nodes

The slave nodes fetch their domain configuration from the "master" node.

Once all the servers are up, to complete the installation for the domain mode, run the following command against "master" node. Note that this only needs to be run for once per whole domain install. This script installs Teiid in HA profile. This also re-configures main-server-group to start the HA profile. Since in domain mode you can not statically deploy resources by dropping them in the domain/deployments folder, this script deploys default resources required (file, ldap, salesforce and ws connectors) using the CLI interface.

Installing "Teiid" in other profiles
If the Teiid needs to be installed in other profiles other than HA profile, edit the teiid-domain-mode-install.cli file, and make edits appropriately for profile, socket-bindings, server-groups and then run the above command.

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

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.

Directory Structure Explained

This shows the contents of the Teiid 8.3 deployment. The directory structure is exactly the same under any JBoss profile.

Directory Structure


Has installation and utility CLI scripts.


Has documents, examples, sample data source XML fragments and schema files. Contains artifacts need by the Quick Start Example.


  • standalone-teiid.xml - Master configuration file for Teiid system. This file contains Teiid subsystem in addition to standard JBoss AS web profile subsystems
  •, - These files define the allowed users and their defined roles in Teiid using the default security domain. Edit these files to add users. If you want to use a different security domain change the security domain details in main configuration file.


This directory contains all the resource-adapter RAR files that are supplied as part of the Teiid installation. Note that resource adaptors are not installed by default for the domain mode.


This directory defines the modules for JBoss AS 7.1.1 system


  •, - These files define the allowed users and their defined roles in Teiid using the default security domain. Edit these files to add users. If you want to use a different security domain change the security domain details in main configuration file.


This directory contains Teiid client libraries. It has the Teiid JDBC driver jar, "teiid-8.3.0.Final-jdbc.jar", and also contains "teiid-hibernate-dialect-8.3.0.Final.jar" that contains Teiid's Hibernate dialect.

{standlaone or domain}tmp/teiid

This directory contains temporary files created by Teiid. These are mostly created by the buffer manager. These files are not needed across a VM restart. Creation of Teiid lob values (for example through SQL/XML) will typically create one file per lob once it exceeds the allowable in memory size of 8KB. In heavy usage scenarios, consider pointing the buffer directory at a partition that is routinely defragmented.

{standlaone or domain}data/teiid-data

This directory contains cached vdb metadata files. Do not edit them manually.

Enter labels to add to this page:
Please wait 
Looking for a label? Just start typing.
  1. Jan 09, 2013

    I see mention of domain-teiid.xml for running teiid in domain mode but I cannot find it in the distribution zip or the installed directory structure. Could you point me to a specific location to retrieve this file? I've tried downloading the Teiid 8.3 alpha 2 zip and that did not have it either. Thanks.

  2. Jan 09, 2013

    I removed the references to domain-teiid.xml as that was old. You need to use the CLI script provided to finish the installation in domain mode.

    1. Apr 05, 2016

      Hi Ramesh,

      I am trying to run the quick starts, when I run with  .cli script, I am getting the error - 'module' is not found among the supported properties

      I tried mongo and data federation. Is there a version mismatch between teiid and jboss?

      Any thoughts??