Editing user routine libraries - Cloud

Talend Cloud Data Management Platform Studio User Guide

Version
Cloud
Language
English (United States)
Product
Talend Cloud
Module
Talend Management Console
Talend Studio
Content
Design and Development

You can edit the library of a user routine by importing external libraries (usually .jar files) for it.

If you have installed the R2021-03 Studio monthly update or a later one provided by Talend, you can import external libraries for an inner routine by editing the library of the custom routine jar in which the inner routine is bundled.

These external library files will be listed, like modules, in the Modules view in your current Studio. For more information on the Modules view, see the Talend Installation Guide .

The imported library will be also listed in the library file of your Studio.

About this task

To edit the library for a user routine or a custom routine jar, complete the following:

Procedure

  1. If the library to be imported is not available on your machine, either download and install it using the Modules view or download and store it in a local directory.
  2. In the Repository tree view, right-click the user routine or the custom routine jar and then select Edit Routine Libraries or Edit Routine Jar libraries.
    The Import External Library dialog box displays.

    The Maven Uri column is available only if you have installed the R2020-11 Studio monthly update or a later one provided by Talend.

  3. Click New... to open the Module dialog box where you can import the external library.
  4. If you have installed the library using the Modules view, select the Platform option and then select the library from the list, or
    • if you have not installed the R2020-10 Studio monthly update or a later one provided by Talend, select the Artifact repository (local m2/nexus) > Find by name or Artifact repository (local m2/nexus) > Find by Maven URI option, then specify the full name or Maven URI of the library module, and click the Detect the module install status button to validate its installation status.
    • if you have installed the R2020-10 Studio monthly update or a later one provided by Talend, select the Artifact repository (local m2/nexus) option, enter the search keyword in the Module Name field, click Search Local to search in the local repository <TalendStudio>\configuration\.m2 or click Search Remote to search in the remote artifact repository, then select the library from the list below. The search keyword can be the partial or full name of the library.

      Note that the Search Remote button is available only when the user libraries is set up in Talend Administration Center or Talend Management Console.

  5. If you have stored the library file in a local directory, select the Install a new module option, and click the [...] button to browse to the library file.

    If the MVN URI of the library exists in the file <TalendStudio>\configuration\MavenUriIndex.xml, it is automatically filled in the Default MVN URI field.

    • If you have not installed the R2020-10 Studio monthly update or a later one provided by Talend, and if you need to customize the Maven URI of the library, select the Custom MVN URI check box, specify the new URI, and then click the Detect the module install status button to validate its installation status.
    • If you have installed the R2020-10 Studio monthly update or a later one provided by Talend, and if the MVN URI of the library is within the jar file, it is automatically detected and filled in the Custom MVN URI field if it is different from the default MVN URI. Select the Custom MVN URI check box if you want to change the custom Maven URI or use the custom Maven URI to install the library. If neither the default MVN URI nor the custom MVN URI exists, the Default MVN URI field is filled with mvn:org.talend.libraries/<jarname>/6.0.0-SNAPSHOT/jar.
  6. Click OK to confirm your changes.
    The imported library file is listed in the Library File list in the Import External Library dialog box.
    Note: You can delete any of the already imported routine files if you select the file in the Library File list and click Remove.
  7. To include the external libraries when building your Job as a standalone Job to be executed out of Talend Studio, select the corresponding Required check box. Otherwise, you will get the "class not found" error when the Job is executed.
    By default, the Required check box is selected for each imported library.
    If you have imported Camel or CXF libraries and you need to build your Job as an OSGI bundle to be deployed on Talend Runtime, it is recommended that you clear the Required check box to avoid issues caused by duplicate class paths, as those libraries are already provided with Talend Runtime bundles.
  8. Click Finish to close the dialog box.