ActiveBPEL Designer Online Help V5
Online Help Conventions
XML Syntax
Installation and System Requirements
Documentation Conventions
Welcome to ActiveBPEL Designer
About ActiveBPEL Designer
ActiveBPEL Designer Components
Working in the Eclipse Environment
Introducing Business Process Execution Language
A Little BPEL History
BPEL Resources
What is a BPEL Process?
BPEL Process Definition Elements
ActiveBPEL Extensions to WS-BPEL 2.0
BPEL for People Extension to WS-BPEL 2.0
ActiveBPEL Feature Tour
Printing ActiveBPEL Designer User's Guide
Migrating from Earlier Versions
Migrating from Designer Versions Prior to 5.x
Opening and Using BPEL4WS 1.1 Processes
Migrating Processes from BPEL4WS 1.1 to WS-BPEL 2.0
ActiveBPEL Tutorial
Introduction to ActiveBPEL Tutorial
Tutorial Part 1: Starting a New Process
Tutorial Part 2: Planning and Designing a Process
Tutorial Part 3: Working with Orchestration Interfaces
Tutorial Part 4: Using the Operation Wizard to Create Web Interaction Activities
Tutorial Part 5: Adding Process Activities and Properties
Tutorial Part 6: Adding Fault Handling
Tutorial Part 7: Adding Compensation and Correlation
Tutorial Part 8: Simulating the Process
Tutorial Part 9: Deploying the Process
Tutorial Part 10: Running the Process on the Server
Tutorial Part 11: Debugging Your Process Remotely
Using ActiveBPEL for the First Time
Launching ActiveBPEL Designer
Using the Workspace to Store Projects
Creating an Orchestration Project
Adding or Removing a Project Orchestration Nature
About Project Orchestration and Validation Builders
Starting a New Process
Importing an Existing BPEL Process
Using the ActiveBPEL Samples and Tutorial
Getting Started in ActiveBPEL Designer
About ActiveBPEL Designer and the Eclipse Workbench
Navigating Through ActiveBPEL Designer
Windows, Perspectives, Views, and Editors
ActiveBPEL Perspectives
ActiveBPEL Designer Perspective
Project Explorer
Interfaces
Outline View
Properties View
Process Variables
Error Log
Problems View
Tasks View
Thumbnail View
Bookmarks View
Servers and Console Views
Status Bar
ActiveBPEL Debug Perspective
Using the ActiveBPEL Process Editor
Process Editor Process Activities Tab
Process Editor Fault Handlers Tab
Process Editor Event Handlers Tab
Process Editor Compensation and Termination Handler Tabs
Process Editor Source Tab
Using Process Editor Tool Palettes
Displaying Swimlanes
Setting Visual Properties and Using Your Own Library of Images
Adding Tasks and Bookmarks to the Process
Adding Comments to a Process
Adding Documentation to a Process
Tips for Designing on the Process Editor Canvas
Expanding and Collapsing Container Activities
Process Editor Keyboard Shortcuts
ActiveBPEL Function Keys
Customizing the ActiveBPEL Perspective
ActiveBPEL Preferences
Layout Preferences
Swimlane Appearance Preferences
Tasks and Problems Preferences
Identity Chooser Preference
Additional Preferences
Accessing ActiveBPEL Online Help
Preserving BPEL Layout With VBPEL Files
Interfaces, Service References, and Local WSDL
About Interfaces, Service References, and Local WSDL
Importing a Local WSDL
Viewing Key Elements of a WSDL Tree
Editing a WSDL in the WSDL Editor
Deleting a WSDL from Your Project
Importing a Service Reference
Creating a New Interface
Using the Interfaces View to Create Activities
Interfaces Toolbar Options
Filtering the Interfaces View
Creating a WSDL File with Extensions for BPEL
Using Sample Data for WSDL Messages
Adding a Sample Data Value for a Simple Type Message Part
Generating a Sample Data File
Adding a Sample Data File to a WSDL Message
Selecting a Default Sample Data File
Viewing the XML Structure of a Sample Data File
Removing a Sample Data File
Finding Where a WSDL Component is Used
Using Process Search
Planning Your BPEL Process
Using Top-Down or Bottom-Up Process Design
Using WSDL References for Efficient Design
Creating WSDL Extensions for BPEL
Starting a Process by Dropping an Operation onto the Process Editor
Importing WSDL, Schema, and Other Resources
Automatically Importing WSDL and Schema Locations
Manually Importing WSDL, Schema, and Other Resources
Refreshing Imports
Deleting an Import
Namespace Prefix and Declaration
Declaring Extensions
Using the ActiveBPEL Create XPath Extension
Using the ActiveBPEL Disable Selection Failure Fault Extension
Declaring
Extension Elements and Attributes
Understanding BPEL Process Structure and Properties
Process Element and Properties
Partner Links
Variables
Activities
Fault Handlers
Compensation Handlers
BPEL XML Source and Implicitly Added Activities
Understanding BPEL Process Lifecycle
Creating an Executable vs. an Abstract Process
Creating an Abstract Process
Tips for Working with Abstract Processes
Creating a BPEL Process as a Service for Another BPEL Process
Message Exchange Declaration
Partner Link Types and Partner Links
What are Partner Link Types and Partner Links?
Partner Link Type
Partner Link
Using Scoped Partner Links
Partner Links and Endpoint References
Showing and Hiding Swimlanes
Showing and Hiding Lanes for Partner Link Definitions
Exporting a Partner Link to an Abstract Process
Creating an Activity
Overview of Activities
Defining an Activity and Its Properties
Selecting Values for Activity Properties
Selecting Activity Labels
Standard Properties for Activities
Receive
Invoke
From Part to Variable
From Variable to Part
Reply
Validate
Assign
Tips for Copy Operations
Copy Operation Query and Expression Examples
Copy Operation Literal
Contents Examples
Copy Operation Dynamic Endpoint Reference Example
Element to Element Copy Operation with Keep Source Element Name Attribute
Copy Operation with Ignore Missing From Data Attribute
Throw
Rethrow
Exit
Wait
Empty
Compensate Scope
Compensate
Break
Continue
Suspend
Opaque
Creating a Custom Activity
Creating an Activity by Starting with a WSDL Interface
Using the Expression Builder
BPEL Functions
ActiveBPEL Custom Functions
String Functions
Number Functions
Boolean Functions
Node Set Functions
Example Expressions for Message, Element, and Complex Schema Type Variables
Expected Expressions for Conditions, Counters, and Other Values
Using the Query Builder
Creating a Join Condition for an Incoming Link
Deadline and Duration Expressions
Structuring Activities
Different Ways of Structuring Activities
Defining a Container and its Branches and Properties
Defining Container Branches
Defining Container and Branch Properties
Sequence
Flow
While
Repeat Until
Pick
If
Scope
Setting Isolated to “Yes” in a Scope
Using a Termination Handler for a Scope
Lifecycle of a Scope
For Each
Selecting Activities for Containment
Using Variables
Overview of Variables
Adding a Variable
WSDL Message Types
XML Schema Type
XML Schema Element
Adding Variable Properties and Property Aliases
Initializing a Variable
Viewing Variables
Quick View of Variables Used in Activities
Using the Process Variables View Options
Opening a Variable to View its Definition
Viewing Variable Properties
Understanding Icons, Symbols, and Descriptions of Variable Parts
Deleting a Variable
Using Sample Data in Process Variables View
Editing a Single Sample Data Value for a Simple Type Message Part
Loading a Sample Data File in Process Variables View
Saving and Viewing Sample Data in Process Variables View
Using the XML Data Wizard
Finding Variables Where Used
Using Variables in a Copy Operation
Creating a Copy Operation Using a Context Menu
Creating a Copy Operation Using Drag and Drop
Selecting a Copy Operation to Edit
Using Variables Based on WSDL Fault Messages
Mapping WSDL Message Parts in Web Service Interaction Activities
Validating Variables
Working with Variable Attachments
Attachments
What is an Attachment?
Adding an Attachment
Adding an Attachment for Simulation
Remote Debugging with Variable Attachments
Custom Functions for Attachments
Attachment Custom Function Examples
Using Links
What is a Link?
Adding a Link Between Activities
Adding a Link with no Transition
Adding a Link with a Transition Condition
Link Examples
Execution Rules for Links
Designing With Links vs. Structured Activities
Links and the Join Condition
Link Properties
Compensation
What is Compensation?
Compensation Handlers and Compensate Activities
Default-Order Compensation Example
Specified Compensation Example
Adding a Compensation Handler to a Scope
Compensating an Invoke Activity
Correlation
What is Correlation?
What is a Correlation Set?
WSDL Syntax and Example for Property Names and Aliases
Global and Local Correlation Sets
Creating Message Properties and Property Aliases
Creating a Property Definition
Creating a Property Alias
Adding a Correlation Set
Deleting a Correlation Set
Adding Correlations to an Activity
Initiating and Setting Patterns for Correlation
Adding Correlation to a Receive, OnMessage, OnEvent, or Reply
Adding Correlation to an Invoke Activity
Adding Missing Correlation
Rules for Declaring and Using Correlation Sets
Correlation Sets and Engine-Managed Correlation
Event Handling
What is Event Handling?
Adding Event Handlers
Adding an onEvent Event Handler
Adding an onAlarm Event Handler
Processing Rules for Events
Fault Handling
What is BPEL Fault Handling?
Defining Catch and CatchAll Fault Handlers
Fault Handling for Service Invocations
Adding a Fault Handler
Adding a Fault Handler for the Process
Adding a Fault Handler for a Scope
Adding an Inline Fault Handler for an Invoke Activity
Selecting a Fault Name
Adding a Fault Variable Definition
Fault Handling Processing Rules
Rules for Catching Faults in a Catch Activity
Tips on Fault Handling
Simulating and Debugging
What is the ActiveBPEL Debug Perspective?
Opening the ActiveBPEL Debug Perspective
Switching Between ActiveBPEL Perspectives
ActiveBPEL Debug Perspective Views and Menus
Using the ActiveBPEL Debug View
Using Breakpoints in BPEL Process Simulation
Using the ActiveBPEL Debug Console
Simulating Execution of a BPEL Process
Prerequisites for Simulation
Starting and Ending Simulation of a BPEL Process
Running to a Breakpoint in a BPEL Process
Stepping to the Next Activity in a BPEL Simulation
Viewing the Execution State of an Activity or Link
Modifying a BPEL Process During Simulation
Terminating and Removing BPEL Process Simulations
Clearing the Process Execution State
Supplying and Inspecting Sample Variable Data During Simulation
Setting up Sample Data Values for Input, Output, and Fault Messages
Inspecting Process Variables during Simulation
Selecting Simulation Paths and Properties
Simulating Event Handlers
Simulating Fault Handlers
Inspecting Standard Faults During Simulation
Simulation Preferences
Disable bpel:selectionFailure Fault Example
Auto Create Target Path for Copy/To Example
Disable bpel:selectionFailure Fault and Auto Create Target Path for Copy/To Example
Setting Debug Preferences
Debugging Remote Processes Running on the Server
Configuring a Remote Process Connection
Selecting Processes for Remote Debugging
Setting Breakpoints on a Process for Remote Debugging
Using the Debug View, Process Editor, and Variable View for Remote Debugging
Remote Debugging Preferences
Selecting a Launch Configuration from the Toolbar
Checking for an Out of Sync Process
Server Interactions During a Remote Debugging Session
Setting Options for Console Output
Correcting, Retrying, or Completing Activities
Updating Variable Data in the Process Variables View
Updating Correlation Property Data
Updating Partner Link Address Information
Deploying Your Processes
What is Deployment?
Preparing for Deployment
Preparing BPEL Files for Deployment
Selecting an ActiveBPEL Server Platform for Deployed Processes
Endpoint Reference Addressing Considerations
Endpoint References and WS-Addressing Considerations
Endpoint References Requiring Credentials for Access
Specifying a Replacable URN/URL for an Endpoint Reference
Endpoint References and WS-Policy
Overview of Process Deployment Steps
Creating a Process Deployment Descriptor File
Deployment Platforms
Partner Role Invoke Handlers
Partner Role Endpoint Types
My Role Binding, Service Name, and Allowed Roles Options
Selecting a Service for a Deployment Descriptor Partner Link
Adding Policy Assertions
Authentication
Encryption
Signature
Timestamp
User-Defined Policy Assertion
Retry
XPath Header Map
Engine-Managed Correlation
WS-Reliable Messaging
JMS Delivery Options
HTTP Transport
REST Enabled
SAML
Message Validation
Web Service Timeout
Invoke Recovery
Adding Indexed Properties
Editing a Process Deployment Descriptor File
Creating a Partner Definition File
Creating a Business Process Archive File
Using a BPRD Script to Regenerate and Deploy a BPR File
Deploying Your Process to the ActiveBPEL Engine
Deploying Your Process to ActiveBPEL Enterprise or Professional
Starting the Server and Running a Process
How a BPEL Process is Instantiated
What is Process Versioning?
BPEL Unit Testing
What is BPEL Unit Testing?
Creating a BPEL Unit Test File
Running a BPEL Unit Test
Editing a B-Unit File
Creating and Running BPEL Unit Test Suites
Creating and Using Custom Functions
Custom Functions Technical Requirements and Sample Files
Java-Based Custom Functions
Adding Custom Functions to Expression and Query Builders
Specifying Custom Function Simulation Setup
Adding Custom Functions to the ActiveBPEL Embedded Engine
Custom Service Interactions
Using a REST-based Service
Creating a REST-based Receive or Invoke
BPEL REST Messages
Handling of Multipart HTTP Messages
Specifying Deployment Details for a REST-based Process
Using a Java Messaging Service Invoke Handler
Process Exception Management
What is Process Exception Management?
Suspending a Process on Uncaught Faults
Making all Processes Eligible for Suspension on Uncaught Faults
Making Individual Processes Eligible for Suspension on Uncaught Faults
Suspending a Process Programatically with a Suspend Activity
Remote Debugging a Faulting Activity
BPEL Standard Faults
Special Purpose BPEL Processes
Alert Service
Retry-Policy Service
Identity Service
Email Service
Monitoring Alert Service
Glossary
Index
Technical Support
Tips and tricks
What's New
Release Notes
Printed Version
BPEL for People Online Help V5
Welcome to ActiveBPEL BPEL for People
Getting Started with BPEL for People
What is BPEL for People?
About the BPEL4People Specification
Introducing Human Workflow into a BPEL Process
Routing Tasks to People at Run Time
About Task LifeCycle
Creating the Artifacts Needed for the People Activity
BPEL4People Extension Elements and Activities
What are the BPEL4People Extension Elements and Activities?
Human Interactions Extension Element
People Assignments Extension Element
Selecting Process-Related Roles in a People Assignment
Defining Roles in a People Assignment Extension Element
Selecting Users or Groups for Logical People Groups During Deployment
About Logical People Groups
Creating a Logical People Group
Logical People Group Parameters and Arguments
Using a Logical People Group in an Assign Activity
Using Logical People Groups for Role Assignments
Using Literal Values for Role Assignments
Using Expressions for Role Assignments
About Tasks
Adding a Task or Notification to the Outline View for Process or Scope Use
Required and Optional Properties for a Task
Task Name, Interface, and Priority
Adding a Task Interface and Callback
Role Assignments for a Task or Notification
Adding Task or Notification Presentation Properties
Configuring Presentation Parameters for a Task or Notification Subject or Description
Adding a Language for Task or Notification Presentation
Adding a Content Type for a Task or Notification Description
Using the All Tab of a Task
Using Expressions for Outcome and Search By
Adding Rendering Details for a Task or Notification
About Task Deadlines and Escalations
Adding Start and Completion Deadlines and Alarms
Selecting an Escalation Action to Occur When a Task Deadline is Triggered
Defining a Condition for an Escalation Action
Using Task Data or Mapped Data for a Notification
Creating an Inline or Local Notification Action for a Task Deadline
Using a Reassignment Action for a Task Deadline
Invoking a Process When a Task Deadline Occurs
About Notifications
Required and Optional Properties for a Notification
Notification Name, Priority, and Interface
Using the All Tab of a Notification
Using the People Activity
What is a People Activity?
Conceptual Overview of the People Activity
Adding a People Activity
Adding a People Activity from the Activity Palette
Adding a People Activity Using the Create Activity Wizard
Required and Optional Properties of a People Activity
Creating an Inline Task or Notification
Selecting a Local Task or Notification
Selecting Overrides for Priority and People Assignments
Selecting Variables
Adding Scheduled Actions for Tasks
Sending and Receiving Attachments
Catching a Fault Thrown by the People Activity
Simulating, Deploying, and Debugging the People Activity
Simulating a Process with a People Activity
Selecting a Logical People Group Handler
Using the Identity Chooser
Running Your Process from the ActiveBPEL Server
Customizing the ActiveBPEL Inbox and Other Clients
What is the ActiveBPEL Inbox?
Viewing the Default Rendering of ActiveBPEL Inbox Details Page
Providing Rendering for the ActiveBPEL Inbox or Another Client Application
List of Renderings
Adding a Rendering
Creating an XSL Rendering
Filling in the Presentation and Command URI
Adding Deployment Details for Custom Renderings
Creating a Custom Rendering
Contributing a Custom Task Rendering Hint Editor
Creating Custom Escalation Actions
Custom Functions
BPEL For People Custom Functions
WS-HT (Human Task) Custom Functions
Creating a Custom Inbox
What is a Custom Inbox?
Using the Active Endpoints Inbox Rendering SDK
Creating a Custom Work Item
Examining the loan_taskdetail.xsl File
Examining the loan_param2commands.xsl File
Replacing the Inbox Logo Image
Advanced Inbox Modifications
Printed Version
ActiveBPEL Server Administration Console Online Help V5
ActiveBPEL® Server Administration Console Overview
Complete List of Help Topics
Prerequisites for Running the Administration Console
Options for Different Application Servers
Understanding the Properties of an Invoked Service
Home
Engine
Engine Properties
URN Mappings
Function Contexts
Server Configuration (Tomcat)
Alerts
Monitoring Properties
Cluster Configuration (WebSphere/WebLogic)
License
Monitoring
Storage
Version Detail
Extended Services
Email Service
Identity Service
Creating a Trusted Keystore File
Messaging Service
Deployment
Deploy BPR
Deployment Logs
Deployed Processes
Deployed Process Detail
Deployed Process Version Detail
Deployed Services
Indexed Properties
Partner Definitions
Resource Catalog
Process Status
Active Processes
Using Selection Filters for Active Processes
Alarm Queue
Receive Queue
Process ID and Process Details
Using the Process Details Page
Using the Process Details Graphic View
Using the Process Details Outline View
Inspecting Where and Why an Activity Faulted
Working with Variable Attachments
Process Versions
Process Version Life Cycles
Process Version Persistence Type
Exception Management Type
Process Instance Retention Days
ActiveBPEL Server Clusters (Application Server Specific)
Process Exception Management
BPEL Standard Faults
ActiveBPEL Custom Faults
Printed Version
ActiveBPEL Server User Guide V5
Preface
Welcome to ActiveBPEL Server
What are the Server Components of ActiveBPEL?
Installing, Configuring, and Starting Up the Server
Configuring ActiveBPEL Server for WS-Security
Configuring Java-Based Servers for WS-Security
What is a BPEL Process?
How Do I Create, Deploy, and Run a BPEL Process?
Using ActiveBPEL Designer
Using the ActiveBPEL Server Administration Console
Support for Custom Inbox Rendering
Deployment Basics
What is Business Process Deployment?
What is a Business Process Archive?
What is a Process Deployment Descriptor?
Endpoint References and WS-Addressing
Endpoint References and WS-Policy
Authentication
Encryption
Signature
Timestamp
Retry
XPath Header Map
Engine-Managed Correlation
WS-Reliable Messaging
User-Defined Policy Assertion
JMS Delivery Options
HTTP Transport
REST Enabled
SAML
Message Validation
Web Service Timeout
Invoke Recovery
Partner Role Details
Partner Role Invoke Handlers
URN/URL Mappings for an Endpoint Reference
My Role Details
Engine Settings for Individual Processes
Process Version Details
Process Group
Indexed Properties
What is a Partner Definition File?
Deploying a Business Process Archive
Executing and Modifying a BPRD Script
Understanding the Resource Catalog
Creating a Standard or External Service Endpoint for My Role Partner Links
Standard vs. External Publishing of Service Endpoints for My Role Partner Links
What is an External Service Endpoint?
Creating a J2EE for Web Services Endpoint
Adding the ActiveBPEL Engine EJB Interface to the Java Class File
Adding the My Role Partner Link Context to the Java Class File
Adding a Security Context to the Java Class File
Example J2EE Web Service Endpoint
Packaging a J2EE for Web Services Endpoint
Deploying a J2EE Web Services Endpoint
Custom Invoke Handlers
Standard vs. Custom Invocation of Service Endpoints
What is a Custom Invoke Handler?
Referencing the Custom Invoke Handler Interface in a Java-Based Implementation
Adding the Custom Invoke Handler Attribute to the Process Deployment Descriptor
Packaging the Custom Invoke Handler as an EJB
Deploying Custom Invoke Handler Files
Special Purpose BPEL Processes
Alert Service
Retry-Policy Service
Identity Service
Email Service
Monitoring Alert Service
Printed Version
ActiveBPEL Inbox Online Help V5
About ActiveBPEL Inbox
What is an ActiveBPEL Task?
About Users and Administrators
Navigating in the Inbox
Refreshing Your Task List
Claiming, Starting, and Performing Other Actions for a Task
Working with a Work Item, Attachments and Comments
Modifying a Task
Completing or Failing a Task
Assigning a Task to Another User
What Happens When a Task is Overdue
Reading and Removing Notifications
About ActiveBPEL® Server and the Inbox
Starting and Signing Into the Inbox
Session Time Out
Printed Version
ActiveBPEL Open Source Engine Help V5
ActiveBPEL® Engine Administration Console Help
Administration Home Page
Engine
Identity Service
Deployment Status
Process Status
Process ID and Process Details
Using the Process Details Page
Using the Process Details Graphic View
Using the Process Details Outline View
Inspecting Where and Why an Activity Faulted
Working with Variable Attachments
Persistence Storage Setup
ActiveBPEL Custom Faults
Printed Version
ActiveBPEL Server Installation, Configuration, and Deployment Guide V5
Apache Tomcat Professional
Quick Start
Benefits
Prerequisites
Installation
Configuration
Installation Checklist
Glossary
Configuration and Deployment Utility Help Topics
Engine Configuration Help
Server JNDI Configuration Help
Inbox Configuration Help
Database Configuration Help
Configuration and Deployment Options Help
Process Graph Configuration Help
Security Configuration Help
Deployment Options Help
Apache Tomcat Enterprise
Quick Start
Benefits
Prerequisites
Installation
Configuration
Installation Checklist
Glossary
Configuration and Deployment Utility Help Topics
Engine Configuration Help
Server JNDI Configuration Help
Inbox Configuration Help
Database Configuration Help
Configuration and Deployment Options Help
Process Graph Configuration Help
Clustering Help
Security Configuration Help
Deployment Options Help
Deployment Targets Help
BEA WebLogic
Quick Start
Benefits
Prerequisites
Installation Folders
Configuration
Installation Checklist
Glossary
Configuration and Deployment Utility Help Topics
Engine Configuration Help
Server JNDI Configuration Help
Inbox Configuration Help
Database Configuration Help
Configuration and Deployment Options Help
Process Graph Configuration Help
Security Configuration Help
Work Manager Configuration Help
Deployment Options Help
Deployment Targets Help
IBM Websphere
Quick Start
Benefits
Prerequisites
Installation Folders
Configuration
Installation Checklist
Glossary
Configuration and Deployment Utility Help Topics
Engine Configuration Help
Server JNDI Configuration Help
Inbox Configuration Help
Database Configuration Help
Configuration and Deployment Options Help
Process Graph Configuration Help
Security Configuration Help
Work Manager Configuration Help
Timer Manager Configuration Help
Global Security Configuration Help
JAAS Login Configuration Help
Deployment Options Help
Deployment Targets Help
JBOSS
Quick Start
Benefits
Prerequisites
Installation Folders
Configuration
Installation Checklist
Glossary
Configuration and Deployment Utility Help Topics
Engine Configuration Help
Server JNDI Configuration Help
Inbox Configuration Help
Database Configuration Help
Configuration and Deployment Options Help
Process Graph Configuration Help
Security Configuration Help
Deployment Options Help
ActiveVOS Start Here V5
Quick Start
ActiveVOS Reviewer's Guide