Versions Compared

Key

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

Follow the these instructions below to install WSO2 Business Rules Server ESB on Windows.

Info
titleNote

Before you install the product, ensure that your system meets the minimum hardware and software requirements described in section, Installation Prerequisites.

Step 1. Obtain Installation Pack

Download the latest version of the program (for downloading instructions, refer to section, Downloading the Product).

Step 2. Extract the Archive

After the download is complete, extract installation files to the user-defined folder (further to be referred to as PRODUCT_HOME).

Code Block
unzip wso2brs-2.0.0.zip

Step 3. Set up JAVA_HOME

JAVA_HOME environment variable set up is needed to run WSO2 products. The variable points at the directory where the Java™ Alternatively, you can install it as a Windows service.

Installing the supporting applications

See Installation Prerequisites and install the necessary supporting applications.

Installing Business Rules Server

  1. If you have not done so already, download the latest version of Business Rules Server as described in Downloading the Product.
  2. Extract the archive file to a dedicated directory for Business Rules Server, which will hereafter be referred to as <PRODUCT_HOME>.

Setting JAVA_HOME

You must set your JAVA_HOME environment variable to point to the directory where the Java Development Kit (JDK) is installed on the computer.

Info
titleReference

Environment variables are global system variables accessible by all the processes running under the operating system.

Locate the Installation Folder of the Java™ Development Kit (JDK) on the Machine

1. In order to set the variable, it is necessary to know the system folder to which JDK is installed. Unless the installation path was changed by the user during the installation process, it is installed into the default folder Typically, the JDK is installed in a directory under C:\Program Files\Java. Open the directory , such as C:\Program Files\Java using the browser.2. Inside that path there will be one or more subdirectories, for example, \jdk1.56.0_0827. If you just have multiple versions installed the Java Development Kit, it is in the newest directory, choose the latest one, which you can find by sorting by date. For example, it may be installed in C:\Program Files\Java\jdk1.6.0_27 .

There are two ways to set up JAVA_HOME: via "System Properties", or via "Windows Command Prompt".

JAVA_HOME Setup via System Properties

Follow the instructions below to set up the JAVA_HOME environment variable using "System Properties".

Info

Environment variables are global system variables accessible by all the processes running under the operating system. You can define an environment variable as a system variable, which applies to all users, or as a user variable, which applies only to the user who is currently logged in.

You can set JAVA_HOME using the System Properties, as described below. Alternatively, if you just want to set JAVA_HOME temporarily in the current command prompt window, set it at the command prompt.

Setting JAVA_HOME using the System Properties

1. Right-click the "My Computer" icon on the desktop and select "choose Properties."

Image RemovedImage Added

2. The "In the System Properties " window opens with its functional tabs. Go to the "Advanced" tab and click the "Environment Variables" button.

Image Removed

3. The "Environment variables" window opens. Click the "New" window, click the Advanced tab, and then click the Environment Variables button.

Image Added

3. Click the New button under "System variables" (for all users) or under "User variables" (just for the user who is currently logged in).

Image RemovedImage Added

4. The "New system variable" input box opens. Fill in the required fieldsEnter the following information:

  • In the "Variable name" field, enter ": JAVA_HOME" without quotes.
  • In the "Variable value" field, enter the installation path of the Java Development Kit. For example, such as: c:\Program Files\Java jdk1.6.0_27.

5. In the "New User Variable" popup, fill in the required fields:

  • In the "Variable name" field, enter "JAVA_HOME" without quotes.
  • In the "Variable value" field, enter the installation path of the Java Development Kit, for example, C:\Program Files\java\jdk1.6.0_27.

6. Click "OK."

Info
title*"System variables"* or *"User variables"*?

In case there is a need to set up variables only for the user currently logged in, JAVA_HOME should be set up in "User Variables" (the same way as in "System variables"). These changes will not affect any other users.

Note
titleNotice

Variable set up will be effective for the CMD opened after this operation. In case a CMD had run before the variable was set up, this change will not be effective for it. To ensure the variable set up is effective, and variable value is reset, close and reopen the CMD you are running the product from, or close and re-open the browser (e.g. Total Commander) you are going to run the CMD from.

JAVA_HOME setup via Windows command prompt (CMD)

Alternatively, you . Click OK.

The JAVA_HOME variable is now set and will apply to any subsequent command prompt windows you open. If you have existing command prompt windows running, you must close and reopen them for the JAVA_HOME variable to take effect, or manually set the JAVA_HOME variable in those command prompt windows as described in the next section. To verify that the JAVA_HOME variable is set correctly, open a command window (from the Start menu, click Run, and then type CMD and click Enter) and execute the following command:

set JAVA_HOME

The system returns the JDK installation path.

Setting JAVA_HOME temporarily using the Windows command prompt (CMD)

Anchor
cmd
cmd

You can temporarily set the JAVA_HOME environment variable within a Windows command prompt window (CMD).

1. Open the "CMD" prompt. (Click the "Start" -> "Run" and then type "cmd" and click "OK" to run the CMD)

2. In the opened CMDThis is useful when you have an existing command prompt window running and you do not want to restart it.

1. In the command prompt window, enter the following command where <JDK_INSTALLATION_PATH> is the JDK installation directory and press "Enter":

Code Block
set JAVA_HOME=<JDK_INSTALLATION_PATH>

Where "<JDK_INSTALLATION_PATH>" is the actual JDK installation directory.

For example, :

set JAVA_HOME=c:\Program Files\java\jdk1.6.0_27

...

Image Removed

3. The JAVA_HOME variable is effectively set up.

...

titleNotice

...

now set for the current CMD session only.

Step 4. Verify JAVA_HOME Set Up

Follow the instructions below to check if 2. To verify that the JAVA_HOME was variable is set up correctly:

1. Open the "CMD" prompt. (Click the "Start" -> "Run" and then type "cmd" and click "OK" to run the CMD)

2. In the opened CMD window, enter the following command and press "Enter":

...

, execute the following command:

set JAVA_HOME

...

3. The program shows that JAVA_HOME is set to The system returns the JDK installation path, for example, JAVA_HOME=:c\Program Files\java\jdk1.6.0_27.
This means that JAVA_HOME was set up correctly.

Image Removed

Step 5. Execute Start Script

In order to launch the management console, it is necessary to execute the start script wso2server.bat from the bin folder.

1. Access Windows command prompt (go to "Start" -> "Run" and type "cmd" without quotes. Press "Enter").

2. Execute the following command:

Code Block
cd <PRODUCT_HOME>\bin

where <PRODUCT_HOME> is the installation folder of the product. For example, c:\wso2\wso2brs-2.0.0\bin.

3. Execute the following command:

Code Block
wso2server.bat --run

4. The operation log is displayed. For example,

Image Removed

If the server is started and running, a message appears as "WSO2 Carbon started in 'n' seconds."

Step 6. Stopping the Server

To stop the running server, simply hit Ctrl-C in the command window or choose the "Shutdown/Restart" link on the left-hand menu of the product's Management Console. For information on accessing the Management Console, refer to section Introducing the Management Console.

...

hiddentrue

...

.

Setting system properties

If you need to set additional system properties when the server starts, you can take the following approaches:

  • Set the properties from a script. Setting your system properties in the startup script is ideal, because it ensures that you set the properties every time you start the server. To avoid having to modify the script each time you upgrade, the best approach is to create your own startup script that wraps the WSO2 startup script and adds the properties you want to set, rather than editing the WSO2 startup script directly.
  • Set the properties from an external registry. If you want to access properties from an external registry, you could create Java code that reads the properties at runtime from that registry. Be sure to store sensitive data such as username and password to connect to the registry in a properties file instead of in the Java code and secure the properties file with the secure vault.

You are now ready to run the product.