Installing as a Windows Service

You can run any profile of WSO2 Enterprise Integrator as a Windows service as described in the following sections:

Before you begin:

To find out if this version of the product has issues running on your OS due to the JDK version, see the known incompatibilities section.
To find out if this version of the product is fully tested on your operating system, see the compatibility matrix.

Prerequisites

Install JDK and set up the JAVA_HOME environment variable. For more information, see Installation Prerequisites.
Download and install a service wrapper library. WSO2 recommends Yet Another Java Service Wrapper (YAJSW) version 11.03.

Step 1 - Setting up the YAJSW wrapper

YASJW uses the configurations defined in the <YAJSW_HOME>/conf/wrapper.conf file to wrap Java Applications. Replace it with the corresponding file out of the following to run a profile of WSO2 EI as a Windows service.

You can set additional configurations in the corresponding wrapper.conf file such as properties from an external registry at runtime, and sensitive information like usernames and passwords for connecting to the registry after securing them using secure vault.

ESB profile: <EI_HOME>/bin/yajsw/wrapper.conf
Business Process profile: <EI_HOME>/wso2/business-process/bin/yajsw/wrapper.conf
Message Broker profile: <EI_HOME>/wso2/broker/bin/yajsw/wrapper.conf
MSF4J profile: <EI_HOME>/wso2/msf4j/bin/yajsw/wrapper.conf
Analytics profile: <EI_HOME>/wso2/analytics/bin/yajsw/wrapper.conf

Step 2 - Setting up CARBON_HOME

Set the CARBON_HOME Windows environment variable to point to the directory of the corresponding profile of the extracted WSO2 EI directory location. For example, you need to set CARBON_HOME to the following directory paths based on the profile you want to run.

ESB profile: <EI_HOME>
Business Process profile: <EI_HOME>/wso2/business-process
Message Broker profile: <EI_HOME>/wso2/broker
MSF4J profile: <EI_HOME>/wso2/msf4j
Analytics profile: <EI_HOME>/wso2/analytics

Step 3 - Running WSO2 EI as a Windows service

You can run WSO2 EI as a Windows service by managing the service (i.e., install, start, stop, and uninstall the service) as follows.

Installing the service

To install the service, navigate to the <YAJSW_HOME>/bat/ directory in the Windows Command Prompt and execute the following command:

installService.bat

The console will display a message confirming that the service was installed.

To verify if the service was successfully created, search for Windows services in your device.

You view the WSO2 EI service added to the list of Windows services as shown below.

list of Windows services

Starting the service

To start the service, navigate to the <YAJSW_HOME>/bat/ directory in the Windows Command Prompt and execute the following command:

startService.bat

The console will display a message confirming that the service was started.

start the Windows service

Now, you can access the Management Console from your web browser via https://localhost:9443/carbon (i.e., for the ESB profile). For information on accessing the Management Console of other profiles, see Running the Product.

Stopping the service

To stop the service, navigate to the <YAJSW_HOME>/bat/ directory in the Windows Command Prompt and execute the following command:

stopService.bat

The console will display a message confirming that the service was stopped.

Uninstalling the service

To uninstall the service, navigate to the <YAJSW_HOME>/bat/ directory in the Windows Command Prompt and execute the following command:

uninstallServiceService.bat

The console will display a message confirming that the service was uninstalled.

uninstall the Windows service

Alternatively, when using YAJSW wrapper, you can start WSO2 EI in its Console mode. For this, navigate to the <YAJSW_HOME>/bat/ directory in the Windows Command Prompt and execute the following command:

runConsole.bat

If you set all the configurations properly for YAJSW, you will view the Console output similar to the following.

start WSO2 Ei in the Console mode

Now, you can access the Management Console from your web browser via https://localhost:9443/carbon (i.e., for the ESB profile). For information on accessing the Management Console of other profiles, see Running the Product.