- 1.Change History
- 2.Purpose
- 3.Audience
- 4.Overview
- 4.1Design Philosophy
- 4.2Design Assumptions
- 4.3Design Objectives
- 4.4Defined Terms and Abbreviations
- 4.5Reference Documents
- 4.6Conformance
- 4.7WAPI Naming Conventions
- 5.WAPI Data Types
- 5.1Basic WAPI Data Types
- 5.2Other WAPI Data Types
- 5.3Attributes
- 6.WAPI Error Return Codes
- 7.WAPI Descriptions
- 7.1WAPI Connection Functions
- 7.1.1WMConnect
- NAME
- DESCRIPTION
- 7.1.2WMDisconnect
- NAME
- DESCRIPTION
- ERROR RETURN VALUE
- 7.2WAPI Process Control Functions
- 7.2.1WMOpenProcessDefinitionsList
- NAME
- DESCRIPTION
- ERROR RETURN VALUE
- REQUIREMENTS
- RATIONALE FOR API
- 7.2.2WMFetchProcessDefinition
- NAME
- DESCRIPTION
- ERROR RETURN VALUE
- 7.2.3WMCloseProcessDefinitionsList
- NAME
- DESCRIPTION
- ERROR RETURN VALUE
- 7.2.4WMOpenProcessDefinitionStatesList
- NAME
- DESCRIPTION
- ERROR RETURN VALUE
- 7.2.5WMFetchProcessDefinitionState
- NAME
- DESCRIPTION
- ERROR RETURN VALUE
- 7.2.6WMCloseProcessDefinitionStatesList
- NAME
- DESCRIPTION
- ERROR RETURN VALUE
- 7.2.7WMChangeProcessDefinitionState
- NAME
- DESCRIPTION
- ERROR RETURN VALUE
- REQUIREMENTS
- RATIONALE FOR API
- 7.2.8WMCreateProcessInstance
- NAME
- DESCRIPTION
- ERROR RETURN VALUE
- REQUIREMENTS
- RATIONALE FOR API
- 7.2.9WMStartProcess
- NAME
- DESCRIPTION
- ERROR RETURN VALUE
- REQUIREMENTS
- RATIONALE FOR API
- 7.2.10WMTerminateProcessInstance
- NAME
- DESCRIPTION
- ERROR RETURN VALUE
- REQUIREMENTS
- 7.2.11WMOpenProcessInstanceStatesList
- NAME
- DESCRIPTION
- ERROR RETURN VALUE
- 7.2.12WMFetchProcessInstanceState
- NAME
- DESCRIPTION
- ERROR RETURN VALUE
- 7.2.13WMCloseProcessInstanceStatesList
- NAME
- DESCRIPTION
- ERROR RETURN VALUE
- 7.2.14WMChangeProcessInstanceState
- NAME
- DESCRIPTION
- ERROR RETURN VALUE
- REQUIREMENTS
- RATIONALE FOR API
- 7.2.15WMOpenProcessInstanceAttributesList
- NAME
- DESCRIPTION
- ERROR RETURN VALUE
- 7.2.16WMFetchProcessInstanceAttribute
- NAME
- DESCRIPTION
- ERROR RETURN VALUE
- 7.2.17WMCloseProcessInstanceAttributesList
- NAME
- DESCRIPTION
- ERROR RETURN VALUE
- 7.2.18WMGetProcessInstanceAttributeValue
- NAME
- DESCRIPTION
- ERROR RETURN VALUE
- 7.2.19WMAssignProcessInstanceAttribute
- NAME
- DESCRIPTION
- ERROR RETURN VALUE
- REQUIREMENTS
- 7.3WAPI Activity Control Functions
- 7.3.1 WMOpenActivityInstanceStatesList
- NAME
- DESCRIPTION
- ERROR RETURN VALUE
- 7.3.2WMFetchActivityInstanceState
- NAME
- DESCRIPTION
- ERROR RETURN VALUE
- 7.3.3WMCloseActivityInstanceStatesList
- NAME
- DESCRIPTION
- ERROR RETURN VALUE
- 7.3.4WMChangeActivityInstanceState
- NAME
- DESCRIPTION
- ERROR RETURN VALUE
- REQUIREMENTS
- RATIONALE FOR API
- 7.3.5 WMOpenActivityInstanceAttributesList
- NAME
- DESCRIPTION
- ERROR RETURN VALUE
- 7.3.6WMFetchActivityInstanceAttribute
- NAME
- DESCRIPTION
- ERROR RETURN VALUE
- 7.3.7WMCloseActivityInstanceAttributesList
- NAME
- DESCRIPTION
- ERROR RETURN VALUE
- 7.3.8WMGetActivityInstanceAttributeValue
- NAME
- DESCRIPTION
- ERROR RETURN VALUE
- 7.3.9WMAssignActivityInstanceAttribute
- NAME
- DESCRIPTION
- ERROR RETURN VALUE
- REQUIREMENTS
- 7.4WAPI Process Status Functions
- 7.4.1WMOpenProcessInstancesList
- NAME
- DESCRIPTION
- ERROR RETURN VALUE
- REQUIREMENTS
- RATIONALE FOR API
- 7.4.2WMFetchProcessInstance
- NAME
- DESCRIPTION
- ERROR RETURN VALUE
- REQUIREMENTS
- 7.4.3WMCloseProcessInstancesList
- NAME
- DESCRIPTION
- ERROR RETURN VALUE
- 7.4.4WMGetProcessInstance
- NAME
- DESCRIPTION
- ERROR RETURN VALUE
- REQUIREMENTS
- 7.5WAPI Activity Status Functions
- 7.5.1WMOpenActivityInstancesList
- NAME
- DESCRIPTION
- ERROR RETURN VALUE
- REQUIREMENTS
- RATIONALE FOR API
- 7.5.2WMFetchActivityInstance
- NAME
- DESCRIPTION
- ERROR RETURN VALUE
- REQUIREMENTS
- 7.5.3WMCloseActivityInstancesList
- NAME
- DESCRIPTION
- ERROR RETURN VALUE
- REQUIREMENTS
- 7.5.4WMGetActivityInstance
- NAME
- DESCRIPTION
- ERROR RETURN VALUE
- REQUIREMENTS
- 7.6WAPI Worklist
- Functions
- 7.6.1WMOpenWorkList
- NAME
- DESCRIPTION
- ERROR RETURN VALUE
- REQUIREMENTS
- RATIONALE FOR API
- 7.6.2WMFetchWorkItem
- NAME
- DESCRIPTION
- ERROR RETURN VALUE
- 7.6.3WMCloseWorkList
- NAME
- DESCRIPTION
- ERROR RETURN VALUE
- 7.6.4WMGetWorkItem
- NAME
- DESCRIPTION
- ERROR RETURN VALUE
- REQUIREMENTS
- RATIONALE FOR API
- 7.6.5WMCompleteWorkItem
- NAME
- DESCRIPTION
- ERROR RETURN VALUE
- REQUIREMENTS
- RATIONALE FOR API
- 7.6.6WMReassignWorkItem
- NAME
- DESCRIPTION
- ERROR RETURN VALUE
- REQUIREMENTS
- RATIONALE FOR API
- 7.6.7WMOpenWorkItemAttributesList
- NAME
- DESCRIPTION
- ERROR RETURN VALUE
- 7.6.8WMFetchWorkItemAttribute
- NAME
- DESCRIPTION
- ERROR RETURN VALUE
- 7.6.9WMCloseWorkItemAttributesList
- NAME
- DESCRIPTION
- ERROR RETURN VALUE
- 7.6.10WMGetWorkItemAttributeValue
- NAME
- DESCRIPTION
- ERROR RETURN VALUE
- 7.6.11WMAssignWorkItemAttribute
- NAME
- DESCRIPTION
- ERROR RETURN VALUE
- 7.7WAPI Administration Functions
- 7.7.1WMChangeProcessInstancesState
- NAME
- DESCRIPTION
- ERROR RETURN VALUE
- REQUIREMENTS
- RATIONALE FOR API
- 7.7.2WMChangeActivityInstancesState
- NAME
- DESCRIPTION
- ERROR RETURN VALUE
- REQUIREMENTS
- RATIONALE FOR API
- 7.7.3WMTerminateProcessInstances
- NAME
- DESCRIPTION
- ERROR RETURN VALUE
- 7.7.4WMAssignProcessInstancesAttribute
- NAME
- DESCRIPTION
- ERROR RETURN VALUE
- 7.7.5WMAssignActivityInstancesAttribute
- NAME
- DESCRIPTION
- ERROR RETURN VALUE
- 7.7.6WMAbortProcessInstances
- NAME
- DESCRIPTION
- ERROR RETURN VALUE
- REQUIREMENTS
- RATIONALE FOR API
- 7.7.7WMAbortProcessInstance
- NAME
- DESCRIPTION
- ERROR RETURN VALUE
- REQUIREMENTS
- RATIONALE FOR API
- 8.Appendix A
- 8.1Additional API Areas
- 8.1.1WFM Data API calls
- 8.1.2Ad hoc activities
- 8.1.3Administration and Maintenance
- 8.1.4Names and Roles
- 8.2Additional Issues
- 8.2.1Error reporting and control
- 8.2.2Synchpoint processing
- 8.2.3Security
- 8.2.4Locking
- 8.2.5Process Integrity
- 9.Appendix B: Object Bindings
- 9.1Abstract Object Definition
- 9.1.1Mapping WAPI to the OLE and IDL Bindings
- 9.2OLE Automation Binding
- 9.2.1Expressing WAPI2 as an OLE Automation Interface
- 9.2.1.1Object Classes
- 9.2.1.2Object Hierarchy
- 9.2.1.3Collections and Queries
- 9.2.1.4Exceptions
- 9.2.2Server
- 9.2.2.1Properties
- 9.2.2.2Methods
- 9.2.2.3Connect
- 9.2.2.4WMDisconnect
- 9.2.2.5ListProcessDefinitions
- 9.2.2.6ListProcessInstances
- 9.2.2.7GetProcessInstance
- 9.2.2.8ListActivityInstances
- 9.2.2.9GetActivityInstance
- 9.2.2.10ListWorkItems
- 9.2.2.11GetWorkItem
- 9.2.3Filter
- 9.2.3.1Properties
- 9.2.3.2Methods
- 9.2.4Process Definition
- 9.2.4.1Properites
- 9.2.4.2Methods
- 9.2.4.3CreateInstance
- 9.2.4.4ChangeInstancesState
- 9.2.4.5ChangeActivityInstancesState
- 9.2.4.6TerminateInstances
- 9.2.4.7AssignInstancesAttribute
- 9.2.4.8AssignActivityInstancesAttribute
- 9.2.4.9AbortInstances
- 9.2.5Process Instance
- 9.2.5.1Properties
- 9.2.5.2Methods
- 9.2.5.3Start
- 9.2.5.4Terminate
- 9.2.5.5ChangeState
- 9.2.5.6AssignAttribute
- 9.2.5.7Abort
- 9.2.6Activity Instance
- 9.2.6.1Properties
- 9.2.6.2Methods
- 9.2.6.3ChangeState
- 9.2.6.4AssignAttribute
- 9.2.7WorkItem
- 9.2.7.1Properties
- 9.2.7.2Methods
- 9.2.7.3AssignAttribute
- 9.2.7.4Complete
- 9.2.7.5Reassign
- 9.2.8Attribute
- 9.2.8.1Properties
- 9.3OMG IDL Binding
- 9.3.1The Workflow Facility Base Module
- 9.3.1.1Data Types and General Exceptions
- 9.3.1.2Filter Interface
- 9.3.1.3Attribute Interfaces
- 9.3.1.4Workflow Object Interface
- 9.3.2The Workflow Application Client Module
- 9.3.2.1Data Types and Specific Exceptions
- 9.3.2.2Workflow Application Client Server Interface
- 9.3.2.3Process Definition Interface
- 9.3.2.4Process Instance Interface
- 9.3.2.5Activity Instance Interface
- 9.3.2.6Work Item Interface
- 9.3.2.7Filtered List Processing