This documentation is for WSO2 Enterprise Integrator version 6.3.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

Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

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

Table of Contents
maxLevel4
minLevel3

Starting the product profiles

Info
titleBefore you begin:
  • Download and install the product. The instructions given below assume that you have used the product installer to install your WSO2 EI.
  • Apply the following changes:

    Expand
    titleVerify 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.

    Localtab Group
    Localtab
    titleOracle JDK

    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:

      Code Block
      compression="off"
    3. Restart the server.
    Localtab
    titleIBM JDK

    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 Owasp.CsrfGuard.Carbon.properties 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:

        Code Block
        languagexml
          <sslConnection enabled="true" port="8672">
            <keyStore>
                <location>repository/resources/security/wso2carbon.jks</location>
                <password>wso2carbon</password>
                <certType>IbmX509</certType>
            </keyStore>
            <trustStore>
                <location>repository/resources/security/client-truststore.jks</location>
                <password>wso2carbon</password>
                <certType>IbmX509</certType>
            </trustStore>
        </sslConnection>
      2. Change the value of the org.owasp.csrfguard.PRNG.Provider property to 'IBMJCE' in the <EI_HOME>/wso2/broker/conf/security/Owasp.CsrfGuard.Carbon.properties file.

    Expand
    titleUpdate 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.

    Expand
    titleUpdate 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.

To start each of the profiles in WSO2 EI, do the following:

Panel
borderColor#542989
bgColor#ffffff
borderWidth2
Localtab Group
Localtab
titleOn MacOS/Linux/CentOS

Open a terminal and execute the relevant command from the list given below. Note that the following commands apply only if you have used the installer to set up your product. Alternatively, you canmanually execute the profile startup script to run the product.

Product ProfileStartup command
ESB profile
wso2ei-6.3.0-integrator
Business Process profile
wso2ei-6.3.0-business-process
Broker profile
wso2ei-6.3.0-broker
Micro Integrator profile
wso2ei-6.3.0-micro-integrator
MSF4J profile
wso2ei-6.3.0-msf4j
Analytics profile
wso2ei-6.3.0-analytics

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."

Localtab
titleOn Windows

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

Anchor
run_product_manually
run_product_manually
Alternatively, you can manually execute the profile startup script to start the product:

Expand
titleClick to see the instructions
  1. Open a terminal and navigate to the <EI_HOME>/bin/ directory, where <EI_HOME> is the home directory where the product is installed.
  2. Execute the relevant command from the list given below:

    Localtab Group
    Localtab
    titleOn MacOS/Linux/CentOS
    Product ProfileStartup command
    ESB profile
    sh integrator.sh
    Business Process profile
    sh business-process.sh
    Broker profile
    sh broker.sh
    Micro Integrator profile
    sh micro-integrator.sh
    MSF4J profile
    sh msf4j.sh
    Analytics profile
    sh analytics.sh
    Localtab
    titleOn Windows
    Product ProfileStartup command
    ESB profile
    integrator.bat
    Business Process profile
    business-process.bat
    Broker profile
    broker.bat
    Micro Integrator profile
    micro-integrator.bat
    MSF4J profile
    msf4j.bat
    Analytics profile
    analytics-worker.bat
Excerpt
hiddentrue

Note that the following are hidden as they are not yet implemented with the installer.

To start the product profiles in the background, use the following command:

Code Block
wso2ei-6.3.0-integrator - start

To provide access to the production environment without allowing any user group (including admin) to log in to the Management Console:

Code Block
wso2ei-6.3.0-integrator --run -DworkerNode

To check for additional options you can use with the startup commands, type -help after the command, such as: 

Code Block
wso2ei-6.3.0-integrator -help

If you want to optimize the size of the distribution and run a selected profile, execute the following scripts:

  • On Linux/Mac OS: sh profile-creator.sh

  • On Windows: profile-creator.bat

However, this creates a distribution of the selected profile in the <EI_HOME> directory and deletes all the files that are not required to run the selected profile. Therefore, you may lose any changes you did to the other profiles.

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 Tooling

Info

Before you begin, be sure to install both Enterprise Integrator Tooling and the WSO2 EI product.

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

  1. Click the ServersTab in WSO2 EI Tooling, and click the No servers are available. Click this link to create a new server... link.  
     
  2. Expand the WSO2 drop down and select the preferred version of the product.  
  3. Click Next.
  4. Click the Browse button of the CARBON_HOME option.
  5. Browse and select the <EI_HOME> directory, which is the parent directory of the product binary distribution.
  6. Click Next in the New WSO2 Enterprise Integrator 6.3.0 Runtime window, and then click Next again in the New WSO2 Carbon 4.4 based Server window.
  7. In the Available section of the Add and Remove window, select any Composite Applications, which you created via WSO2 EI Tooling that you want to upload to WSO2 EI.

    Tip

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

     

  8. Click Add and then click Finish. You can view the WSO2 EI server added in the Servers tab.
     
  9. Right-click the name of the server at localhost and then click Start.
Excerpt
hiddentrue

To start the product profiles in the background, use the following command:

Code Block
wso2ei-6.3.0-integrator - start

To provide access to the production environment without allowing any user group (including admin) to log in to the Management Console:

Code Block
wso2ei-6.3.0-integrator --run -DworkerNode

To check for additional options you can use with the start-up commands, type -help after the command, such as: 

Code Block
wso2ei-6.3.0-integrator -help

If you want to optimize the size of the distribution and run a selected profile, execute the following scripts:

  • On Linux/Mac OS: sh profile-creator.sh

  • On Windows: profile-creator.bat

However, this creates a distribution of the selected profile in the <EI_HOME> directory and deletes all the files that are not required to run the selected profile. Therefore, you may loose any changes you did to the other profiles.

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.

Info

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?