Installing on Windows

Follow the instructions below to install WSO2 API Manager on Windows.

Note

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, Obtaining 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 CARBON_HOME).

unzip wso2am-1.2.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™ Development Kit (JDK) is installed on the computer.

Reference

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 C:\Program Files\Java. Open the directory C:\Program Files\Java using the browser.

2. Inside that path there will be one or more subdirectories, for example, jdk1.5.0_08. If you just have installed the Java Development Kit, it is in the newest directory, 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".

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

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

3. The "Environment variables" window opens. Click the "New" button under "System variables" (for all users).

4. The "New system variable" input box opens. 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.

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

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

Notice

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 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 CMD, enter the following command and press "Enter":

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.

3. JAVA_HOME is effectively set up.

Notice

A variable set via the SET command under CMD is a local variable, available to the current CMD session only.

Step 4. Verify JAVA_HOME Set Up

Follow the instructions below to check if JAVA_HOME was 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":

set JAVA_HOME

3. The program shows that JAVA_HOME is set to 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.

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:

cd <CARBON_HOME>\bin

where <CARBON_HOME> is the installation folder of the product. For example, c:\wso2\wso2am-1.2.0\bin.

3. Execute the following command:

wso2server.bat --run

4. The operation log is displayed.

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.