ActiveVOS Start Here V9.1.0.2
Quick Start Designer
Quick Start Server
Release Notes
Quick Start Designer
Quick Start Server
Release Notes
ActiveVOS Designer Online Help
What's New
ActiveVOS Installation and Components
Installation, System Requirements, and Licensing
ActiveVOS Designer Components
Welcome to ActiveVOS Designer
About ActiveVOS Designer
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
ActiveVOS Extensions to WS-BPEL 2.0
BPEL for People Extension to WS-BPEL 2.0
ActiveVOS Feature Tour
Printing ActiveVOS Designer User's Guide
Migrating from Earlier Versions
Required Reset for ActiveVOS Perspectives
Migrating from Designer Versions Prior to 9.0
Migrating from Designer Versions Prior to 8.0.x
Migrating from Designer Versions Prior to 7.x
Migrating from Designer Versions Prior to 6.x
Opening and Using BPEL4WS 1.1 Processes
Migrating Processes from BPEL4WS 1.1 to WS-BPEL 2.0
Taking Advantage of SOAP 1.2 Port Binding, Version 7.x
Saving From One Editing Style to Another (BPMN and Classic)
Converting Legacy Deployments to Contributions
ActiveVOS Tutorial
Introduction to ActiveVOS Tutorial
Tutorial Part 1: Starting a New Process
Tutorial Part 2: Planning and Designing a Process
Tutorial Part 3: Creating a Process Service Consumer Participant
Tutorial Part 4: Creating Partner Service Provider 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: Creating a Request to Run the Process
Tutorial Part 11: Debugging Your Process Remotely
Using the Web Services Explorer to Start a Process
Using ActiveVOS for the First Time
Launching ActiveVOS Designer
Using the Workspace to Store Projects
Creating an Orchestration Project
Changing the Default Location of a Workspace Project
Orchestration Project Templates
Adding or Removing a Project Orchestration Nature
About Project Orchestration and Validation Builders
Using Project References
Creating a New Process
Selecting the BPMN-Centric or BPEL-Centric Palette
Importing an Existing BPEL Process
Importing a Visio XML Drawing File
Begin Your First Project with ActiveVOS Assistance
Using the ActiveVOS Learning Tools
Setting Up the ActiveVOS Server
ActiveVOS Orchestration File Resources
Getting Started in ActiveVOS Designer
About ActiveVOS Designer and the Eclipse Workbench
Navigating Through ActiveVOS Designer
Windows, Perspectives, Views, and Editors
ActiveVOS Perspectives
ActiveVOS Designer Perspective
Project Explorer
Participants
Interfaces
Outline View
Properties View
Process Variables
Error Log
Problems View
Tasks View
Thumbnail View
Bookmarks View
Relationships View
Servers and Console Views
Status Bar
ActiveVOS Debug Perspective
BPMN-Centric and BPEL-Centric Edit Styles
What is BPMN-Centric Style?
What is BPEL-Centric Style?
Comparing the BPMN-Centric and BPEL-Centric Tool Palettes
Which Edit Style to Choose: BPMN-Centric or BPEL-Centric?
Using Swimlanes
What is ActiveVOS Classic Style?
Using the ActiveVOS 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
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
Showing and Hiding Activities
Process Editor Keyboard Shortcuts
ActiveVOS Function Keys
Customizing the ActiveVOS Perspective
ActiveVOS Menus and Toolbars
Refactor
Go To Activity (Ctrl + l)
Open Operation (Ctrl + Shift + t, o)
Open Port Type (Ctrl + Shift + t, p)
Open Web Type (Ctrl + Shift + t, w)
Optimize Parameters
Validate Process
Generate Process Report
Generate Process Image
Generate Deployment Image
ActiveVOS Preferences
BUnit Preference
Cache and Timeout Preference
Colors and Fonts Preferences
Contribution Preference
Layout Preferences
Relationships View Preferences
Tasks and Problems Preferences
Identity Chooser Preference
Additional Preferences
Accessing ActiveVOS Online Help
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
Creating a Java Interface
Setting up Your Java Project in ActiveVOS
Constraints for your Java Project
Generating WSDL and Schema from a Java Interface
Generating Argument Names for Schema Elements
Updating Your Java Project and Your BPEL Process Concurrently
Deployment Requirements for a Java (POJO) Endpoint
Deployment Requirements for Java (EJB) Endpoint
Running a BPEL Process with a POJO/EJB Endpoint
Comparing the POJO/EJB Interface to a Custom Java Invoke Handler
Using the Interfaces View to Create Activities
Interfaces Toolbar Options
Filtering the Interfaces View
System Services Interfaces
Creating a WSDL File with Extensions for BPEL
Using Sample Data for WSDL Messages
Adding or Editing 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 ActiveVOS Create XPath Extension
Using the ActiveVOS 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
Participants
What are Participants?
Using the Participants View
Creating a New Process Service Consumer Interface
Creating a New Partner Service Interface
Creating a New Callback Interface
Clearing a Service Interface from a Participant
Creating New Activities from the Participants View
Creating a New Variable From an Activity’s Property View
What are Partner Link Types and Partner Links?
Partner Link Type
Partner Link
Using Scoped Partner Links
Partner Links and Endpoint References
Implementing a BPMN Task or Event in BPEL
BPMN-to-BPEL Implementation of Tasks and Events
Overview of BPEL Activities
Defining an Activity and Its Properties
Selecting Values for Activity Properties
Selecting Activity Labels
Standard Properties for Activities
Adding a Background Color to a Task, Scope, People Activity and Handlers
Understanding and Using Activity Sequences and Flows
Receive
Reply
Throw
Rethrow
Exit
Wait
Compensate
Compensate Scope
Break
Continue
Start/End/None
Invoke
From Part to Variable
From Variable to Part
Input Variable
Output Variable
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
Empty
Suspend
Validate
Opaque
Creating a Custom Activity
Creating an Activity by Starting with a WSDL Interface
Implementing a BPMN Gateway or Control Flow
BPMN-to-BPEL Implementation of Gateways and Control Flow
Different Ways of Structuring Activities
Ungrouping Selected Structured Activities
Gateway
Mutually Exclusive Transitions
Pick
Fork Join
If
While
Repeat Until
Scope
Setting Isolated to “Yes” in a Scope
Using a Termination Handler for a Scope
Lifecycle of a Scope
For Each
Sequence
Flow
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 Manipulating Attachments
Attachment Custom Function Examples
Using Links
What is a Link?
ActiveVOS Extension for Links
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
Data Manipulation
Overview of Data Manipulation in BPEL
Selecting XPath or XQuery for Expression Building
Example XQuery Expressions
Example XPath Expressions
Using the Expression Builder
Using Content Assist
BPEL Functions
ActiveVOS Custom Functions
String Functions
Number Functions
Boolean Functions
Node Set Functions
Expected Expressions for Conditions, Counters, and Other Values
Using the Query Builder
Creating a Join Condition for an Incoming Link
Deadline and Duration Expressions
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
Adding Boundary Events
Catch and Catch All Boundary Events and Compensate, Compensate Scope and Rethrow
Using a Variable from a Catch or Interrupting OnEvent Boundary Event
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 a Fault Handler as a Boundary Event 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
Catching Undeclared and SOAP Faults
Simulating and Debugging
What is the ActiveVOS Debug Perspective?
Opening the ActiveVOS Debug Perspective
Switching Between ActiveVOS Perspectives
ActiveVOS Debug Perspective Views and Menus
Using the ActiveVOS Debug View
Using Breakpoints in BPEL Process Simulation
Using the ActiveVOS 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
Selecting an Invoke Subprocess for Simulation
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
Monitoring Client Message Traffic with TCP/IP Monitor
Deploying Your Processes
What is Deployment?
Preparing for Deployment
Preparing BPEL Files for Deployment
Selecting a Server Platform for Deployed Processes
Endpoint Reference Addressing Considerations
Endpoint References and WS-Addressing Considerations
Endpoint References Requiring Credentials for Access
Specifying a Replaceable URN/URL for an Endpoint Reference
Endpoint References and WS-Policy
Overview of Process Deployment Steps
Creating a Process Deployment Descriptor File
General Deployment Options
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
Using SOAP 1.1 or 1.2 Port Binding
Adding Policy Assertions
Authentication
Encryption
Signature
Timestamp
User-Defined Policy Assertion
Retry
Engine-Managed Correlation
WS-Reliable Messaging
JMS Delivery Options
HTTP Transport
REST Enabled
SAML
Message Validation
Web Service Timeout
Invoke Recovery
Send WS-Addressing Headers
WSDL Binding Reference
Suppress xsi:type
Run As User
Adding Indexed Properties
Viewing References
Eventing tab of the PDD
People tab of the PDD
Using the PDD Editor Source View
Creating and Deploying a Business Process Archive Contribution
Deploying Project Dependencies and Viewing Excluded Dependencies
Deploying Additional Resources
Managing Deployment Contributions
Using a BPRD Script to Regenerate and Deploy a BPR Contribution
Running a BPRD Ant Script from within Designer
Running a BPRD Ant Script from the Command Line
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 in Designer
Creating and Running a B-unit Ant Script
Generating a Code Coverage Report
Editing a B-unit File
BPEL Unit (Root)
Extensions and Extension Activities
Invokes
Alarms
Commands
Debugging a B-unit Test
Creating and Running BPEL Unit Test Suites
Tips on Using Assertions
Tips on Using Parameterized XSL for Input and Assert Data
Tips on Providing Partner Link Data
Example B-unit File
Creating POJO and XQuery Custom Functions
About Java Custom Functions and XQuery Modules
Custom Functions Overview
Implementing the Function Context and Adding Annotations
Sample Custom Function
Adding Global Custom Functions to the ActiveVOS Server
Specifying Legacy Custom Function Simulation Setup
Writing XQuery Functions
Using the XQuery Editor
Tips on Writing XQuery Functions
Testing XQuery Functions in the XQuery Editor
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 an OAuth REST-Based System Service
Specifying Deployment Details for a OAuth Service Provider
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 Programmatically with a Suspend Activity
Remote Debugging a Faulting Activity
Creating Reports for ActiveVOS Server and Central
About ActiveVOS Server and Central Reports
Creating the User Reports Orchestration Project
Using the ActiveVOS Report Template
Using the ActiveVOS Data Source
Creating a Data Set from the ActiveVOS Data Source
Understanding the ActiveVOS Data Model
Deploying an ActiveVOS Report
Updating or Deleting an ActiveVOS Deployed Report
Reporting Service
Business Event Processing
What is Business Event Processing?
Defining an Event in the Process Deployment Descriptor
Using System-Defined Events
Creating an Event-Action BPEL Process
Activity States, Event Properties, Task States, and Task Event Types
ActiveVOS Central Forms and Configuration
What is ActiveVOS Central?
Creating an ActiveVOS Central Process Request Form
Understanding the Process Request Form Template
Editing HTML in ActiveVOS Central Forms
Adding a New Service Operation for a Request or Task Form
Customizing Task and Request Form Scripts: An Introduction
Using the ActiveVOS SDK for Customizing Forms
Testing and Debugging ActiveVOS Central Forms
Creating an ActiveVOS Central Configuration File
Configuring Requests Filters
Configuring Reports Filters
Including Your Own Styles, Scripts, and Meta Data for ActiveVOS Central
Configuring Task Role Filters
Basic Task Roles Filter Configuration
Configuring Custom Columns for Task Roles Filtering
Configuring a GetMyTasks Filter with a WhereClause
Configuring a RSS or Atom Feed Filter
Deploying Process Requests, Reports, and Configuration Files
Adding MultiLingual Support to ActiveVOS Central
Displaying ActiveVOS Central in a Web Browser’s Preferred Language
Adding MultiLingual Support for Request and Task Forms
Adding MultiLingual Support for an .avcconfig File
Adding MultiLingual Support for Reports
Naming Convention for a .properties File
ActiveVOS Central Advanced Configuration
Building a Process with a System Service
Using a BPEL Template for a System Service-Based Process
Alert Service
Retry-Policy Service
Identity Service
Email Service
Monitoring Alert Service
Server Log Service
Shell Command Invoke Service
Data Access Service
Simulating the Data Access Invoke Output
Migration Service
Using the ActiveVOS Migration Web Service
Creating a Screenflow Automated Step Service
About the Screenflow Automated Step Demo Sample Project
Logging into Screenflow Designer
Importing the Demo Guides into Screenflow Designer
What is a Screenflow Automated Step?
Using the Automated Step Request, Response, and Fault Messages
Providing Rendering Hints for Guide Data
Creating the Automated Step Service Descriptor
Creating a Screenflow Layout Theme
Automation for Analysts User’s Guide
What is ActiveVOS Automation for Analysts?
What is the Automation for Analysts Perspective?
Creating a New Process
Using the Palette and Canvas
Editing Using BPMN Notation
Changing Activity Color and other Properties
Publishing Your Process
Running Your Process
Automation for Analysts Developer’s Guide
Automation for Analysts Developer’s Overview
Using the Sample as a Development Starting Point
Developing Automated Services and Resources
Creating a Template Project and Template.PDD
Creating the Automation for Analysts Workspace
Viewing the Default Automation for Analysts Perspective
Making the Automation for Analysts Perspective the Default
Customizing the Automation for Analysts Perspective
Showing and Hiding Views for the Automation for Analysts Workspace
Customizing the Palette
Creating a Working Set for the Project Explorer
Showing Activity Properties and Documentation
Setting the Automation for Analysts Perspective Preferences (Required)
Saving the Workspace for Distribution to Users
Updating a Workspace
Managing Deployed Processes
Advanced Topics
BPEL Standard Faults
Glossary
Index
Technical Support
Tips and Tricks
Tips and Tricks BPMN Design
ActiveVOS DataSource Data Model
Printed Version
What's New
ActiveVOS Installation and Components
Installation, System Requirements, and Licensing
ActiveVOS Designer Components
Welcome to ActiveVOS Designer
About ActiveVOS Designer
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
ActiveVOS Extensions to WS-BPEL 2.0
BPEL for People Extension to WS-BPEL 2.0
ActiveVOS Feature Tour
Printing ActiveVOS Designer User's Guide
Migrating from Earlier Versions
Required Reset for ActiveVOS Perspectives
Migrating from Designer Versions Prior to 9.0
Migrating from Designer Versions Prior to 8.0.x
Migrating from Designer Versions Prior to 7.x
Migrating from Designer Versions Prior to 6.x
Opening and Using BPEL4WS 1.1 Processes
Migrating Processes from BPEL4WS 1.1 to WS-BPEL 2.0
Taking Advantage of SOAP 1.2 Port Binding, Version 7.x
Saving From One Editing Style to Another (BPMN and Classic)
Converting Legacy Deployments to Contributions
ActiveVOS Tutorial
Introduction to ActiveVOS Tutorial
Tutorial Part 1: Starting a New Process
Tutorial Part 2: Planning and Designing a Process
Tutorial Part 3: Creating a Process Service Consumer Participant
Tutorial Part 4: Creating Partner Service Provider 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: Creating a Request to Run the Process
Tutorial Part 11: Debugging Your Process Remotely
Using the Web Services Explorer to Start a Process
Using ActiveVOS for the First Time
Launching ActiveVOS Designer
Using the Workspace to Store Projects
Creating an Orchestration Project
Changing the Default Location of a Workspace Project
Orchestration Project Templates
Adding or Removing a Project Orchestration Nature
About Project Orchestration and Validation Builders
Using Project References
Creating a New Process
Selecting the BPMN-Centric or BPEL-Centric Palette
Importing an Existing BPEL Process
Importing a Visio XML Drawing File
Begin Your First Project with ActiveVOS Assistance
Using the ActiveVOS Learning Tools
Setting Up the ActiveVOS Server
ActiveVOS Orchestration File Resources
Getting Started in ActiveVOS Designer
About ActiveVOS Designer and the Eclipse Workbench
Navigating Through ActiveVOS Designer
Windows, Perspectives, Views, and Editors
ActiveVOS Perspectives
ActiveVOS Designer Perspective
Project Explorer
Participants
Interfaces
Outline View
Properties View
Process Variables
Error Log
Problems View
Tasks View
Thumbnail View
Bookmarks View
Relationships View
Servers and Console Views
Status Bar
ActiveVOS Debug Perspective
BPMN-Centric and BPEL-Centric Edit Styles
What is BPMN-Centric Style?
What is BPEL-Centric Style?
Comparing the BPMN-Centric and BPEL-Centric Tool Palettes
Which Edit Style to Choose: BPMN-Centric or BPEL-Centric?
Using Swimlanes
What is ActiveVOS Classic Style?
Using the ActiveVOS 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
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
Showing and Hiding Activities
Process Editor Keyboard Shortcuts
ActiveVOS Function Keys
Customizing the ActiveVOS Perspective
ActiveVOS Menus and Toolbars
Refactor
Go To Activity (Ctrl + l)
Open Operation (Ctrl + Shift + t, o)
Open Port Type (Ctrl + Shift + t, p)
Open Web Type (Ctrl + Shift + t, w)
Optimize Parameters
Validate Process
Generate Process Report
Generate Process Image
Generate Deployment Image
ActiveVOS Preferences
BUnit Preference
Cache and Timeout Preference
Colors and Fonts Preferences
Contribution Preference
Layout Preferences
Relationships View Preferences
Tasks and Problems Preferences
Identity Chooser Preference
Additional Preferences
Accessing ActiveVOS Online Help
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
Creating a Java Interface
Setting up Your Java Project in ActiveVOS
Constraints for your Java Project
Generating WSDL and Schema from a Java Interface
Generating Argument Names for Schema Elements
Updating Your Java Project and Your BPEL Process Concurrently
Deployment Requirements for a Java (POJO) Endpoint
Deployment Requirements for Java (EJB) Endpoint
Running a BPEL Process with a POJO/EJB Endpoint
Comparing the POJO/EJB Interface to a Custom Java Invoke Handler
Using the Interfaces View to Create Activities
Interfaces Toolbar Options
Filtering the Interfaces View
System Services Interfaces
Creating a WSDL File with Extensions for BPEL
Using Sample Data for WSDL Messages
Adding or Editing 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 ActiveVOS Create XPath Extension
Using the ActiveVOS 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
Participants
What are Participants?
Using the Participants View
Creating a New Process Service Consumer Interface
Creating a New Partner Service Interface
Creating a New Callback Interface
Clearing a Service Interface from a Participant
Creating New Activities from the Participants View
Creating a New Variable From an Activity’s Property View
What are Partner Link Types and Partner Links?
Partner Link Type
Partner Link
Using Scoped Partner Links
Partner Links and Endpoint References
Implementing a BPMN Task or Event in BPEL
BPMN-to-BPEL Implementation of Tasks and Events
Overview of BPEL Activities
Defining an Activity and Its Properties
Selecting Values for Activity Properties
Selecting Activity Labels
Standard Properties for Activities
Adding a Background Color to a Task, Scope, People Activity and Handlers
Understanding and Using Activity Sequences and Flows
Receive
Reply
Throw
Rethrow
Exit
Wait
Compensate
Compensate Scope
Break
Continue
Start/End/None
Invoke
From Part to Variable
From Variable to Part
Input Variable
Output Variable
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
Empty
Suspend
Validate
Opaque
Creating a Custom Activity
Creating an Activity by Starting with a WSDL Interface
Implementing a BPMN Gateway or Control Flow
BPMN-to-BPEL Implementation of Gateways and Control Flow
Different Ways of Structuring Activities
Ungrouping Selected Structured Activities
Gateway
Mutually Exclusive Transitions
Pick
Fork Join
If
While
Repeat Until
Scope
Setting Isolated to “Yes” in a Scope
Using a Termination Handler for a Scope
Lifecycle of a Scope
For Each
Sequence
Flow
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 Manipulating Attachments
Attachment Custom Function Examples
Using Links
What is a Link?
ActiveVOS Extension for Links
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
Data Manipulation
Overview of Data Manipulation in BPEL
Selecting XPath or XQuery for Expression Building
Example XQuery Expressions
Example XPath Expressions
Using the Expression Builder
Using Content Assist
BPEL Functions
ActiveVOS Custom Functions
String Functions
Number Functions
Boolean Functions
Node Set Functions
Expected Expressions for Conditions, Counters, and Other Values
Using the Query Builder
Creating a Join Condition for an Incoming Link
Deadline and Duration Expressions
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
Adding Boundary Events
Catch and Catch All Boundary Events and Compensate, Compensate Scope and Rethrow
Using a Variable from a Catch or Interrupting OnEvent Boundary Event
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 a Fault Handler as a Boundary Event 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
Catching Undeclared and SOAP Faults
Simulating and Debugging
What is the ActiveVOS Debug Perspective?
Opening the ActiveVOS Debug Perspective
Switching Between ActiveVOS Perspectives
ActiveVOS Debug Perspective Views and Menus
Using the ActiveVOS Debug View
Using Breakpoints in BPEL Process Simulation
Using the ActiveVOS 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
Selecting an Invoke Subprocess for Simulation
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
Monitoring Client Message Traffic with TCP/IP Monitor
Deploying Your Processes
What is Deployment?
Preparing for Deployment
Preparing BPEL Files for Deployment
Selecting a Server Platform for Deployed Processes
Endpoint Reference Addressing Considerations
Endpoint References and WS-Addressing Considerations
Endpoint References Requiring Credentials for Access
Specifying a Replaceable URN/URL for an Endpoint Reference
Endpoint References and WS-Policy
Overview of Process Deployment Steps
Creating a Process Deployment Descriptor File
General Deployment Options
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
Using SOAP 1.1 or 1.2 Port Binding
Adding Policy Assertions
Authentication
Encryption
Signature
Timestamp
User-Defined Policy Assertion
Retry
Engine-Managed Correlation
WS-Reliable Messaging
JMS Delivery Options
HTTP Transport
REST Enabled
SAML
Message Validation
Web Service Timeout
Invoke Recovery
Send WS-Addressing Headers
WSDL Binding Reference
Suppress xsi:type
Run As User
Adding Indexed Properties
Viewing References
Eventing tab of the PDD
People tab of the PDD
Using the PDD Editor Source View
Creating and Deploying a Business Process Archive Contribution
Deploying Project Dependencies and Viewing Excluded Dependencies
Deploying Additional Resources
Managing Deployment Contributions
Using a BPRD Script to Regenerate and Deploy a BPR Contribution
Running a BPRD Ant Script from within Designer
Running a BPRD Ant Script from the Command Line
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 in Designer
Creating and Running a B-unit Ant Script
Generating a Code Coverage Report
Editing a B-unit File
BPEL Unit (Root)
Extensions and Extension Activities
Invokes
Alarms
Commands
Debugging a B-unit Test
Creating and Running BPEL Unit Test Suites
Tips on Using Assertions
Tips on Using Parameterized XSL for Input and Assert Data
Tips on Providing Partner Link Data
Example B-unit File
Creating POJO and XQuery Custom Functions
About Java Custom Functions and XQuery Modules
Custom Functions Overview
Implementing the Function Context and Adding Annotations
Sample Custom Function
Adding Global Custom Functions to the ActiveVOS Server
Specifying Legacy Custom Function Simulation Setup
Writing XQuery Functions
Using the XQuery Editor
Tips on Writing XQuery Functions
Testing XQuery Functions in the XQuery Editor
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 an OAuth REST-Based System Service
Specifying Deployment Details for a OAuth Service Provider
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 Programmatically with a Suspend Activity
Remote Debugging a Faulting Activity
Creating Reports for ActiveVOS Server and Central
About ActiveVOS Server and Central Reports
Creating the User Reports Orchestration Project
Using the ActiveVOS Report Template
Using the ActiveVOS Data Source
Creating a Data Set from the ActiveVOS Data Source
Understanding the ActiveVOS Data Model
Deploying an ActiveVOS Report
Updating or Deleting an ActiveVOS Deployed Report
Reporting Service
Business Event Processing
What is Business Event Processing?
Defining an Event in the Process Deployment Descriptor
Using System-Defined Events
Creating an Event-Action BPEL Process
Activity States, Event Properties, Task States, and Task Event Types
ActiveVOS Central Forms and Configuration
What is ActiveVOS Central?
Creating an ActiveVOS Central Process Request Form
Understanding the Process Request Form Template
Editing HTML in ActiveVOS Central Forms
Adding a New Service Operation for a Request or Task Form
Customizing Task and Request Form Scripts: An Introduction
Using the ActiveVOS SDK for Customizing Forms
Testing and Debugging ActiveVOS Central Forms
Creating an ActiveVOS Central Configuration File
Configuring Requests Filters
Configuring Reports Filters
Including Your Own Styles, Scripts, and Meta Data for ActiveVOS Central
Configuring Task Role Filters
Basic Task Roles Filter Configuration
Configuring Custom Columns for Task Roles Filtering
Configuring a GetMyTasks Filter with a WhereClause
Configuring a RSS or Atom Feed Filter
Deploying Process Requests, Reports, and Configuration Files
Adding MultiLingual Support to ActiveVOS Central
Displaying ActiveVOS Central in a Web Browser’s Preferred Language
Adding MultiLingual Support for Request and Task Forms
Adding MultiLingual Support for an .avcconfig File
Adding MultiLingual Support for Reports
Naming Convention for a .properties File
ActiveVOS Central Advanced Configuration
Building a Process with a System Service
Using a BPEL Template for a System Service-Based Process
Alert Service
Retry-Policy Service
Identity Service
Email Service
Monitoring Alert Service
Server Log Service
Shell Command Invoke Service
Data Access Service
Simulating the Data Access Invoke Output
Migration Service
Using the ActiveVOS Migration Web Service
Creating a Screenflow Automated Step Service
About the Screenflow Automated Step Demo Sample Project
Logging into Screenflow Designer
Importing the Demo Guides into Screenflow Designer
What is a Screenflow Automated Step?
Using the Automated Step Request, Response, and Fault Messages
Providing Rendering Hints for Guide Data
Creating the Automated Step Service Descriptor
Creating a Screenflow Layout Theme
Automation for Analysts User’s Guide
What is ActiveVOS Automation for Analysts?
What is the Automation for Analysts Perspective?
Creating a New Process
Using the Palette and Canvas
Editing Using BPMN Notation
Changing Activity Color and other Properties
Publishing Your Process
Running Your Process
Automation for Analysts Developer’s Guide
Automation for Analysts Developer’s Overview
Using the Sample as a Development Starting Point
Developing Automated Services and Resources
Creating a Template Project and Template.PDD
Creating the Automation for Analysts Workspace
Viewing the Default Automation for Analysts Perspective
Making the Automation for Analysts Perspective the Default
Customizing the Automation for Analysts Perspective
Showing and Hiding Views for the Automation for Analysts Workspace
Customizing the Palette
Creating a Working Set for the Project Explorer
Showing Activity Properties and Documentation
Setting the Automation for Analysts Perspective Preferences (Required)
Saving the Workspace for Distribution to Users
Updating a Workspace
Managing Deployed Processes
Advanced Topics
BPEL Standard Faults
Glossary
Index
Technical Support
Tips and Tricks
Tips and Tricks BPMN Design
ActiveVOS DataSource Data Model
Printed Version
BPEL for People Online Help V9.1.0.2
Welcome to ActiveVOS 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
Participants and Tasks
What are Participants and Tasks?
Creating a Human Task Participant
Using the Identity Chooser to Assign a Name to a Participant Role
Creating a Task for a Participant
Using BPEL4People Extension Elements and Activities
Human Interactions Extension Element
About Logical People Groups
Creating a Logical People From the Outline View
Logical People Group Parameters and Arguments
Using a Logical People Group in an Assign Activity
Selecting Users or Groups for Logical People Groups During Deployment
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
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 MultiLingual Support for Task Subject, Description, and Display Name
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
Sending Email 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 BPMN Palette
Adding a People Activity Using the Participants View
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
Simulating Comments Returned from a Task
Viewing Task Input Data While Simulating
Selecting a Logical People Group Handler During Deployment
Using or Mapping Users or Groups From the Identity Service
Adding a People Query
Using the Identity Chooser During Deployment
Running Your Process from the ActiveVOS Server
Providing Renderings for ActiveVOS Task Clients
About Task Presentation in ActiveVOS Central
Rendering a Task Interface into a User Interface
Creating an ActiveVOS Central Task Form
Merging Input and Output Fields in a Task Form
Working in Development Mode or Production Mode
Understanding the Task Form Template
Examples of Task Forms for End Users
Adding a New Service Operation to a Task Form
Providing Multilingual Support for Task Forms
Deploying a Task Form and Properties Files
Creating an ActiveVOS Central Configuration File for Tasks
What is the ActiveVOS Inbox?
Viewing the Default Rendering of ActiveVOS Inbox Details Page
Adding ActiveVOS Inbox XSL Rendering
Creating Custom Inbox XSL Rendering
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
Using Customized Task Clients
What is the ActiveVOS WS-HumanTask API?
Using the ActiveVOS WS-HT and Identity Service SDK
What is the Inbox Rendering SDK?
Using the Active Endpoints Inbox Rendering SDK
Advanced Inbox Modifications
Creating Custom Task Properties
WS-HT Task Property List
Creating a Custom Task Property
Configuring ActiveVOS Central Task Columns and Task Filters Using Properties
Printed Version
Welcome to ActiveVOS 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
Participants and Tasks
What are Participants and Tasks?
Creating a Human Task Participant
Using the Identity Chooser to Assign a Name to a Participant Role
Creating a Task for a Participant
Using BPEL4People Extension Elements and Activities
Human Interactions Extension Element
About Logical People Groups
Creating a Logical People From the Outline View
Logical People Group Parameters and Arguments
Using a Logical People Group in an Assign Activity
Selecting Users or Groups for Logical People Groups During Deployment
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
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 MultiLingual Support for Task Subject, Description, and Display Name
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
Sending Email 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 BPMN Palette
Adding a People Activity Using the Participants View
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
Simulating Comments Returned from a Task
Viewing Task Input Data While Simulating
Selecting a Logical People Group Handler During Deployment
Using or Mapping Users or Groups From the Identity Service
Adding a People Query
Using the Identity Chooser During Deployment
Running Your Process from the ActiveVOS Server
Providing Renderings for ActiveVOS Task Clients
About Task Presentation in ActiveVOS Central
Rendering a Task Interface into a User Interface
Creating an ActiveVOS Central Task Form
Merging Input and Output Fields in a Task Form
Working in Development Mode or Production Mode
Understanding the Task Form Template
Examples of Task Forms for End Users
Adding a New Service Operation to a Task Form
Providing Multilingual Support for Task Forms
Deploying a Task Form and Properties Files
Creating an ActiveVOS Central Configuration File for Tasks
What is the ActiveVOS Inbox?
Viewing the Default Rendering of ActiveVOS Inbox Details Page
Adding ActiveVOS Inbox XSL Rendering
Creating Custom Inbox XSL Rendering
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
Using Customized Task Clients
What is the ActiveVOS WS-HumanTask API?
Using the ActiveVOS WS-HT and Identity Service SDK
What is the Inbox Rendering SDK?
Using the Active Endpoints Inbox Rendering SDK
Advanced Inbox Modifications
Creating Custom Task Properties
WS-HT Task Property List
Creating a Custom Task Property
Configuring ActiveVOS Central Task Columns and Task Filters Using Properties
Printed Version
ActiveVOS Enterprise Administration Console Online Help V9.1.0.2
ActiveVOS Server Console Overview
How To’s
Deploy
Search
Prerequisites for Running the ActiveVOS Console
Options for Different Application Servers
Understanding the Properties of an Invoked Service
Home
Dashboard
Active Processes
Server Status
Monitor
Process Monitoring
Active Processes
Using Selection Filters for Active Processes
Suspending, Resuming, Terminating, or Deleting Selected Processes
Active Process Detail Page
Using the Active Process Detail Canvas View
Using the Active Process Detail Outline View
Using the Active Process Detail Executing View
Using the Active Process Detail Log for Analysis
Process Rewind and Exception Management Overview
Process Rewind
Restoring Variable Data When Rewinding a Process
Tips for Using Process Rewind
Process Exception Management
Migrating Running Processes when Warnings are Generated
Working with Variable Attachments
Alarm Queue
Receive Queue
Dispatch Service
Task Monitoring
About Human Tasks
Active Tasks
Work Queues
Server Monitoring
Server Statistics
Deployment Logs
Server Log
System Performance
Reports
Catalog
Contributions
Contribution Detail
Converting Legacy Deployments to Contributions
Process Definitions
Deployed Process Detail
Deployed Process Version Detail
Process Version Life Cycles
Updating a Process Version
Setting a Process Version Offline or Online
Logging Level
Process Version Persistence Type
Exception Management Type
Invoke Recovery Type
Process Instance Retention
Deployed Process Detail Graph
Indexed Properties
Partner Definitions
Resources
Viewing Catalog Resources
Resource List
Service Definitions
Task Properties
Admin
Cluster
Cluster Properties
License
CPU Count
Configure Server
Server Properties
Logging Properties
Global Function Contexts
Monitoring Thresholds, Properties, and Monitor Alert Service
URN Mappings
Configure Services
Alert Service
Email Service
Identity Service
XML or LDIF Identity Service
LDAP Identity Service
Creating a Trusted Keystore File
JDBC Identity Service
User and Group Attribute Mapping
Testing LDAP and JDBC Configurations
Importing and Exporting an Identity Configuration
Identity Service Cache Settings
Manual Configuration for a JDBC Identity Service on Tomcat
Messaging Service
Enabling XA Transaction Handling
Central Service
Maintenance
Scheduled Processes
Creating a New Process Schedule
Managing and Modifying Execution Schedules
Storage
MultiSite
Site Properties
Site Independent (Non-Replicated) Data and Configuration
Configuring File Locations for Identity Service and Global Functions
MultiTenancy
Tenant Administration for System Administrators
Tenant Administration for Tenant Administrators/Deployers
Tenant Access to Public Resources
BPEL Standard Faults
ActiveVOS Custom Faults
Printed Version
ActiveVOS Server Console Overview
How To’s
Deploy
Search
Prerequisites for Running the ActiveVOS Console
Options for Different Application Servers
Understanding the Properties of an Invoked Service
Home
Dashboard
Active Processes
Server Status
Monitor
Process Monitoring
Active Processes
Using Selection Filters for Active Processes
Suspending, Resuming, Terminating, or Deleting Selected Processes
Active Process Detail Page
Using the Active Process Detail Canvas View
Using the Active Process Detail Outline View
Using the Active Process Detail Executing View
Using the Active Process Detail Log for Analysis
Process Rewind and Exception Management Overview
Process Rewind
Restoring Variable Data When Rewinding a Process
Tips for Using Process Rewind
Process Exception Management
Migrating Running Processes when Warnings are Generated
Working with Variable Attachments
Alarm Queue
Receive Queue
Dispatch Service
Task Monitoring
About Human Tasks
Active Tasks
Work Queues
Server Monitoring
Server Statistics
Deployment Logs
Server Log
System Performance
Reports
Catalog
Contributions
Contribution Detail
Converting Legacy Deployments to Contributions
Process Definitions
Deployed Process Detail
Deployed Process Version Detail
Process Version Life Cycles
Updating a Process Version
Setting a Process Version Offline or Online
Logging Level
Process Version Persistence Type
Exception Management Type
Invoke Recovery Type
Process Instance Retention
Deployed Process Detail Graph
Indexed Properties
Partner Definitions
Resources
Viewing Catalog Resources
Resource List
Service Definitions
Task Properties
Admin
Cluster
Cluster Properties
License
CPU Count
Configure Server
Server Properties
Logging Properties
Global Function Contexts
Monitoring Thresholds, Properties, and Monitor Alert Service
URN Mappings
Configure Services
Alert Service
Email Service
Identity Service
XML or LDIF Identity Service
LDAP Identity Service
Creating a Trusted Keystore File
JDBC Identity Service
User and Group Attribute Mapping
Testing LDAP and JDBC Configurations
Importing and Exporting an Identity Configuration
Identity Service Cache Settings
Manual Configuration for a JDBC Identity Service on Tomcat
Messaging Service
Enabling XA Transaction Handling
Central Service
Maintenance
Scheduled Processes
Creating a New Process Schedule
Managing and Modifying Execution Schedules
Storage
MultiSite
Site Properties
Site Independent (Non-Replicated) Data and Configuration
Configuring File Locations for Identity Service and Global Functions
MultiTenancy
Tenant Administration for System Administrators
Tenant Administration for Tenant Administrators/Deployers
Tenant Access to Public Resources
BPEL Standard Faults
ActiveVOS Custom Faults
Printed Version
ActiveVOS Enterprise Server User Guide V9.1.0.2
Preface
Welcome to ActiveVOS Server
What are the Server Components of ActiveVOS?
Installing, Configuring, and Starting Up the Server
Using ActiveVOS Designer
Using the ActiveVOS Server Administration Console
Using ActiveVOS Central
Accessing ActiveVOS Service Endpoints
List of ActiveVOS URLS
ActiveVOS APIs and SDKs
Security Configurations
Configuring ActiveVOS Server for WS-Security
Configuring Authentication for SAML-Secured Services
Securing ActiveVOS Server Components
Configuring Your Application Server to Work with ActiveVOS Security Roles
Standard or Java-based Service Endpoints for Process Consumer (My Role) Partner Links
Invoking a Process Using Standard SOAP or Policy-Driven Bindings
Invoking a Process from Java
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
Printed Version
Preface
Welcome to ActiveVOS Server
What are the Server Components of ActiveVOS?
Installing, Configuring, and Starting Up the Server
Using ActiveVOS Designer
Using the ActiveVOS Server Administration Console
Using ActiveVOS Central
Accessing ActiveVOS Service Endpoints
List of ActiveVOS URLS
ActiveVOS APIs and SDKs
Security Configurations
Configuring ActiveVOS Server for WS-Security
Configuring Authentication for SAML-Secured Services
Securing ActiveVOS Server Components
Configuring Your Application Server to Work with ActiveVOS Security Roles
Standard or Java-based Service Endpoints for Process Consumer (My Role) Partner Links
Invoking a Process Using Standard SOAP or Policy-Driven Bindings
Invoking a Process from Java
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
Printed Version
ActiveVOS Central Online Help V9.1.0.2
About ActiveVOS Central
Navigating in ActiveVOS Central
Vacation Delegation Settings
Working with Tasks
What is an ActiveVOS Task?
Navigating in the Tasks View
Refreshing Your Task List
About Users and Administrators
Claiming and Performing Other Actions for a Task
Working with a Task, Attachments and Comments
Completing a Task
Assigning a Task to Another User
What Happens When a Task is Overdue
Reading and Removing Notifications
Viewing Task History
Viewing Task Detail
Using an RSS Feed
Making Requests
What is a Request?
Submitting a Request
Viewing Reports
Welcome to Screenflow Designer
What is Screenflow Designer?
Screenflow Designer Demo
Start-up Checklist
Using the Screenflow Designer
About the Screenflow Designer Home Page
What is a Guide?
Creating, Importing, and Exporting Guides
Using Settings
Publishing and Unpublishing a Guide
Running a Guide
Terminating all Running Guides
Sharing Guide Design with Other Screenflow Designer Users
Using the Screenflow Designer Editor
Starting a Guide Design
Using the Editor Toolbar
Creating Different Types of Steps
Using the First Step
Creating a Screen Step
Creating an Automated Step
Set Guide Data Automated Step
Creating a Jump Step
Creating an Embedded Guide Step
Creating a Data Decision Step
Creating an End Step
Inserting Fields and Layout Features in a Screen and End Step
Insert, Cut, Copy, and Paste Steps and SubTrees
Saving a Guide
Simulating a Running Guide
Using Data
Adding Data Fields to the Guide’s Properties
Automated Step and Guide Step Data
Data Fields within a Screen or End Step
Data Decision Data Fields
Screenflow Usage Reports
ActiveVOS Central Configuration
Starting and Logging Into ActiveVOS Central
Session Time Out
Showing and Hiding ActiveVOS Central Components
Printed Version
About ActiveVOS Central
Navigating in ActiveVOS Central
Vacation Delegation Settings
Working with Tasks
What is an ActiveVOS Task?
Navigating in the Tasks View
Refreshing Your Task List
About Users and Administrators
Claiming and Performing Other Actions for a Task
Working with a Task, Attachments and Comments
Completing a Task
Assigning a Task to Another User
What Happens When a Task is Overdue
Reading and Removing Notifications
Viewing Task History
Viewing Task Detail
Using an RSS Feed
Making Requests
What is a Request?
Submitting a Request
Viewing Reports
Welcome to Screenflow Designer
What is Screenflow Designer?
Screenflow Designer Demo
Start-up Checklist
Using the Screenflow Designer
About the Screenflow Designer Home Page
What is a Guide?
Creating, Importing, and Exporting Guides
Using Settings
Publishing and Unpublishing a Guide
Running a Guide
Terminating all Running Guides
Sharing Guide Design with Other Screenflow Designer Users
Using the Screenflow Designer Editor
Starting a Guide Design
Using the Editor Toolbar
Creating Different Types of Steps
Using the First Step
Creating a Screen Step
Creating an Automated Step
Set Guide Data Automated Step
Creating a Jump Step
Creating an Embedded Guide Step
Creating a Data Decision Step
Creating an End Step
Inserting Fields and Layout Features in a Screen and End Step
Insert, Cut, Copy, and Paste Steps and SubTrees
Saving a Guide
Simulating a Running Guide
Using Data
Adding Data Fields to the Guide’s Properties
Automated Step and Guide Step Data
Data Fields within a Screen or End Step
Data Decision Data Fields
Screenflow Usage Reports
ActiveVOS Central Configuration
Starting and Logging Into ActiveVOS Central
Session Time Out
Showing and Hiding ActiveVOS Central Components
Printed Version
ActiveVOS Designer Samples Documentation
Documentation for Sample Orchestration Project Templates
Starting the ActiveVOS Server
Human Approval
Getting Started
Preparing the Process for Human Interaction
Adding Human Interaction
Completing the Human Review
Updating Fault Handling
Simulating the Process
Creating a Request Form
Preparing for Deployment
Running the Process on the Server
Human Approval Completed
Getting Started with the Completed project
Start the ActiveVOS Embedded Server
Deploy the Loan Process
Deploy the Partner Processes
Run the Loan Process on the server
Claim, update and complete the human task
Review the completed Loan Process
User Reports
Getting Started with the User Reports project
Sample Reports
Deploying the Sample Reports
Appendix I: ActiveVOS Process Data Model
Appendix II: ActiveVOS Human Task Data Model
Screenflow Automated Step Service
Documentation for Sample Orchestration Project Templates
Starting the ActiveVOS Server
Human Approval
Getting Started
Preparing the Process for Human Interaction
Adding Human Interaction
Completing the Human Review
Updating Fault Handling
Simulating the Process
Creating a Request Form
Preparing for Deployment
Running the Process on the Server
Human Approval Completed
Getting Started with the Completed project
Start the ActiveVOS Embedded Server
Deploy the Loan Process
Deploy the Partner Processes
Run the Loan Process on the server
Claim, update and complete the human task
Review the completed Loan Process
User Reports
Getting Started with the User Reports project
Sample Reports
Deploying the Sample Reports
Appendix I: ActiveVOS Process Data Model
Appendix II: ActiveVOS Human Task Data Model
Screenflow Automated Step Service
ActiveVOS SDK Package and Documentation
About the ActiveVOS SDK
ActiveVOS SDK Package Archive (zip file)
ActiveVOS Server Administration API
ActiveVOS Identity Service API
ActiveVOS Web Services Human Task (WS-HT) API
ActiveVOS XML-JSON API
ActiveVOS XML-JSON for ActiveVOS Central
About the ActiveVOS SDK
ActiveVOS SDK Package Archive (zip file)
ActiveVOS Server Administration API
ActiveVOS Identity Service API
ActiveVOS Web Services Human Task (WS-HT) API
ActiveVOS XML-JSON API
ActiveVOS XML-JSON for ActiveVOS Central
ActiveVOS Server Installation, Configuration, and Deployment Guide V9.1.0.2
Apache Tomcat
Quick Start
Prerequisites
Installation
Configuration
Installation Checklist
Glossary
Configuration and Deployment Utility Help Topics
Engine Configuration Help
Server JNDI Configuration Help
ActiveVOS Central Configuration Help
Database Configuration Help
Configuration and Deployment Options Help
Clustering Help
Security Configuration Help
Deployment Options Help
Deployment Targets Help
WebLogic
Quick Start
Prerequisites
Installation Folders
Configuration
MultiSite Configuration
Installation Checklist
Glossary
Configuration and Deployment Utility Help Topics
Engine Configuration Help
Server JNDI Configuration Help
ActiveVOS Central Configuration Help
Database Configuration Help
Configuration and Deployment Options Help
Security Configuration Help
Work Manager Configuration Help
Deployment Options Help
Deployment Targets Help
IBM Websphere
Quick Start
Prerequisites
Installation Folders
Configuration
Installation Checklist
Glossary
Configuration and Deployment Utility Help Topics
Engine Configuration Help
Server JNDI Configuration Help
ActiveVOS Central Configuration Help
Database Configuration Help
Configuration and Deployment Options 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
Prerequisites
Installation Folders
Configuration
Installation Checklist
Glossary
Configuration and Deployment Utility Help Topics
Engine Configuration Help
Server JNDI Configuration Help
ActiveVOS Central Configuration Help
Database Configuration Help
Configuration and Deployment Options Help
Security Configuration Help
Deployment Options Help
Deployment Targets Help
Apache Tomcat
Quick Start
Prerequisites
Installation
Configuration
Installation Checklist
Glossary
Configuration and Deployment Utility Help Topics
Engine Configuration Help
Server JNDI Configuration Help
ActiveVOS Central Configuration Help
Database Configuration Help
Configuration and Deployment Options Help
Clustering Help
Security Configuration Help
Deployment Options Help
Deployment Targets Help
WebLogic
Quick Start
Prerequisites
Installation Folders
Configuration
MultiSite Configuration
Installation Checklist
Glossary
Configuration and Deployment Utility Help Topics
Engine Configuration Help
Server JNDI Configuration Help
ActiveVOS Central Configuration Help
Database Configuration Help
Configuration and Deployment Options Help
Security Configuration Help
Work Manager Configuration Help
Deployment Options Help
Deployment Targets Help
IBM Websphere
Quick Start
Prerequisites
Installation Folders
Configuration
Installation Checklist
Glossary
Configuration and Deployment Utility Help Topics
Engine Configuration Help
Server JNDI Configuration Help
ActiveVOS Central Configuration Help
Database Configuration Help
Configuration and Deployment Options 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
Prerequisites
Installation Folders
Configuration
Installation Checklist
Glossary
Configuration and Deployment Utility Help Topics
Engine Configuration Help
Server JNDI Configuration Help
ActiveVOS Central Configuration Help
Database Configuration Help
Configuration and Deployment Options Help
Security Configuration Help
Deployment Options Help
Deployment Targets Help