JBoss.orgCommunity Documentation

Chapter 6. Connector Deployment

6.1. Overview
6.2. Connector Type Definition File
6.2.1. Required Properties
6.2.2. Connector Properties
6.3. Extension Modules
6.3.1. Extension Modules
6.3.2. Understanding the Connector Classpath
6.4. Connector Archive File
6.5. Importing the Connector Archive
6.5.1. Into Teiid Server
6.5.2. Into Enterprise or Dimension Designer
6.6. Creating a Connector Binding
6.6.1. In Console
6.6.2. In Designer

Once you have written and compiled the code for your connector, there are several steps to deploy your connector to a Teiid Server:

This chapter will help you perform these steps.  

A Connector Type Definition file defines a connector in the Teiid Server.  The Connector Type Definition file defines some key properties that allow the Teiid Server to use your connector as well as specifying other properties your connector might need.  

A Connector Type Definition file is in XML format and typically has the extension “.cdk”.  It defines a default name for the connector type, the properties expected by the connector, and other information that allows the properties to be displayed correctly in the Console when a Connector Binding is created from the Connector Type.  

An example of this file can be found in Appendix A. It may be helpful to refer to this file while reading this section. The template file can also be created using the Connector Development Kit.

Most connectors will require some initialization parameters to connect to the underlying enterprise information system.  These properties can be defined in the Connector Type Definition file along with their default values and other property metadata.  The actual property values can be changed when the connector is deployed in the Teiid Console.

Each connector property carries with it several attributes that are used by the Teiid Console to integrate the connector seamlessly into the Teiid Server.

Table 6.2. All Properties

Property Name

Example Value




Property name – should only contain letters, no spaces or other punctuation.  This is the name of the property as it will be passed to the connector in the ConnectorEnvironment.


Example property

The property name as displayed in the Console.  Typically this is a nicely formatted version of the Name attribute.


The example property is used to control something.

A short description that is displayed as a tooltip of the property in the Teiid Console.



A default value for the property.  This value will be auto-filled when a connector binding is created from the Connector Type.



If the multiplicity is set to “1”, then this property is required.  If the multiplicity is set to “0..1”, the property is optional and will not be displayed in the connector binding properties panel until the user clicks the “Optional properties” checkbox.   Any required property without a value is displayed in red in the connector binding properties panel.  Other values for the multiplicity are not supported.



If set to”true”, the property will be hidden in all connector binding property panels and the value cannot be set.  Hidden properties should always set a default value.  



If set to “false”, the property is visible but not modifiable in the properties panel.  



If set to “true”, the property will be masked with *’s when it is entered and saved in an encrypted form.  This attribute is typically used with passwords.



All “preferred” properties are sorted in alphabetical order at the top of the connector binding properties panel.



Depending on the property display, the property can be optionally displayed for advanced users.



Constrains the property to a subset of values, that are listed as subelements to the PropertyDefinition.  For example,



The short name of a built-in Java primitive wrapper Object type.  Other possible values include Integer, Boolean, etc.



Denotes how to delimit multiple values (not currently utilized by the Console).

The Connector Archive file is a bundled version of all files needed by this Connector to execute in the Teiid server. This file includes the Connector Type Definition file and all the Extension Modules required by the Connector to create a connector archive file (CAF)..

The file created by the CDK can be opened with any zip file utility to verify the required files are included.

The archive file can be tested in the CDK tool by loading it using the command “loadArchive”.  Refer to Chapter 4 for more information on the CDK tool

To actually use your connector in the Teiid System, you must create a Connector Binding that specifies the specific property values for an instance of the Connector Type.  To create a Connector Binding, perform the following steps:

To actually start your connector binding, please consult the Teiid Console User’s Guide for detailed information.