WebLogic Process Integrator API Documentation

This document is the API specification of the WebLogic Process Integrator, version 2.0.

See:
Description

Packages

com.bea.eci.repository.helper	Provides the classes required by the ECI repository interface.
com.bea.wlpi.client.common	Provides the WebLogic Process Integrator common client-side classes.
com.bea.wlpi.client.util	Various utilities for use with WebLogic Process Integrator.
com.bea.wlpi.common	Provides common classes used by both the WebLogic Process Integrator client and server.
com.bea.wlpi.common.plugin	Provides common classes used by plugins in the WebLogic Process Integrator client and server.
com.bea.wlpi.common.security	Provides common classes used by security in the WebLogic Process Integrator.

This document is the API specification of the WebLogic Process Integrator, version 2.0.

WebLogic Process Integrator^TM

The public API to WebLogic Process Integrator is comprised of the following components:

Enterprise Java Beans

Remote Interface	Home Interface	Purpose
Admin	AdminHome	Administrative and design time services
Audit	AuditHome	Auditing services
EJBCatalog	EJBCatalogHome	EJB cataloging
Permission	PermissionHome	Permissions for organizations, roles and users
PluginManager	PluginManagerHome	Manages installed plugins
PluginManagerCfg	PluginManagerCfgHome	Configures installed plugins
WLPIPrincipal	WLPIPrincipalHome	Organizations, roles and users
ServerProperties	ServerPropertiesHome	Server information
Worklist	WorklistHome	Worklist services

Additional Public API Classes

The following classes are used by the public API, but do not belong to documented packages. They are listed below for navigational purposes, and to provide a high-level context for their use.

Package	Class	Purpose
com.bea.wlpi.evaluator	EvaluationContext	Passes evaluation parameters to nodes in an expression parse tree.
com.bea.wlpi.server.common	ExecutionContext	Provides run-time context and services to plugin-supplied nodes and actions.
com.bea.wlpi.server.plugin	ActionContext	Provides additional run-time context and services to plugin actions.
com.bea.wlpi.server.plugin	EventContext	Provides additional run-time context and services to plugin event and start nodes.
com.bea.wlpi.server.plugin	EventHandler	An interface through which plugins can handle or transform incoming event data.
com.bea.wlpi.server.plugin	InstanceNotification	Notification object that describes a change to a workflow instance.
com.bea.wlpi.server.plugin	Plugin	Remote interface that defines the functionality of a plugin.
com.bea.wlpi.server.plugin	PluginAction	The interface that a plugin must implement to define a new action.
com.bea.wlpi.server.plugin	PluginDone	The interface that a plugin must implement to define a new done node type.
com.bea.wlpi.server.plugin	PluginEvent	The interface that a plugin must implement to define a new event node type.
com.bea.wlpi.server.plugin	PluginHome	The home interface for all plugins.
com.bea.wlpi.server.plugin	PluginNotification	The abstract base class for all plugin notifications.
com.bea.wlpi.server.plugin	PluginStart	The interface that a plugin must implement to define a new start node type.
com.bea.wlpi.server.plugin	PluginTemplateNode	The base interface for plugin provided start and done nodes.
com.bea.wlpi.server.plugin	TaskNotification	Notification object that describes a change to a task instance.
com.bea.wlpi.server.plugin	TemplateDefinitionNotification	Notification object that describes a change to a template definition.
com.bea.wlpi.server.plugin	TemplateNotification	Notification object that describes a change to a template.

XML Document Type Definitions

XML documents of various types are used as input and/or output by various API methods. Their document type definitions are as follows:

DTD	Used By	Purpose
Audit.dtd	WorkflowProcessor	A workflow auditing message.
BusinessCalendar.dtd	Admin	Business calendar rules definition.
ClientCallAddInReq.dtd	Worklist	Requests the client to invoke a client-side Java addin class.
ClientCallAddInResp.dtd	Worklist	Returns result from invoked client-side Java addin class.
ClientCallPgmReq.dtd	Worklist	Requests the client to launch an executable program.
ClientCallPgmResp.dtd	Worklist	Returns the exit status of an executable program.
ClientMsgBoxReq.dtd	Worklist	Requests the client to display a message box.
ClientMsgBoxResp.dtd	Worklist	Returns the user's response to a message box.
ClientReq.dtd	Worklist	Generic XML document returned by various worklist requests.
ClientSetVarsReq.dtd	Worklist	Requests the client to display a 'Set Variables' dialog.
ClientSetVarsResp.dtd	Worklist	Returns the user's response to a 'Set Variables' dialog.
StatisticsReq.dtd	Admin	Statistics report specification.
StatisticsResp.dtd	Admin	Statistics report results.
TemplateDefinition.dtd	Admin	Workflow process definition.
WorkloadReq.dtd	Admin	Workload report specification.
WorkloadResp.dtd	Admin	Workload report results.

Glossary of Terms

Follow this link for a Glossary of Terms used by WebLogic Process Integrator.