How to install and update a custom component

EnrichVersion
6.5
EnrichProdName
Talend Big Data
Talend Open Studio for Data Integration
Talend Open Studio for MDM
Talend Open Studio for Big Data
Talend Data Fabric
Talend Open Studio for ESB
Talend Data Management Platform
Talend Big Data Platform
Talend ESB
Talend Data Integration
Talend Real-Time Big Data Platform
Talend Data Services Platform
Talend MDM Platform
task
Design and Development > Designing Components
EnrichPlatform
Talend Studio

How to install and update a custom component

Scalability and flexibility are key functions of Talend Studio.

You can create custom components by yourself or download community components from Talend Exchange, and install them into your Talend Studio.

There are more than 430 custom components available on Talend Exchange. These components are developed and shared by Talend Community users, you can download and install them into Talend Studio, and use them at no cost. This article explains how to install a custom component into Talend Studio. Possible issues and their solution are also provided in the article.

Installing a custom component

This example installs a custom component called tFileOutputPDF, which was shared by the Talend Community user cahsohtoa on Talend Exchange. You can also create your own component and import it into your Talend Studio.

Before you begin

Before installing the custom component tFileOutputPDF, you need to download it from the following location: https://exchange.talend.com/#marketplaceproductoverview:gallery=marketplace%252F1&pi=marketplace%252F1%252Fproducts%252F157%252Fitems%252F210. Note that when installing your own component, please just ignore this.

After you have downloaded the component from the Talend Exchange or exported as a zip your own component, you can install it into your Talend Studio via the following steps.

Procedure

  1. Unzip the archive file and copy the "tFileOutputPDF".component folder to the Clipboard.

    Note the following directory structure, and make sure you copy the right folder.

    tFileoutputPDF // copy this folder

    --- iText-2.0.8.jar

    --- tFileOutputPDF_begin.javajet

    --- tFileOutputPDF_end.javajet

    --- other component's files

  2. Paste the component folder to a dedicated directory where you will store all custom components, for example D:\custom_component\.
  3. In Talend Studio, click Window in the toolbar, then Preferences > Talend > Component.
  4. Browse to the dedicated component directory where you store all your custom components.
  5. Click OK. Talend Studio will reload all the components including the custom components.

    This configuration is stored in the metadata of the workspace. If the workspace of Talend Studio changes, you have to reset this configuration again.

  6. Check that you have successfully installed the component by searching the component name tFileOutputPDF in the Palette.

    If the component does not appear in the Palette, there are several possible causes:

    1. The XML file of component is not well configured. For example: tFileOutputPDF_java.xml for the component presented in the previous example. Open the XML file of component and make sure of the following:
      • The XML file should be well-formed.
      • The Family element should not be missing as this element specifies the component group in the Palette where the custom component is filed under. For example: <FAMILY>File/Management</FAMILY>.
      • The right elements are used in the XML file. To check this, simply compare your custom component XML file with the XML file of an official Talend component. All official components are located in <Talend Studio installation dir>\plugins\org.talend.designer.components.localprovider_x.x.x.rxxxxx\components\.
    2. The component folder pasted into your dedicated custom component directory was wrong. In this case, carry out the installation procedure again.

    If you get a missing jars error, when using the component in a Job, try the following procedure:

    1. Install the component again (without uninstalling the component installed previously).
    2. Delete the file <Talend Studio installation dir>\configuration\ComponentCache.javacache and restart Talend Studio.

      The file ComponentCache.javacache caches the dependencies and information of all components after the first launch of a Talend Studio. It avoids reloading all components at each start of the Talend Studio, saving some time. In case you need to remove this cache, then all components will need to be loaded again at the next start of the Talend Studio in order to build this cache again.

Update of a custom component

Talend Studio does not recognize automatically the changes made to the custom components folder. If you make changes to components located in the custom component folder, you can apply the changes by taking one of the following steps.

Procedure

  1. Press the Shift+Ctrl+F3 key combination to reload the components.
  2. Restart Talend Studio to reload the components.
  3. Go to Preferences > Talend > Component of your Talend Studio and click on Apply to take the edits into account.