Talend Studio requires specific third-party Java libraries or database drivers
(.jar files) to be installed to connect to sources and
targets. Those libraries or drivers, known as external modules, can 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 certain external modules within
Talend Studio.

Identify required external modules

When you launch Talend Studio or select Help > Install Additional
Packages in the Talend Studio menu, if any external
modules are found missing for any features, the [Additional Talend
packages] wizard opens, showing the Optional
and Required third-party libraries check boxes. Make
sure these check boxes are selected and click Finish to
open the [Download external modules] dialog box, which
lists all the available external modules, displays the license terms under which the
external modules are provided, and lets you install all the modules at a single click.
For more information, see Install external modules.

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
to use the components embedded in the
Studio, including those Java libraries and drivers that you must install to get
the relevant components
or Metadata connection working.

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

The table below describes the information presented in the Modules view.

Column

Description

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 the Context column.

The icon indicates that the module
is absolutely required for the corresponding componentor Metadata
connection.

Context

lists the name of Talendcomponentor Metadata connection
using the module. If this column is empty, the module is then
required for the general use of Talend Studio.

Note

This column lists any external libraries added to the routines
you create and save in the Studio library folder. For more
information, see the Talend Studio
User Guide.

Module

lists the module exact name.

Description

explains why the module/library is required.

Required

the selected check box indicates that the module is
required.

In addition to the Modules view, the Studio provides
a mechanism that enables you to easily identify, download and install most of the
required third-party modules from the Talend website and directs you to valid websites
for the rest.

A Jar installation wizard appears whenever any required external module is found
missing for any feature in the Studio, including 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, or

click the Check button in a Metadata
connection setup wizard in Talend Studio if one or more external
modules required for the connection are missing in the Studio, or

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, or

click the
button in the Modules view.

Note

When you click this button, the wizard that appears will list all the
required external modules that are not integrated in the Studio.

The table below describes the information presented in the wizard.

Item

Description

Jar

The file name of the external module.

Module

A short description about the nature of the module.

Required by component

Lists the components that require the external module.

Required

The selected check box indicates that the module is
required.

License

The license under which the module is provided.

More information

Provides the URL of the valid website where you can find more
information about this module and download the module
manually.

Action

: Click to open
the [Download external modules]
dialog box to download and install the module, which is available on
the Talend website;

: Click the link
to open the valid website to download the module, which is not
available on the Talend website, and then
click the jar button to import the downloaded module into your
studio;

: You need to find and download
the module yourself and click the jar button to import it into the
your studio.

Click to open the [Download external
modules] dialog box to download and install all the
required modules that are available on the Talend website.

Do not show again

Select to prevent the wizard from appearing again unless you click
the button in the Modules tab view.

This check box shows only when you drop a component, set up a connection, or
guess the schema of a database, that requires an external module, or
click the Install button on the
Component tab of a component that
requires an external module.

This wizard lists the external modules to be installed, the licenses under which they
are provided, and the URLs of the valid websites where they are downloadable, and allows
you to download and install automatically all the modules available on the Talend website and download those not
available on the Talend website by following the links provided in the Action column and then install them into your Studio 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 website, 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.

Note

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

Install external modules

To download and install modules in the Studio

To download and install external modules automatically, do the following:

Warning

If you are working behind a network proxy, make sure you have correctly set up
your proxy before you can download and install external modules in your Studio.
To access the proxy settings, select Window >
Preferences from the menu to open the [Preferences] window, then expand the General node and click Network
Connections.

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, or select Help > Install Additional Packages
from the menu to open the [Additional Talend
Packages] wizard. From this wizard, make sure the Optional and
Required third-party libraries check boxes are selected and click Finish. The [Download external
modules] dialog box opens.

Note

This [Additional Talend Packages] wizard
appears automatically when you launch Talend Studio if any additional packages, including external
modules, need to be installed for any features to function in the
Studio.

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 start the download and installation process.

To download and install all external modules provided under all the listed
licenses, click the Accept all button to start
the download and installation process.

Upon installation of the chosen external module or modules, a dialog box
appears to notify you about the number of modules successfully installed and/or
about the modules failed to install, if any.

To install manually an external module you already have in your local file
system, do the following:

Click the
button in the upper right corner of the Modules view or in Jar installation wizard to browse your
local file system.

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 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.

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

You can now use the component or Metadata
connection dependent on this module in any of your Job
designs.

Warning

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 studio(s).

To install modules in CommandLine

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

Make sure CommandLine is not started, then download the external modules from
the Modules view as explained in the previous
procedure.

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 the Studio
and CommandLine respectively.

Since these folders are hidden, make sure your system is configured to show
hidden files and folders.

The <CommandLinePath>/configuration/.m2
folder is not created by default. It is created the first time you start the
CommandLine application.

Restart CommandLine.

You can now use the component
or
Metadata connection dependent on these modules.

To install modules manually for Talend Web applications

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

For Talend Administration Center, the downloaded modules must be placed in the following
folder: