WSO2 Business Process Server v3.0.1 Documentation

##### Overview

- Home
- Release Note
- WS-BPEL Compliance
- License

##### Downloads

- Releases

##### Installation Guide

- Installing WSO2 BPS

##### Quick Start Guide

- Modeling the process
- Deploying the process
- Testing the process

##### User Guide

- Deploying BPEL Processes
- Deploying Human Tasks
- Managing BPEL processes
- Managing BPEL process instances
- QoS for BPEL processes
- Securing BPEL processes
- Invoking secured partner services
- Versioning
- Management API

##### Human Task Guide

- Human Tasks Quick Start Guide
- Deploying HumanTasks
- Managing Tasks
- Developing a Human Task Artifact
- Human Task Management and Configuration
- Human Task Concepts

##### Administrator Guide

- External data sources Configuration
- Registry Configuration
- Events
- Unified Endpoints
- BPEL Extensions
- Transaction Factory Configuration
- Message Exchange Interceptors
- OpenJPA specific properties
- JMS Transport Configuration
- Process Instance Cleanup Tasks
- Process Hydration and Dehydration
- Enabling Peer-to-Peer(P2P) Communication
- Setting up a BPS Cluster

##### Best Practices

- Process Deployment Best Practices

##### Concepts

- Process Versioning
- Process instance events
- Partner links

##### WS-BPEL Extensions

- Activity Failure and Recovery
- Extension Activities and Extensible Assign Operations
- XPath Extensions
- Iterable ForEach
- Flexible Assigns
- BPEL4People Extension

##### Samples

- HelloWorld
- If-Else
- ForEach
- While
- Repeat Until
- Flow and Links
- Pick
- Synchronous and Asynchronous Service Invocations
- Fault Handling
- Split
- XslTransform
- Compensation Handler
- Event Handler

##### Resources

- FAQ
- External Articles
- Library
- Source Code

##### Community

- Forum
- Mailing Lists

##### Project Information

- Issue Tracking

# Installation Guide

### Table of Content

- WSO2 Business Process Server (BPS) Installation Guide
- Installing other WSO2 features in WSO2 BPS
- Installing WSO2 CS
- Building WSO2 Business Process Server Using the Source Distribution
  - Prerequisites
  - Setting Up the Environment and Tools
  - Building WSO2 Business Process Server
- Enabling logging for various components in WSO2 Business Process Server

## WSO2 Business Process Server (BPS) Installation Guide

This document describes how to install and run WSO2 Business Process Server using binary distribution available for download. Binary Distribution includes binary files for both MS Windows and Linux operating systems as a zip file.

### Installing and Running WSO2 Business Process Server using the binary distribution

Prerequisites

Java SE Development Kit | 1.6.x (For instructions on setting up the JDK on different operating systems, visithttp://java.sun.com) To build WSO2 Business Process Server from the Source distribution, it is necessary that you have JDK 1.6.x version and Maven 2.2.0 or later
Web browser- To log-in to the BPS Management Console | Mozilla Firefox or Google Chrome at a resolution of 1024x768 or higher is recommended. MS Internet Explorer 7 or 8 can be used as well, with some limitations. Once the WSO2 Business Process Server is started point the browser to https://localhost:9443/carbon you can access your Management Console.
Memory | No minimum requirement - A heap size of 256~512MB is generally sufficient to process typical SOAP messages. Requirements may vary with larger message size and on the number of messages processed concurrently
Disk | No minimum requirement. The installation will require ~150MB excluding space allocated for log files and Databases.
Operating System | Linux, Solaris, MS Windows - XP/ Vista (Not fully tested on Windows Vista). As the WSO2 Business Process Server is a Java application, it will generally be possible to run it on other operating systems with a JDK 1.6.x runtime. Linux/Solaris is recommended for a production deployment.

### Installing on Linux / Unix

1. Download the WSO2 Business Process Server binary distribution.
2. Extract the zip archive where you want the WSO2 Business Process Server installed (e.g. into /opt)
3. Set the JAVA_HOME environment variable to your Java home using the export command or by editing /etc/profile, and add the Java /bin directory to your PATH
4. Execute the WSO2 Business Process Server start script from the bin directory. e.g. ./wso2server.sh OR ./wso2server.sh start
5. Check your WSO2 Business Process Server instance using the URL https://localhost:9443/carbon which will take you to the WSO2 Business Process Server Management Console.
6. Login as "admin" using the default password "admin"

### Installing on MS Windows

The following steps will take you through the installation for the MS Windows operating system.

1. Download the WSO2 Business Process Server binary distribution.
2. Extract the zip archive where you want the WSO2 Business Process Server installed
3. Set the JAVA_HOME environment variable to your Java installation, and the PATH environment variable to the Java /bin directory.
4. Execute the WSO2 Business Process Server start script from the bin folder. e.g. wso2server.bat
5. If you would like to install the WSO2 Business Process Server as a Windows service, use the install.bat script
6. Check your WSO2 Business Process Server instance using the URL https://localhost:9443/carbon which will take you to the WSO2 Business Process Server Management Console.
7. Login as "admin" using the default password "admin"

## Installing other WSO2 features in WSO2 Business Process Server

All the WSO2 Carbon based products function as a collection of solution specific features included on top of WSO2 Carbon platform based on OSGi. So you can convert a WSO2 BPS to any other WSO2 Carbon product by including those specific features. Please refer the following documentation on how to install a feature via feature manager for a step by step guide.
Note:You can use http://dist.wso2.org/p2/carbon/releases/4.0.5 as the repository compatible with this version (3.0.1) of WSO2 Business Process Server

## Installing WSO2 CS

WSO2 Carbon Studio provides the tooling environment for users to model, deploy and execute the WS-BPEL processes. Latest WSO2 Carbon Studio documentation is available here. Please follow the installation guide in above documentation to install WSO2 Carbon Studio.

## Building WSO2 Business Process Server Using the Source Distribution

### Prerequisites

Java SE Development Kit | 1.6.x (For instructions on setting up the JDK in different operating systems, visit http://java.sun.com)
Apache Maven- To build BPS from Source | To build the WSO2 Business Process Server from its source distribution, you will need Maven 3.0.3 or later
Operating System | Linux, Solaris, MS Windows - XP/ Vista (Not fully tested on Windows Vista)

### Setting Up the Environment and Tools

Maven:

The WSO2 Business Process Server build is based onApache Maven 3. Hence, it is a prerequisite to have Maven (version 3.0.3 or later) and JDK (version 1.6.0_24 or later) installed in order to build WSO2 Business Process Server from the source distribution. Extensive instructions on using Maven 3 are available on the Maven website.

Please refer to the Maven Getting Started Guide for more information on Maven

- Unix based OS (e.g., Linux)

1. Download Apache Maven tar ball or the zip archive.
2. Expand it to a directory of choice.
3. Set the environment variable M2_HOME and add M2_HOME/bin to the path as well.
4. Run mvn --version to verify that it is correctly installed.

- MS Windows

1. Download and run the Apache Maven Windows installer package.
2. Set the 'Environment Variables' (create the system variable M2_HOME and edit the path. e.g., "C:\Program Files\Apache Software Foundation\maven-3.0.3"; path %M2_HOME%\bin)
3. Make sure that the system variable JAVA_HOME is set to the location of your JDK, e.g., C:\Program Files\Java\jdk1.6
4. Run mvn --version to verify that it is correctly installed.

Once Maven is properly installed, you can start building the WSO2 Business Process Server.

### Building WSO2 Business Process Server

1. Download the source distribution, which is available as a zip archive.
2. Expand the source archive to a directory of your choice.
3. All the necessary build scripts are included with the source distribution.
4. You can run the following command inside that directory to build the WSO2 Business Process Server. Note that you will require a connection to the Internet for the Maven build to download dependencies required for the build.

   Command: mvn clean install

This will create the complete release artifacts including the binary and source distributions in the modules/distribution/target/ directory which can be installed using the above instructions.

Note: The first time you run Maven it will automatically download the dependent .jar files. Therefore, the first run will take more time.

## Enabling logging for various components in WSO2 Business Process Server

1. Add the following entries to the WSO2 Business Process Server-3.0.1/repository/conf/log4j.properties
   - log4j.logger.org.apache.ode.bpel.messagetrace=TRACE
   - log4j.logger.org.wso2.carbon.bpel.messagetrace=TRACE
2. Then the preferred log4j appender should be configured such that it has a threshold of TRACE level. If CARBON_LOGFILE is the log4j appender, it should be changed as follows. By default this is set to DEBUG.
   - eg - log4j.appender.CARBON_LOGFILE.threshold=TRACE
3. Then re-start the WSO2 Business Process Server server.
4. The log files can be found as WSO2 Business Process Server-3.0.1/repository/logs/wso2carbon.log

Note: You can configure this via Management console as well.