This documentation is for WSO2 Enterprise Integrator version 6.5.0 . View documentation for the latest release in the 6.x.x family and the latest release in the 7.x.x family.

All docs This doc
Skip to end of metadata
Go to start of metadata

The following sections describe how to run the profiles of WSO2 Enterprise Integrator (WSO2 EI).

Starting the product profiles

Before you begin:

  • Download and install the product.
  • Apply the following changes:

     Verify your JDK settings

    As explained in the installation prerequisites, the default product installation uses OpenJDK. Therefore, you don't require a different JDK. However, if you have set up Oracle JDK or IBM JDK, be sure to apply the following settings to your product distribution.

    Some updates of JDK 1.8 (for example, JDK1.8.0_151) are affected by a known issue related to GZIP decoding. Until this issue is fixed, we recommend that you disable GZIP decoding for your product by following the steps given below. This will ensure that your product is not affected by the known issue.

    1. Open the catalina-server.xml file in each profile of WSO2 EI. Listed below are the folders that store this file for each profile:
      • For the ESB profile: <EI_HOME>/conf/tomcat/ directory.
      • For other profiles: <EI_HOME>/wso2/<PROFILE_NAME>/conf/tomcat/ directory (where <PROFILE_NAME> is the name of the profile).
    2. Set the compression parameter (under each of the connector configurations) to false as shown below:

    3. Restart the server.

    If you are using IBM JDK 1.8, be mindful of the following:

    • Change the value of the org.owasp.csrfguard.PRNG.Provider property to 'IBMJCE' in the file. This file is stored in the following locations:
      • For the ESB profile: The <EI_HOME>/conf/security/ directory
      • For other profiles: The <EI_HOME>/wso2/<PROFILE_NAME>/conf/security/ directory
    • The following steps are only required for the Message Broker profile.

      1. Replace all the 'SunX509' entries in the <EI_HOME>/wso2/broker/conf/broker.xml file with 'IbmX509' as follows:

          <sslConnection enabled="true" port="8672">
      2. Change the value of the org.owasp.csrfguard.PRNG.Provider property to 'IBMJCE' in the <EI_HOME>/wso2/broker/conf/security/ file.

     Update the MSF4J profile

    Before you start the MSF4J profile, be sure to deploy the microservices that you want to run on the server. To do this, add the JARs of your services to the <EI_HOME>/wso2/msf4j/deployment/microservices/ directory.

     Update the Analytics profile
    • When starting the analytics profile, you may intermittently get a BindException error (i.e., Cannot assign requested address: Service 'sparkDriver' failed after 16 retries!if the Apache Spark client does not start properly (due to an issue in socket binding on computers with multiple IP interfaces). Add the same hostname that you specify in the /etc/hosts file of your system as the value of the <HostName> element in the <EI_HOME>/wso2/analytics/conf/carbon.xml file to rectify this.
    • If you get the Caused by: java.lang.IllegalArgumentException: java.lang.NoClassDefFoundError: Could not initialize class org.xerial.snappy.Snappy exception when starting WSO2 EI Analytics in certain environments such as Windows or Red Hat linux, download the snappy-java_1.1.1.7.jar file and add it to the <EI_HOME>/lib directory.

Using the product installer

If you installed the product through the product installer, do the following to start the profiles:

Open a terminal and execute the relevant command from the list given below.

Product ProfileStartup command
ESB profile
sudo wso2ei-6.5.0-integrator
Business Process profile
sudo wso2ei-6.5.0-business-process
Broker profile
sudo wso2ei-6.5.0-broker
MSF4J profile
sudo wso2ei-6.5.0-msf4j
Analytics worker
sudo wso2ei-6.5.0-analytics-worker
Analytics dashboard
sudo wso2ei-6.5.0-analytics-dashboard

The operation log keeps running until the profile starts, which usually takes several seconds. Wait until the profile fully boots up and displays a message similar to "WSO2 Carbon started in n seconds."

Go to Start Menu -> Programs -> WSO2 -> Enterprise Integrator 6.5.0 <PROFILE_NAME>. This will open a terminal and start the relevant profile.

Using the binary distribution

If you installed the product using the binary, do the following to start the profiles:

  1. Install Oracle Java SE Development Kit (JDK) version 1.8.* and set the JAVA_HOME environment variable.
  2. Open a terminal and navigate to the <EI_HOME>/bin/ directory, where <EI_HOME> is the home directory of your product distribution.
  3. Execute the relevant command from the list given below:

    Product ProfileStartup command
    ESB profile
    Business Process profile
    Broker profile
    Micro Integrator profile
    MSF4J profile
    Analytics profile

    Note: If you have installed the product using the installer, and you want to manually run the profile startup script from the /bin directory, you need to run the 'sudo launcher_<profile_name>.sh' command. This script automatically assigns the JAVA HOME of your VM to the root user of your product instance.

    Product ProfileStartup command
    ESB profile
    Business Process profile
    Broker profile
    Micro Integrator profile
    MSF4J profile
    Analytics profile

Stopping the product profiles

To stop a profile, press Ctrl+C in the command window, or click Shutdown/Restart in the navigation pane of the management console. 

Running the ESB profile via WSO2 Integration Studio

Before you begin, be sure to install both WSO2 Integration Studio and the WSO2 EI product.

Follow the steps below to run the WSO2 Enterprise Integrator (EI) server via WSO2 Integration Studio.

  1. Be sure that you have installed Oracle Java SE Development Kit (JDK) version 1.8.* and set the JAVA_HOME environment variable.
  2. Open WSO2 Integration Studio and click Miscellaneous → Add Server in the Getting Started tab as shown below.

  3. In the New Server dialog that opens, select the required product version:
  4. Click Next and go to the New WSO2 Carbon 4.4 based server Runtime step.
  5. Click Browse for the CARBON_HOME option and select the <EI_HOME> directory (parent directory of the product binary distribution).


    If you are running on a linux-based system (MacOS, Ubunto, or CentOS), be sure that your WSO2 EI distribution is a binary distribution downloaded from the website. If you use a product distribution that was set up using the product installer, you will require special permissions to start the product through WSO2 Integration Studio.

  6. Click Next and go to the New WSO2 Carbon 4.4 based Server step. Keep the default ports as shown below:

  7. Click Next and go to the Add and Remove step. If you have created any composite applications (in your instance of WSO2 Integration Studio) that you want to upload to your server, add them. You can also remove any unwanted applications from the server.

    If you want to add multiple composite applications at once, select Add All.


  8. Click Finish. You can view the added server instance in the Servers tab.

  9. Click the Start icon in the Server tab to start the server:

Signing in to the management console

When you start a WSO2 server, the URL of the management console will be printed on the terminal. Copy this URL to your browser and sign in to the management console using admin as both the username and password.

When the management console sign-in page appears, the Web browser typically displays an "insecure connection" message, which requires your confirmation before you can continue.

The management console is based on the HTTPS protocol, which is a combination of HTTP and SSL protocols. This protocol is generally used to encrypt the traffic from the client to server for security reasons. The certificate it works with is used for encryption only and does not prove the server identity. Therefore, when you try to access the management console, a warning of untrusted connection is usually displayed. To continue working with this certificate, some steps should be taken to "accept" the certificate before access to the site is permitted. If you are using the Mozilla Firefox browser, this usually occurs only on the first access to the server, after which the certificate is stored in the browser database and marked as trusted. With other browsers, the insecure connection warning might be displayed every time you access the server.

If you want to make the management console available to external users, your organization should obtain a certificate signed by a well-known certificate authority, which verifies that the server actually has the name it is accessed by and that this server actually belongs to the given organization.

What's next?

  • No labels