When to install external modules - Cloud - 8.0

Talend Studio User Guide

Version
Cloud
8.0
Language
English
Product
Talend Big Data
Talend Big Data Platform
Talend Cloud
Talend Data Fabric
Talend Data Integration
Talend Data Management Platform
Talend Data Services Platform
Talend ESB
Talend MDM Platform
Talend Real-Time Big Data Platform
Module
Talend Studio
Content
Design and Development
Last publication date
2024-02-27
Talend Studio will let you know when you need to install external modules and what external modules you need to install.

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

  • On your design workspace, if a component requires the installation of external modules before it can work correctly, a red error indicator appears on the component. With your 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 Talend 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.

    Modules view.

    This view contains the following items:

    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 Warning icon indicates that the module is not necessarily required for the corresponding component or Metadata connection.

    The Red cross warning icon indicates that the module is absolutely required for the corresponding component or Metadata connection.

    The tiny green dot in the top-right corner indicates that the Maven URI of the module has been customized. For more information, see Overriding a database driver by customizing the Maven URI.

    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 [...] that appears. For more information, see Customizing the Maven URI for external module deployment.

    Refresh icon Refreshes this view to reflect the latest module installation status.

    In case of collaborative work, once a required module is installed in Talend Studio of one user, the other users can simply refresh their Modules view to add this module to their own Talend Studio.

    Import icon Imports custom Maven settings from a local file.
    Export icon Exports custom Maven settings into a local file.
    Jar icon Allows you to install an already downloaded external module into Talend Studio. For details, see Installing external modules manually using the Modules view.
    Share libraries icon Shares libraries to the local libraries repository.

    This button is available only if the connection to the local libraries repository is successful.

    You can configure whether to share libraries at Talend Studio startup. For more information, see Artifact repository for libraries preferences.

    If you are using a local libraries repository configured with proxy, libraries will not be shared when clicking this button. For more information about configuring proxy for a local libraries repository, see Configuring a proxy repository for libraries in Talend Studio.

    Install third party libraries icon Opens the Third-party Libraries wizard, which allows you to install all required and/or optional libraries in one go. For more information, see Installing all external modules in one go.
  • 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 Talend Studio.
    • click the Test connection button in a Metadata connection setup wizard in Talend Studio if one or more external modules required for the connection are missing in Talend 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 Talend 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 Talend Studio and click the Download button in the Modules view.
    Modules view.

    This wizard provides different types of information and features:

    • 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 websites 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 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 Talend Studio.

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