This tutorial walks you through the most common iteration steps to create a component with Talend Component Kit and to deploy it to Talend open studio. The component created in this tutorial is a simple processor that reads data coming from the previous component in a job or pipeline and displays it in the console logs of the application, along with an additional information entered by the final user. The component designed in this tutorial is a processor and does not require nor show any datastore and dataset configuration. Datasets and datastores are required only for input and output components. To get your development environment ready and be able to follow this tutorial: Download and install a Java JDK 1.8 or greater. Download and install Talend open studio. For example, from Sourceforge. Download and install IntelliJ. Download the Talend Component Kit plugin for IntelliJ. The detailed installation steps for the plugin are available in this document. The first step in this tutorial is to generate a component skeleton using the Starter embedded in the Talend Component Kit plugin for IntelliJ. Start IntelliJ and create a new project. In the available options, you should see Talend Component. Make sure that a Project SDK is selected. Then, select Talend Component and click Next. The Talend Component Kit Starter opens. Enter the component and project metadata. Change the default values, for example as presented in the screenshot below: The Component Family and the Category will be used later in Talend open studio to find the new component. Project metadata is mostly used to identify the project structure. A common practice is to replace 'company' in the default value by a value of your own, like your domain name. Once the metadata is filled, select Add a component. A new screen is displayed in the Talend Component Kit Starter that lets you define the generic configuration of the component. By default, new components are processors. Enter a valid Java name for the component. For example, Logger. Select Configuration Model and add a string type field named level. This input field will be used in the component configuration for final users to enter additional information to display in the logs. In the Input(s) / Output(s) section, click the default MAIN input branch to access its detail, and make sure that the record model is set to Generic. Leave the Name of the branch with its default MAIN value. Repeat the same step for the default MAIN output branch. Because the component is a processor, it has an output branch by default. A processor without any output branch is considered an output component. You can create output components when the Activate IO option is selected. Click Next and check the name and location of the project, then click Finish to generate the project in the IDE. At this point, your component is technically already ready to be compiled and deployed to Talend open studio. But first, take a look at the generated project: Two classes based on the name and type of component defined in the Talend Component Kit Starter have been generated: LoggerProcessor is where the component logic is defined LoggerProcessorConfiguration is where the component layout and configurable fields are defined, including the level string field that was defined earlier in the configuration model of the component. The package-info.java file contains the component metadata defined in the Talend Component Kit Starter, such as family and category. You can notice as well that the elements in the tree structure are named after the project metadata defined in the Talend Component Kit Starter. These files are the starting point if you later need to edit the configuration, logic, and metadata of the component. There is more that you can do and configure with the Talend Component Kit Starter. This tutorial covers only the basics. You can find more information in this document. Without modifying the component code generated from the Starter, you can compile the project and deploy the component to a local instance of Talend open studio. The logic of the component is not yet implemented at that stage. Only the configurable part specified in the Starter will be visible. This step is useful to confirm that the basic configuration of the component renders correctly. Before starting to run any command, make sure that Talend open studio is not running. From the component project in IntelliJ, open a Terminal and make sure that the selected directory is the root of the project. All commands shown in this tutorial are performed from this location. Compile the project by running the following command: mvnw clean install. The mvnw command refers to the Maven wrapper that is embedded in Talend Component Kit. It allows to use the right version of Maven for your project without having to install it manually beforehand. An equivalent wrapper is available for Gradle. Once the command is executed and you see BUILD SUCCESS in the terminal, deploy the component to your local instance of Talend open studio using the following command: mvnw talend-component:deploy-in-studio -Dtalend.component.studioHome="open studio home>". Replace the path with your own value. If the path contains spaces (for example, Program Files), enclose it with double quotes. Make sure the build is successful. open Talend open studio and create a new Job: Find the new component by looking for the family and category specified in the Talend Component Kit Starter. You can add it to your job and open its settings. Notice that the level field specified in the configuration model of the component in the Talend Component Kit Starter is present. At this point, the new component is available in Talend open studio, and its configurable part is already set. But the component logic is still to be defined. You can now edit the component to implement its logic: reading the data coming through the input branch to display that data in the execution logs of the job. The value of the level field that final users can fill also needs to be changed to uppercase and displayed in the logs. Save the job created earlier and close Talend open studio. Go back to the component development project in IntelliJ and open the LoggerProcessor class. This is the class where the component logic can be defined. Look for the @ElementListener method. It is already present and references the default input branch that was defined in the Talend Component Kit Starter, but it is not complete yet. To be able to log the data in input to the console, add the following lines: The @ElementListener method now looks as follows: open a Terminal again to compile the project and deploy the component again. To do that, run successively the two following commands: mvnw clean install `mvnw talend-component:deploy-in-studio -Dtalend.component.studioHome="open studio home>" The update of the component logic should now be deployed. After restarting Talend open studio, you will be ready to build a job and use the component for the first time. To learn the different possibilities and methods available to develop more complex logics, refer to this document. If you want to avoid having to close and re-open Talend open studio every time you need to make an edit, you can enable the developer mode, as explained in this document. As the component is now ready to be used, it is time to create a job and check that it behaves as intended. open Talend open studio again and go to the job created earlier. The new component is still there. Add a tRowGenerator component and connect it to the logger. Double-click the tRowGenerator to specify the data to generate: Add a first column named firstName and select the TalendDataGenerator.getFirstName() function. Add a second column named 'lastName' and select the TalendDataGenerator.getLastName() function. Set the Number of Rows for RowGenerator to 10. Validate the tRowGenerator configuration. open the TutorialFamilyLogger component and set the level field to info. Go to the Run tab of the job and run the job. The job is executed. You can observe in the console that each of the 10 generated rows is logged, and that the info value entered in the logger is also displayed with each record, in uppercase.

To be able to see and use your newly developed components, you need to integrate them to the right application. Currently, you can deploy your components to Talend studio as part of your development process to iterate on them: Iterating on component development with Talend studio You can also share your components externally and install them using a component archive (.car) file. Sharing and installing components in Talend studio Check the versions of the framework that are compatible with your version of Talend studio in this document. If you were used to create custom components with the Javajet framework and want to get to know the new approach and main differences of the Component Kit framework, refer to this document.

Integrate components you developed using Talend Component Kit to Talend studio in a few steps. Also learn how to enable the developer and debugging modes to iterate on your component development. The version of Talend Component Kit you need to use to develop new components depends on the version of Talend studio in which components will be integrated. Refer to this document to learn about compatibility between Talend Component Kit and the different versions of Talend applications. Learn how to build and deploy components to Talend studio using Maven or Gradle Talend Component Kit plugins. This can be done using the deploy-in-studio goal from your development environment. If you are unfamiliar with component development, you can also follow this example to go through the entire process, from creating a project to using your new component in Talend studio. The studio integration relies on the Component Server, that the studio uses to gather data about components created using Talend Component Kit. You can change the default configuration of component server by modifying the $studio_HOME/configuration/config.ini file. The following parameters are available: Name Description Default component.environment Enables the developer mode when set to dev - component.debounce.timeout Specifies the timeout (in milliseconds) before calling listeners in components Text fields 750 component.kit.skip If set to true, the plugin is not enabled. It is useful if you don’t have any component developed with the framework. false component.java.arguments Component server additional options - component.java.m2 Maven repository that the server uses to resolve components Defaults to the global studio configuration component.java.coordinates A list of comma-separated GAV (groupId:artifactId:version) of components to register - component.java.registry A properties file with values matching component GAV (groupId:artifactId:version) registered at startup. Only use slashes (even on windows) in the path. - component.java.port Sets the port to use for the server random components.server.beam.active Active, if set to true, Beam support (Experimental). It requires Beam SDK Java core dependencies to be available. false component.server.jul.forceConsole Adds a console handler to JUL to see logs in the console. This can be helpful in development because the formatting is clearer than the OSGi one in workspace/.metadata/.log. It uses the java.util.logging.SimpleFormatter.format property to define its format. By default, it is %1$tb %1$td, %1$tY %1$tl:%1$tM:%1$tS %1$Tp %2$s%n%4$s: %5$s%6$s%n, but for development purposes [%4$s] %5$s%6$s%n is simpler and more readable. false Here is an example of a common developer configuration/config.ini file: The developer mode is especially useful to iterate on your component development and to avoid closing and restarting Talend studio every time you make a change to a component. It adds a Talend Component Kit button in the main toolbar: When clicking this button, all components developed with the Talend Component Kit framework are reloaded. The cache is invalidated and the components refreshed. You still need to add and remove the components to see the changes. To enable it, simply set the component.environment parameter to dev in the config.ini configuration file of the component server. Several methods allow you to debug custom components created with Talend Component Kit in Talend studio. From your development tool, create a new Remote configuration, and copy the Command line arguments for running remote JVM field. For example, -agentlib:jdwp=transport=dt_socket,server=y,suspend=n,address=*:5005, where: the suspend parameter of the -agentlib argument specifies whether you want to suspend the debugged JVM until the debugger attaches to it. Possible values are n (no, default value) or y (yes). the address parameter of the -agentlib argument is the port used for the remote configuration. Make sure this port is available. open Talend studio. Create a new Job that uses the component you want to debug or open an existing one that already uses it. Go to the Run tab of the Job and select Use specific JVM arguments. Click New to add an argument. In the popup window, paste the arguments copied from the IDE. Enter the corresponding debug mode: To debug the runtime, run the Job and access the remote host configured in the IDE. To debug the Guess schema option, click the Guess schema action button of the component and access the remote host configured in the IDE. From your development tool, create a new Remote configuration, and copy the Command line arguments for running remote JVM field. For example, -agentlib:jdwp=transport=dt_socket,server=y,suspend=n,address=*:5005, where: suspend defines whether you need to access the defined configuration to run the remote JVM. Possible values are n (no, default value) or y (yes). address is the port used for the remote configuration. Make sure this port is available. Access the installation directory of your Talend Sutdio. open the .ini file corresponding to your Operating System. For example, TOS_DI-win-x86_64.ini. Paste the arguments copied from the IDE in a new line of the file. Go to Talend studio to use the component, and access the host host configured in the IDE. If you run multiple studio instances automatically in parallel, you can run into some issues with the random port computation. For example on a CI platform. For that purpose, you can create the $HOME/.talend/locks/org.talend.sdk.component.studio-integration.lock file. Then, when a server starts, it acquires a lock on that file and prevents another server to get a port until it is started. It ensures that you can’t have two concurrent processes getting the same port allocated. However, it is highly unlikely to happen on a desktop. In that case, forcing a different value through component.java.port in your config.ini file is a better solution for local installations.

In order to use Talend Component Kit, you need the following tools installed on your machine: Java JDK 1.8.x. You can download it from Oracle website. Talend open studio to integrate your components. A Java Integrated Development Environment such as Eclipse or IntelliJ. IntelliJ is recommended as a Talend Component Kit plugin is available. Optional: If you use IntelliJ, you can install the Talend Component Kit plugin for IntelliJ. Optional: A build tool: Apache Maven 3.5.4 is recommended to develop a component or the project itself. You can download it from Apache Maven website. You can also use Gradle, but at the moment certain features are not supported, such as validations. It is optional to install a build tool independently since Maven and Gradle wrappers are already available with Talend Component Kit.