Contents

List of Figures

List of Tables

List of Code Examples

Preface

About This Manual

Developing iPlanet Process Manager Applications
Interacting with Clusters and Deployed Applications

Conventions Used in This Manual
Viewing Documentation
For More Information

Chapter 1 Writing Custom Activities

Introduction

Comparison to Automated Activities
Overview of Creating a Custom Activity

Implementing ISimpleWorkPerformer

Methods of ISimpleWorkPerformer

The init( ) method
The perform( ) method
The destroy( ) method

Sample Java Class

Creating HelloWorldPerformer.java

Writing the XML Description File

File Format

WORKPERFORMER Tag
ENVIRONMENT Section
INPUT Section
OUTPUT Section
PARAMETER Tag
DESIGN Section

Sample XML Description File

Packaging a Custom Activity
Adding a Custom Activity to the Process Map

Adding a Custom Activity from a Custom Palette
Adding a Custom Activity without Using a Custom Palette

Working with a Custom Activity
Implementation Tips

Avoid Instance Data
Use Consistent Data Types
Avoid Non-default Constructors
Use One Implementation of a Java Class Per Server
When to Use a Custom Activity

Example Custom Activity

Chapter 2 Writing Custom Data Fields

Introduction

Steps for Creating a Custom Field

Defining Field Properties in a JSB File

JSB_DESCRIPTOR Tag
JSB_PROPERTY Tag

JSB_PROPERTY Attributes
Required Data Field Properties

Writing the Java Classes

Define a Subclass of BasicCustomField
Implementing Data Field Methods

About the loadDataElementProperties Method
About the display Method
About the update Method
About the create Method
About the load Method
About the store Method
About the archive Method

Specifying Images for Use in Process Builder
Packaging a Custom Field
Adding a Custom Field to an Application
Example Custom Data Field
Development Hints and Tips

Avoid Non-default Constructors
Avoid Instance Data
Use Entity Keys
Deploy the Custom Field to Test It
Develop and Test on a Server Where iPlanet Process Manager is Installed
Use One Implementation of a Java Class Per Server
Debugging Hints

Print Debugging Information
Send Error Messages to the Process Manager Logs
Errors in store()

Class Reference
BasicCustomField

archive()
create()
display()
getName()
getPMApplication()
getPrettyName()
load()
loadDataElementProperties()
store()
update

IPMRequest

getAuthenticatedUserId
getParameter
isParameterDefined

Chapter 3 Advanced Office Setup Application

Changes in the Advanced Office Setup Application
The Custom Data Field

Overview
The Code in Detail

loadDataElementProperties ()
display()
update()
store()
load()
Helper Functions

Complete Source Code

The Custom Activity

Overview
The Code in Detail

EmployeeTrainingPerformer.xml
perform()
Helper Functions

Complete Source Code

Chapter 4 Cluster Management

Introduction
IPMClusterManager
IPMCluster
IPMClusterProperty

Getting and Setting Property Values
Setting Properties When Creating Clusters
Other Cluster Properties

PMClusterPropertyFactory
Code Samples

Mount the Cluster Manager and Get the Default Cluster
Create a Cluster
Get and Set Cluster Properties

Chapter 5 Deployment Manager

Deployment States

STAGE
MODE
STATUS
TESTING

IDeploymentManager Interface

Where are the Classes and Interfaces?

IDeploymentDescriptor Interface

Code Example

Chapter 6 Working with Applications, Process Instances and Work Items

IPMApplication
IProcessInstance
IWorkItem
IFinder

Chapter 7 Web Services

Overview of SOAP and WSDL

Terminology

iPM Web Services Architecture
Web Services Environment

Web Services Configuration Files
Environment Setup

Setting Up iPM to use Web Services
Development Environment for Apache SOAP Clients
Runtime Environment for Apache SOAP Clients
Environment for WSDL Clients

Limitations Using SOAP with iPlanet Process Manager

Creating Web Services Clients

Typical Web Services Client Application
Creating a Client Using the WSDL File
Creating an Apache SOAP Client

iPM Web Services API for Apache SOAP Clients
iPM Web Services Classes for Apache SOAP Clients

Creating an Apache SOAP Client Application

Set Up the Web Services Class
Create a Call Object
Map the Data Type for the Call
Set the Method and Parameters to the Call
Invoke the Method and Capture the Return Value

Apache SOAP Client Sample
Setting Up the Apache SOAP Client Sample
iPM Web Services API

Appendix A Scripts

Index