Common Sample Project Libraries and Deployment
Introduction
Getting Set Up
ActiveBPEL Enterprise Deployment
ActiveBPEL Engine Deployment

Common Sample Project Libraries and Deployment

Introduction

This document contains information on the Java library jars needed to build the components of the samples that are a part of the support included with your ActiveBPEL™ Designer or Enterprise product (also provided by the ActiveBPEL Samples page). It also includes references to information on deployment of Business Process Archive (BPR) files as well as custom function and utility jars described in the various samples.

Getting Set Up

Each sample uses a number of jars during compilation and at run time. Most of these jars are supplied as part of your ActiveBPEL distribution.This archive contains an Ant build script that can be used to set up copies of these jars for access by the various Ant build scripts and/or Eclipse projects included in each of the Sample archives. It also contains some external jars that aren't part of the ActiveBPEL distribution. These external jars are contained in a subdirectory named ext.

Once you have downloaded this archive (the Zip file is located here, gzipped tar file here), you can extract it to a location of your choosing. With that done, create an environment variable called AESAMPLES_LIB and set it to point to lib (i.e., the root directory of this archive). For example, if you're using Windows XP, open a command window and use the set command to create the AESAMPLES_LIB environment variable. If you extracted the archive to a directory off of your root named AESamples, then you would execute the following:

set AESAMPLES_LIB=\AESamples\lib

Modify this to reflect your system and chosen library location as needed.

Creating the Sample Library

The build script included in this sample provides a number of build targets that will copy the necessary jar files from your ActiveBPEL product install directory to the directory referenced by the AESAMPLES_LIB environment variable. These targets are:

ActiveBPEL - (default) creates a copy of the jars installed with the free ActiveBPEL Designer / Engine product.

Tomcat - creates a copy of the jars installed with the ActiveBPEL Enterprise for Tomcat product.

JBoss - creates a copy of the jars installed with the ActiveBPEL Enterprise for JBoss product.

WebLogic - creates a copy of the jars installed with the ActiveBPEL Enterprise for WebLogic product.

WebSphere - creates a copy of the jars installed with the ActiveBPEL Enterprise for WebSphere product.

To create the working library of jar files for working with the Samples, identify which product type you'll be using, open a command window, navigate to the lib directory (i.e., the root directory of this archive) and execute the following:

ant [target]

Where [target] is one of the targets listed above. This will cause the script to delete any old jars in the lib directory and copy those used by the product indicated. Use ant clean to remove all jars from the lib directory.

Accessing ActiveBPEL and External Jars at Build, Deployment and Run Time

Many of the Sample archives contain Eclipse projects. These projects typically include a Build Path, and that build path uses an Eclipse Project Variable called AESAMPLES_LIB to locate the jars needed at build and run time. When working in Eclipse, one manual step you may need to perform is to create an AESAMPLES_LIB variable for the project's Java Build Path (i.e., you may see "Unbound classpath variable"; errors for the project). Create the variable by right-clicking on the project in the Package Explorer and selecting Properties. Next, select Java Build Path, select the Libraries tab, and click the Add Variable... button. Click the Configure Variables... button in the dialog that appears, and then New... Create an AESAMPLES_LIB variable that points to the \AESamples\lib directory (or wherever you've put it) that you get when you extract the samples library archive. Click OK to exit the dialogs and answer Yes if asked to do a full rebuild of the project.

Most of the Sample archives also include Ant build scripts to build and/or deploy some components. These scripts will typically contain the following set of property constructs:

This is the script's means of finding the ActiveBPEL and external jars needed at build, deployment and/or run time. Be sure that the AESAMPLES_LIB environment variable is set so that this property points to the appropriate location.

Additional Considerations for WebLogic and WebSphere

The ActiveBPEL Enterprise EAR for WebLogic and WebSphere must be located prior to building the jar file set for either of these platforms (if the EAR does not physically reside on the system, or an accessible network share, where you'll be executing the Ant script, you'll need to copy it to an accessible location). Identify this fully-qualified location by setting the WEBLOGIC_EAR or WEBSPHERE_EAR environment variable, as appropriate, before running the script.

Deployment for ActiveBPEL Enterprise Users

The deployment of Business Process Archives, custom function implementations and other artifacts (e.g., WSUnit test response files) varies depending upon the product you're using and the environment in which you're using it.

Detailed instructions on deployment of BPEL processes (i.e., Business Process Archives) may be found in the ActiveBPEL™ Enterprise User’s Guide included with your server (ActiveBPELServerUser.pdf).

Detailed instructions on deployment of custom function implementations may be found in ActiveBPEL™ Enterprise Administration Console Help (AdministrationConsole.pdf).

Deployment for ActiveBPEL Engine Users

When operating in the ActiveBPEL engine environment run with Tomcat or JBoss, deployment is straightforward: copy the BPR file (either created manually or using ActiveBPEL Designer) to the CATALINA_HOME/bpr directory. CATALINA_HOME is the standard environment variable defined for the Tomcat installation, and the bpr subdirectory is created when the ActiveBPEL engine is installed.

For detailed information on process deployment, see the deploy sample.

Java archives (.jar files) containing implementations for things like custom functions and the like - executable libraries that need to be accessible to the engine at run time - are deployed by copying them to the CATALINA_HOME/shared/lib directory. Test environments that utilize WSUnit need sample data deployed to the server. One convenient place for this is CATALINA_HOME/shared/classes.