Installing your custom component automatically

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

Installing your custom component automatically

You can follow specific rules to create a zip for your component so that the Studio can recognize and install your component automatically.

This approach is applicable only when you are using one of the subscription-based Talend solutions.

Creating the component zip

You use specific commands to build separately the definition and the runtime parts to create your component zip.

Procedure

  1. From the definition folder of the project, my_components/components-google/components-google-definition in this example, execute the following commands sequentially to generate a *-updatesite.zip file in the target folder.
    mvn clean package
    mvn package -DskipTests -DskipITs -PgenerateP2

    Known issue: the <classifier>bundle</classifier> line could be missing in the pom.xml file of this definition part, if you generated this pom file using Talend Archetype. In this case, before executing the above-mentioned commands, add manually this line between the <configuration> and the <instructions> tags of the maven-bundle-plugin artifact in this pom file.

    For details of this known issue, see https://jira.talendforge.org/browse/TCOMP-627.

  2. From the runtime folder of the project, my_components/components-google/components-google-runtime in this example, execute the following command.
    mvn dependency:copy-dependencies -Dmdep.useRepositoryLayout=true -DoutputDirectory=target/plugin/m2/repository -DincludeScope=runtime -Dmdep.copyPom=false

    This command generates the required dependencies in the target/plugin/m2/repository folder.

    If you copy-paste this command from a PDF file, this command could have been broken into several lines. Restore this command into a single line before executing it.

  3. Move this target/plugin/m2 folder to the root of the *-updatesite.zip file.
    This makes the structure in the zip look like:

Adding the zip to the Studio

Create a patches folder and add this *-updatesite.zip file to it.

Procedure

  1. Stop the Studio.
  2. Create a folder and name it to "patches" in the Studio installation directory.
  3. Move the *-updatesite.zip archive to this patches directory.
  4. Start the Studio. The Studio recognizes and installs your component automatically and displays a message about the successful installation.
  5. Create a Job to open the Palette. tGoogleFustionTableInput is now listed under the Cloud/Fusion Tables family.