BEA Logo BEA 

WebLogic Integration Release 2.1 Service Pack 1

  BEA Home  |  Events  |  Solutions  |  Partners  |  Products  |  Services  |  Download  |  Developer Center  |  WebSUPPORT

 

   WebLogic Integration Doc Home   |   BPM Topics   |   Programming BPM Client Apps   |   Previous Topic   |   Next Topic   |   Contents   |   Index   |   View as PDF

Programming BPM Client Apps

 

 

Business Process Management API Development

Introduction

WebLogic Integration Process Engine

WebLogic Server Infrastructure

Process Engine Component Architecture

Session EJBs

Entity EJBs

Startup Classes

Message-Driven Beans

BPM API

Admin Session EJB

Audit Session EJB

EJBCatalog Session EJB

Permission Session EJB

PluginManager Session EJB

PluginManagerCfg Session EJB

ServerProperties Session EJB

WLPIPrincipal Session EJB

Worklist Session EJB

XMLRepository Session EJB

Client Common Package

Client Utility Package

Client/Server Common Package

Plug-In Common Package

Security Common Package

Utility Package

XML Repository Helper Package

BPM Application Development Tasks

Configuration

Design

Run-Time Management

Monitoring

Plug-In Development

BPM API Examples

Command-Line Administration Example

Command-Line Studio Example

Command-Line Worklist Example

Command-Line SAX Parser Example

JSP Worklist Example

 

Part I. API Development Fundamentals

 

Importing Packages and Interfaces

BPM Packages and Interfaces

General Java Packages

 

Connecting to the Process Engine

Accessing the API Session EJBs

Step 1: Look Up a Session EJB Home Interface in JNDI

Step 2: Create a Remote Session Object Using the Home Interface

Using the Convenience Methods to Access EJBs

 

Accessing Process Engine Information

Getting the Server Version

Getting the Template Definition Version

Getting Server Properties

Using the Convenience Methods

Example of Accessing Information About the Process Engine

 

Using Value Objects

Introduction to Value Objects

Creating Value Objects

Using Value Objects to Access Object Data

Sorting Value Objects

Example of Using a Value Object

 

Establishing JMS Connections

Overview of JMS

JMS Destinations Used by the Process Engine

Connecting to JMS

Receiving Messages Asynchronously

Generating Message-Driven Beans for Multiple Event Queues

Guaranteeing Message Delivery

Guaranteeing Sequential Processing of Messages

Example of Connecting to a JMS Topic

 

Understanding the BPM Transaction Model

How a Transaction Is Started

How the Transaction Is Committed

How a Workflow Instance Is Processed

How a Workflow Instance Reaches a Quiescent State

How Exceptions Are Handled

How to Force a New Transaction to Start

Examples of Transactions

Example 1: Business Operations Defined as Actions in One Task

Single Transaction

Multiple Transactions

Example 2: Business Operations Defined as Actions in Multiple Tasks

Single Transaction

Multiple Transactions

 

Disconnecting from the Process Engine

Removing Session EJB References

Releasing Other Resources

Stopping and Closing JMS Connections

Closing the Context

 

Part II. Configuration

 

Configuring the Security Realms

Getting Basic Security Information

Getting the Security Realm Class Name

Determining Whether the Security Realm Is Manageable and/or Persistent

Getting the Server URL

Getting the User ID

Example of Getting Basic Security Information

Configuring Organizations, Roles, and Users

Configuring Organizations

Adding an Organization

Adding a User to an Organization

Getting All Organizations

Getting the Roles Defined for an Organization

Getting the Users Defined for an Organization

Getting Organization Information

Setting Organization Information

Deleting a User from an Organization

Deleting an Organization

Example of Configuring Organizations

Configuring Roles

Adding a Role

Adding a User to a Role

Getting the Users Defined for a Role

Getting Role Information

Setting Role Information

Deleting a User from a Role

Deleting a Role

Example of Configuring Roles

Configuring Users

Adding a User

Getting All Users

Getting User Organizations

Getting User Roles

Getting User Information

Setting User Information

Deleting a User

Example of Configuring Users

Mapping Security Information

Getting the Security Realm Groups

Mapping a Role to a Group

Mapping Multiple Roles to Groups

Getting the Group Mapping for a Role

Getting the Group Mappings for All Roles Defined for an Organization

Configuring Permissions

Permissions Overview

Getting Permissions for All Roles

Getting Permissions for a Role

Getting Permissions for All Users

Getting the Permissions for a User

Determining Whether a Specific Permission Is Set

Setting Role-Specific Permissions

Setting Permissions for a Specific Role

Setting a Group of Permissions for Multiple Roles

Setting User-Specific Permissions

Setting a Single User-Specific Permission

Setting a Group of Permissions for Multiple Users

 

Configuring Business Operations

Adding a Business Operation

Getting Business Operations

Updating a Business Operation

Deleting a Business Operation

Getting EJB Descriptors

Getting Java Class Descriptors

Examples of Configuring Business Operations

Example of Getting an EJB Descriptor

Querying the Inspect Always Flag

Setting the Inspect Always Flag

Getting Deployed EJB Names

Getting EJB Deployment Descriptors

Examples of Configuring Business Operations

Deleting a Business Operation

Getting All Business Operations

 

Configuring Event Keys

Overview of Event Keys

Adding an Event Key

Getting Event Key Information

Updating an Event Key

Deleting an Event Key

Example of Configuring Event Keys

Adding an Event Key

Deleting an Event Key

Getting Event Keys

Updating Event Keys

 

Configuring Business Calendars

Adding a Business Calendar

Getting Business Calendars

Getting a Business Calendar Definition

Updating a Business Calendar

Deleting a Business Calendar

Example of Configuring Business Calendars

Adding a Business Calendar

Deleting a Business Calendar

Getting a Business Calendar Definition

Getting Business Calendars

Updating a Business Calendar

 

Part III. Design

 

Creating and Managing Workflow Templates

Creating a Template

Getting a Template

Getting the Templates for an Organization

Getting the Template Organizations

Setting the Template Organizations

Updating a Template

Deleting a Template

Example of Managing Templates

Creating a Template

Deleting a Template

Getting Templates for an Organization

 

Creating and Managing Workflow Template Definitions

Creating a Template Definition

Getting Template Definition Information

Getting Definitions for a Template

Getting the Template Definition Content

Setting the Template Definition Content

Getting the Template Definition Owner

Locking and Unlocking a Template Definition

Deleting a Template Definition

 

Managing Tasks

Getting Tasks

Assigning a Task

Marking a Task Complete or Incomplete

Setting Task Properties

 

Managing Task Routing

Adding a Task Reroute

Getting Task Reroutes

Updating a Task Reroute

Deleting a Task Reroute

Example of Managing Task Routing

Adding a Task Reroute

Deleting a Task Reroute

Getting Task Reroutes

 

Managing the XML Repository

Managing XML Repository Folders

Creating a Folder or Subfolder

Getting All Folders and Subfolders

Getting Folder Tree

Getting Folder Information

Reorganizing Folders

Renaming a Folder

Updating a Folder

Deleting a Folder

Managing XML Repository Entities

Creating an Entity

Getting Entities

Getting Entity Information

Organizing Entities Within Folders

Renaming an Entity

Updating an Entity

Deleting an Entity

Getting the EJB Environment Variable Values

 

Publishing Workflow Objects

What Is a Publishable Object?

Creating a Package Entry

Exporting a Package of Publishable Objects

Importing a Package of Publishable Objects

Reading a Package of Publishable Objects

 

Part IV. Run-Time Management

 

Managing the Active Organization

What Is an Active Organization?

Getting the Active Organization

Getting All Organizations

Setting the Active Organization

Example of Managing the Active Organization

Getting the Active Organization

Getting All Organizations

Setting the Active Organization

 

Manually Starting Workflows

Getting Startable Workflows

Manually Starting a Workflow

Examples of Manually Starting a Workflow

Command-Line Worklist Example

Getting Startable Workflows

Manually Starting a Workflow

JSP Worklist Example

 

Managing Run-Time Tasks

Getting a Task

Getting All Tasks

Getting Task Counts

Executing a Task

Responding to a Client Request

Assigning a Task

Marking a Task as Complete or Incomplete

Setting Task Properties

Updating an Instance Variable

Invoking an Exception Handler

Examples of Managing Run-Time Tasks

Command-Line Worklist Example

Getting Task Counts

Getting All Tasks

Assigning a Task

Executing a Task

Marking a Task as Complete

Setting the Task Properties

Unassigning a Task

Marking a Task as Incomplete

Command-Line SAX Parser Example

Parsing the Client Request

Responding to the Client Request

JSP Worklist Example

Getting Tasks

Executing a Task

Parsing the Client Request

Responding to a Client Request

Assigning a Task

Marking a Task as Complete or Incomplete

Setting Task Properties

 

Part V. Monitoring

 

Monitoring Run-Time Workflow Instances

Getting Workflow Instances

Checking for Workflow Instances

Checking for a Workflow Template Instance

Checking for a Workflow Template Definition

Getting Workflow Instance Tasks

Getting Workflow Instance Information

Getting a Count of Workflow Instances

Deleting Workflow Instances

Deleting a Specific Workflow Instance

Deleting All Instances of a Workflow Template or Template Definition

Querying the Run-Time Workload

Querying the Run-Time Statistics

 

Monitoring Run-Time Variables

Getting Workflow Instance Variables

Setting Workflow Instance Variables

 

Monitoring Workflow Exceptions

Overview of Exception Handling

Workflow Exception

Workflow Exception Handler

Creating a Workflow Exception

Getting Workflow Exception Information

Getting the Workflow Exception

Getting the Severity

Getting the Message Text

Getting the Message Number

Getting the Origin

Determining Whether a Workflow Exception Resulted from a Database Deadlock

Printing the Stack Trace

Invoking a Workflow Exception Handler

 

DTD Formats

Audit DTD

Hierarchy Diagram

DTD Format

Element Descriptions

Audit DTD Example

Business Calendar DTD

Hierarchy Diagram

DTD Format

Element Descriptions

Business Calendar DTD Example

Client Call Addin Request DTD

Hierarchy Diagram

DTD Format

Element Descriptions

Client Call Addin Request DTD Example

Client Call Addin Response DTD

Hierarchy Diagram

DTD Format

Element Descriptions

Client Call Program Request DTD

Hierarchy Diagram

DTD Format

Element Descriptions

Client Call Program Request DTD Example

Client Call Program Response DTD

Hierarchy Diagram

DTD Format

Element Descriptions

Client Call Program Response DTD Example

Client Message Box Request DTD

Hierarchy Diagram

DTD Format

Element Descriptions

Client Message Box Request DTD Example

Client Message Box Response DTD

Hierarchy Diagram

DTD Format

Element Description

Client Message Box Response DTD Example

Client Request DTD

Hierarchy Diagram

DTD Format

Element Descriptions

Entity Descriptions

Client Set Variables Request DTD

Hierarchy Diagram

DTD Format

Element Descriptions

Client Set Variables Request DTD Example

Client Set Variables Response DTD

Hierarchy Diagram

DTD Format

Element Descriptions

Client Set Variables Response DTD Example

Import Response DTD

Hierarchy Diagram

DTD Format

Element Descriptions

Statistics Request DTD

Hierarchy Diagram

DTD Format

Element Descriptions

Statistics Response DTD

Hierarchy Diagram

DTD Format

Element Descriptions

Template DTD

Hierarchy Diagram

DTD Format

Element Descriptions

Template Definition DTD

Hierarchy Diagram

DTD Format

Element Descriptions

Entity Descriptions

Template Definition DTD Example

Decision Node Example

Done Node Example

Event Node Example

Join Node Example

Start Node Example

Task Node Example

Workload Request DTD

Hierarchy Diagram

DTD Format

Element Descriptions

Workload Response DTD

Hierarchy Diagram

DTD Format

Element Descriptions

 

Value Object Summary

BusinessCalendarInfo Object

EventKeyInfo Object

InstanceInfo Object

OrganizationInfo Object

PermissionInfo Object

RepositoryFolderInfo Object

RepositoryFolderInfoHelper Object

RerouteInfo Object

RoleInfo Object

RolePermissionInfo Object

TaskInfo Object

TemplateDefinitionInfo Object

TemplateInfo Object

UserInfo Object

UserPermissionInfo Object

VariableInfo Object

VersionInfo Object

XMLEntityInfo Object

XMLEntityInfoHelper Object

 

EJB and Java Class Descriptors

ClassDescriptor Object

ClassInvocationDescriptor Object

EJBDescriptor Object

EJBInvocationDescriptor Object

MethodDescriptor Object

 

Database Schema

 

Customizing Studio and Worklist Logos and Text

 

back to top   next page