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

...

Info
titleBefore you begin:
  • Download and install the product.
  • 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.

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

...

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

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

Product ProfileStartup command
ESB profile
wso2ei-6.4.0-integrator
Business Process profile
wso2ei-6.4.0-business-process
Broker profile
wso2ei-6.4.0-broker
Micro Integrator profile
wso2ei-6.4.0-micro-integrator
MSF4J profile
wso2ei-6.4.0-msf4j
Analytics profile - Worker node
wso2ei-6.4.0-analytics-worker
Analytics profile - Dashboard
wso2ei-6.4.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."

Localtab
titleOn Windows

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

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.

...

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.  
    Image Modified 
  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.

    Image Modified 

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

...