iPlanet Process Manager, Version 6.5 Programmer's Guide |
ContentsAbout This Manual
Developing iPlanet Process Manager Applications
Conventions Used in This Manual
Interacting with Clusters and Deployed Applications
Viewing Documentation
For More Information
Chapter 1 Writing Custom ActivitiesIntroduction
Comparison to Automated Activities
Implementing ISimpleWorkPerformer
Overview of Creating a Custom Activity
Methods of ISimpleWorkPerformer
Writing the XML Description File
The init( ) method
Sample Java Class
The perform( ) method
The destroy( ) method
Creating HelloWorldPerformer.java
File Format
Packaging a Custom Activity
WORKPERFORMER Tag
Sample XML Description File
ENVIRONMENT Section
INPUT Section
OUTPUT Section
PARAMETER Tag
DESIGN Section
Adding a Custom Activity to the Process Map
Adding a Custom Activity from a Custom Palette
Working with a Custom Activity
Adding a Custom Activity without Using a Custom Palette
Implementation Tips
Avoid Instance Data
Example Custom Activity
Use Consistent Data Types
Avoid Non-default Constructors
Use One Implementation of a Java Class Per Server
When to Use a Custom Activity
Chapter 2 Writing Custom Data FieldsIntroduction
Steps for Creating a Custom Field
Defining Field Properties in a JSB File
JSB_DESCRIPTOR Tag
Writing the Java Classes
JSB_PROPERTY Tag
JSB_PROPERTY Attributes
Required Data Field Properties
Define a Subclass of BasicCustomField
Specifying Images for Use in Process Builder
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
Packaging a Custom Field
Adding a Custom Field to an Application
Example Custom Data Field
Development Hints and Tips
Avoid Non-default Constructors
Class Reference
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()
BasicCustomField
archive()
IPMRequest
create()
display()
getName()
getPMApplication()
getPrettyName()
load()
loadDataElementProperties()
store()
update
getAuthenticatedUserId
getParameter
isParameterDefined
Chapter 3 Advanced Office Setup ApplicationChanges in the Advanced Office Setup Application
The Custom Data Field
Overview
The Custom Activity
The Code in Detail
loadDataElementProperties ()
Complete Source Code
display()
update()
store()
load()
Helper Functions
Overview
The Code in Detail
EmployeeTrainingPerformer.xml
Complete Source Code
perform()
Helper Functions
Chapter 4 Cluster ManagementIntroduction
IPMClusterManager
IPMCluster
IPMClusterProperty
Getting and Setting Property Values
PMClusterPropertyFactory
Setting Properties When Creating Clusters
Other Cluster Properties
Code Samples
Mount the Cluster Manager and Get the Default Cluster
Create a Cluster
Get and Set Cluster Properties
Chapter 5 Deployment ManagerDeployment States
STAGE
IDeploymentManager Interface
MODE
STATUS
TESTING
Where are the Classes and Interfaces?
IDeploymentDescriptor Interface
Code Example
Chapter 6 Working with Applications, Process Instances and Work ItemsIPMApplication
IProcessInstance
IWorkItem
IFinder
Chapter 7 Web ServicesOverview of SOAP and WSDL
Terminology
iPM Web Services Architecture
Web Services Environment
Web Services Configuration Files
Creating Web Services Clients
Environment Setup
Setting Up iPM to use Web Services
Limitations Using SOAP with iPlanet Process Manager
Development Environment for Apache SOAP Clients
Runtime Environment for Apache SOAP Clients
Environment for WSDL 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
Creating an Apache SOAP Client Application
iPM Web Services Classes for Apache SOAP Clients
Set Up the Web Services Class
Apache SOAP Client Sample
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
Setting Up the Apache SOAP Client Sample
iPM Web Services API
Appendix A Scripts