Skip to main content Skip to complementary content

Building a Route to a Spring Boot Microservice (deprecated)


About this task

This build type is deprecated from 8.0 R2024-02 and will be removed in R2024-09. To build a Route with the new Microservice build type, you need to:
  • check the configuration for Microservices,
  • change the build type of your Route to Microservice and rebuild/test/redeploy it.
For more information, see Building a Route to a Microservice.
Information noteNote: The Java methods of the context object used in the cConfig or cProcessor component, for example keySet(), entrySet(), values(), size(), are not supported in Microservice build type. These methods are supported in OSGi build type only. Because in Spring-boot the ContextProperties has to be a POJO class and it cannot extend the java.util.Properties.

To build a Route to a Spring-boot based ESB Microservice, complete the following:


  1. Click Project properties on the Talend Studio toolbar, or select File > Edit Project Properties from the menu bar to open the Project Settings dialog box.
    Default configuration of Spring Boot Microservices
  2. In the tree diagram to the left of the dialog box, select Build > Spring Boot microservices > Default configuration to display the corresponding view and customize the Spring Boot Microservice configuration as needed.
  3. In the tree diagram to the left of the dialog box, select Log4j to display the corresponding view.
    Log4j configuration
  4. Customize the Log4j configuration as needed. The default Log4j XML instructions only output the WARN logs to the console. For more information on the log4j parameters, see Log4jXmlFormat.
    A sample Log4j configuration is shown below which will also provide a tesb.log file when the ESB Microservice is started. Note that the Log4j configuration is the same for Talend Studio and the ESB Microservice. Nevertheless a log4j.xml file can also be placed into an external configuration folder of the Microservice at runtime to provide a specific Log4j configuration for production deployment.
    <?xml version="1.0" encoding="UTF-8" ?>
    <!DOCTYPE log4j:configuration SYSTEM "log4j.dtd">
    <log4j:configuration xmlns:log4j="">
        <appender name="stdout" class="org.apache.log4j.ConsoleAppender">
            <layout class="org.apache.log4j.PatternLayout">
                <param name="ConversionPattern" value="%d | %-5.5p | %-16.16t | %-32.32C %4L | %m%n"/>
        <appender name="rollingFile" class="org.apache.log4j.RollingFileAppender">
            <param name="file" value="tesb.log"/>
            <param name="MaxFileSize" value="1024KB"/>
            <param name="MaxBackupIndex" value="10"/>
            <layout class="org.apache.log4j.PatternLayout">
                <param name="ConversionPattern" value="%d | %-5.5p | %-16.16t | %-32.32C %4L | %m%n"/>
            <priority value="info"/>
            <appender-ref ref="stdout"/>
            <appender-ref ref="rollingFile"/>
  5. If the Route contains the cSOAP or cREST component, you need to use relative endpoint URL instead of absolute URL. When the Microservice is running, an embedded Tomcat container with the default 8065 port is started by Spring-boot. The REST and Soap services also run in this port. If you want to override the default port, either use the --server.port option in the command or configure it in the file in the /config folder inside the Microservice jar.
    If the Route contains the cSOAP or cREST component, and if one or more of the ESB infrastructure services are used, you need to do the following before building the Route:
    • If the Service Activity Monitor is enabled, edit the <Studio_Home>/esb/ file to configure the Service Activity Monitoring Agent as needed. For more information about the properties of the agent.propeties, see the section on the Service Activity Monitoring Agent configuration in the Talend ESB Infrastructure Services Configuration Guide.

    • If the Service Locator is enabled, edit the <Studio_Home>/esb/ file to configure the Service Locator as needed. For more information about the properties of the, see the section on the Service Locator configuration in the Talend ESB Infrastructure Services Configuration Guide.

    • If the Route is a service provider and the Authentication with the Username Token is enabled, edit the Studio_Home/esb/microservice/ file to specify the authenticated user credentials following the format <USERNAME>=<PASSWORD>. For example, the following settings defines two users:

    • If the Authentication with the SAML Token, and Authorization is enabled, or if the Service Registry is used, you need to install the ESB enterprise artifacts into your local maven repository using the following commands from a console window:

      cd <TalendRuntimePath>/add-ons/maven-repo
      mvn clean package -s <Studio_Home>/configuration/maven_user_settings.xml
  6. Open the Route in the design work space. In the Deployment view of the Route tab, select Microservice (Spring Boot) in the Build Type list. Save the Route.
    Select the Microservice (Spring Boot) build type.
  7. In the Repository tree view, right-click the Route you want to build, and select Build Route to open the Build Route dialog box.
    Build Route dialog box.
  8. In the To archive file field, browse to the directory where you want to save your built Route.
  9. In the Route Version area, select the version number of the Route you want to build if you have created more than one version of the Route.
  10. In the Build Type area, select Microservice Spring Boot.
  11. In the options area, select:
    • The Export as ZIP option to export the Route to a .zip file, which provides an external config folder and start scripts to start the Microservice with the external config folder for Linux (.sh) and Windows (.bat). If this option is not selected, the Route is exported as a .jar file by default.

    • The Enable Prometheus metrics endpoint check box to build the Prometheus metrics endpoint into the Microservice to monitor the execution of Routes, JVM memory, CPU consumption, and so on. By default, this feature bridges all the JMX attributes and values into Prometheus. For more information about Prometheus, see the Prometheus documentation.
  12. Click Finish to validate your changes, complete the export operation and close the dialog box. A pop up window appears prompting you that Maven needs to be set to online to build the ESB Microservice, as some libraries have to be downloaded from the remote Maven repository. Talend Studio requires Internet access when you use the ESB Microservice feature. Talend Studio does not provide a pure offline mode for the ESB Microservice build operation. Click Yes to change Maven to online mode.
    Configure Maven Online.
    If the Finish operation leads to an error, you can find more information in the Talend Studio log file <Studio_Home>\workspace\.metadata\.log.


A .jar or .zip file for the Route is created in the defined place. You can run it independent of Talend Studio in standalone mode.

Did this page help you?

If you find any issues with this page or its content – a typo, a missing step, or a technical error – let us know how we can improve!