Installing external modules

Talend Studio requires specific third-party Java libraries or database drivers to be installed to connect to sources and targets.

Those libraries or database drivers, known as external modules, may be required by some of Talend components or by some connection wizards or by both. Due to license restrictions, Talend may not be able to ship some of these external modules within Talend Studio. You need to install them for your Studio to functional properly.

When to install external modules

Your Talend Studio will let you know when you need to install external modules and what external modules you need to install.

Your Talend Studio notify you about required external modules in several ways.

The Additional Talend packages wizard opens when you launch your Talend Studio if any additional packages, including external modules, need to be installed for any features to function in the Studio.
Tip: The Additional Talend packages wizard also opens when you select Help > Install Additional Packages from the Studio menu.
On your design workspace, if a component requires the installation of external modules before it can work properly, a red error indicator appears on the component. With your mouse pointer over the error indicator, you can see a tooltip message showing which external modules are required for that component to work.
When you open the Basic settings or Advanced settings view of a component for which one or more external modules are required, you will see a piece of highlighted information about external modules, followed by an Install button. Clicking the Install button opens a wizard that will show you the external modules to be installed.

The Modules view lists all the modules required for the Studio to work properly, including those Java libraries and drivers that you must install.

If the Modules view is not shown under your design workspace, go to Window > Show View... > Talend and then select Modules from the list.

In this view:

Item	Description
Filter text field	Allows you to search external modules based on the status, the context, the module file name, and the Maven URI.
Status	Points out if a module is installed or not installed on your system. The icon indicates that the module is not necessarily required for the corresponding component or Metadata connection listed in this column. The icon indicates that the module is absolutely required for the corresponding component or Metadata connection.
Context	Gives the name of the component or Metadata connection using the module. If this column is empty, the module is then required for the general use of your Talend Studio.
Module	Gives the exact name of the module.
Maven URI	Uniquely identifies the module deployment in Maven. You can customize the Maven URI of a module by clicking the Maven URI field and then clicking the [...] button that appears. For more information, see Customizing the Maven URI for external module deployment.
	Refreshes this view to reflect the latest module installation status. In case of collaborative work, once a required module is installed in one user's studio, the other users can simply refresh their Modules view to add this module to their own Talend Studio.
	Imports custom Maven settings from a local file.
	Exports custom Maven settings into a local file.
	Allows you to install an already downloaded external module into your Studio. For details, see Installing external modules manually using the Modules view
	Opens the JAR download and installation wizard, which will list all the selected external modules that are not integrated in Talend Studio.

A JAR installation wizard appears when you:
- drop a component from the Palette if one or more external modules required for that component to work are missing in the Studio.
- click the Check button in a Metadata connection setup wizard in the Studio if one or more external modules required for the connection are missing in the Studio.
- click the Guess schema button in the Component view of a component if one or more external modules required for that component to work are missing in the Studio.
- click Install on the top of the Basic settings or Advanced settings view of a component for which one or more required external modules are missing.
- run a Job that involves components or Metadata connections for which one or more required external modules are missing.
- select one or more modules that are not integrated in the Studio and click the button in the Modules view.
This wizard:
- lists the external modules to be installed and the licenses under which they are provided
- provides the default Maven URIs that identify the deployment of the modules
- provides the official web sites where you can learn more about the modules
- lets you download and install automatically all the modules available in the Talend repository
- allows you to install those not available in the Talend repository manually.
When you drop a component, set up a connection, or guess the schema of a database, that requires an external module for which neither the JAR file nor its download URL information is available on the Talend web site, the JAR installation wizard does not appear, but the Error Log view will present an error message informing you that the download URL for that module is not available. You can try to find and download it by yourself, and then install it manually into the Studio.

Tip: To show the Error Log view on the tab system, go to Window > Show views, then expand the General node and select Error Log.

Customizing the Maven URI for external module deployment

In Talend Studio, each external module is given a default URI to identify its deployment in Maven. When needed, you can change the Maven URI.

For example, when replacing an installed database driver with a new version, you need to specify another Maven URI for it.

Note:

Changing the Maven URI for an external module will affect all the components and metadata connections that use that module within the project.

When working on a remote project, your custom Maven URI settings will be automatically synchronized to the Talend Artifact Repository and will be used when other users working on the same project install the external module.

Procedure

In the Modules view, click the Maven URI you want to customize and then click the [...] button that appears.
The Install Module dialog box opens.
If you want to install another version of the external module, specify the full path to the module file in the Module File field, or click the [...] button to browse in your local file system.
Select the Custom MVN URI check box and enter a new URI in the field.
You can click the button next to the Default MVN URI field to copy the default Maven URI, then paste it in the Custom MVN URI field and modify it.
Click the Detect the module install status button and then OK to validate the custom URI and close the dialog box.

Results

The new Maven URI takes effect and is displayed in the Modules view, from which can export all your Maven URI changes into a local JSON file.

Installing external modules from within the Studio

You can download and automatically install most external modules using the wizard provided by your Talend Studio.

Before you begin

Make sure your Talend Studio has a secure internet connection.

Procedure

Do the following to open the Download external modules dialog box:
- In the Additional Talend Packages wizard, select the Required third-party libraries and/or Optional third-party libraries check boxes and click Finish.
- In the JAR installation wizard, click the Download and Install button to install a particular module, or click the Download and install all modules available button to install all the available modules.
Accept the license terms and start the download and installation process:
- To download and install the external module(s) provided under a particular license, select that license from the Licenses pane, review the license terms, select the I accept the terms of the license agreement option, and click Finish.
- To download and install all external modules provided under all the listed licenses, click the Accept all button.

Results

When the installation process is completed, the chosen external module or modules are installed into your Talend Studio, and you can use Talend Studio features that depend on these modules.

Installing external modules manually using the Modules view

If you have already downloaded external modules, you can install them manually into your Talend Studio.

Before you begin

If you are going to install the JDBC driver for Oracle 9i into your Talend Studio, change the file name from ojdbc14.jar to ojdbc14-9i.jar first.

Procedure

Click the button in the upper right corner of the Modules view or in the JAR installation wizard to browse your local file system.
In the Open dialog box of your file system, browse to the module you want to install, double-click the .jar file, or select it and then click Open to install it into your Talend Studio.

Results

The dialog box closes and the selected module is installed in the library folder of the current Talend Studio.

Installing external modules in the Talend CommandLine

If you use Talend Studio and Talend CommandLine on different machines, you need to retrieve the downloaded .jar files and add them in Talend CommandLine.

Before you begin

Make sure your system is configured to show hidden files and folders.
Check that the .jar files to be installed have been downloaded.
Make sure the <CommandLinePath>/configuration/.m2 folder already exists. This folder is created the first time you start the Talend CommandLine application.

Procedure

Shut down your Talend CommandLine if it is started.
Copy the downloaded .jar files from <StudioPath>/configuration/.m2 and paste them into <CommandLinePath>/configuration/.m2, where <StudioPath> and <CommandLinePath> are the installation directories of Talend Studio and Talend CommandLine respectively.
Restart your Talend CommandLine.

Results

You can now use the features dependent on these modules.

Installing external modules manually for Talend web applications

Some modules required for a Talend web application to work are not available on the Talend web site but can be downloaded directly from external web sites. Once downloaded, these modules must be placed in specific folders.

Procedure

For the Talend MDM Server, place the downloaded JDBC drivers for the Oracle and MySQL databases in the following folder:

<TomcatPath>/webapps/talendmdm/WEB-INF/lib
For Talend Administration Center, place the downloaded modules in the following folder:

<TomcatPath>/webapps/org.talend.administrator/WEB-INF/lib