List of Calls

Connection Calls

WMConnect	Informs the WFM Engine that other commands will be originating from this source. It allows the connection of external application with the WFM Engine for this series of interactions.
WMDisconnect	Allows ending the logged in user session on the WFM Engine.

Sets the session id for the logged in user.

Process Control Function

WMFetchProcessDefinition	Returns the next process definition from the set of process definitions that met the selection criterion stated in the WMOpenProcessDefinitionsList call.
WMFetchProcessInstance	Fetches process instances that meet the selection criterion.
WMGetProcessInstance	Returns a specific process instance record.
WMCreateProcessInstance	Creates an operational instance of the named process definition.
WMStartProcess	Directs the WFM Engine to begin executing a process, for which an instance has been created.
WMTerminateProcessInstance	Terminates a process without aborting the process instance.
WMFetchProcessInstanceAttributes	Returns the next process instance attribute from the list of attributes that match the filter criterion.
WMAssignProcessInstanceAttribute	Assigns attributes, change an attribute or to change the value of an attribute of a process instance.

Process Status Calls

WMFetchProcessDefinitionStates	Returns the next process Definition State, from the list of states of the process definition that match the filter criterion.
WMChangeProcessDefinitionState	Changes the process definition state temporarily to a specific state such as disabled or enabled
WMFetchProcessInstanceState	Returns all the states defined for the process instance depending upon the criterion specified.
WMChangeProcessInstanceState	Changes process instance state temporarily to a specific state such as suspended.

Activity Control Calls

WMFetchActivityInstanceState	Returns an activity state.
WMChangeActivityInstanceState	Changes the state of a single activity instance within a process instance.
WMFetchActivityInstanceAttribute	Returns subsequent activity instance attributes after every call.
WMGetActivityInstanceAttributeValue	Returns the value, type and length of an activity instance attribute specified.
WMAssignActivityInstanceAttribute	Changes the value of the attributes of a activity instance

Activity Status Calls

WMGetActivityInstance	Returns the record of a specific activity instance.
WMFetchActivityInstance	Returns the next activity instance from the list of activity instances that met the selection criterion

Workitem Calls

WMGetWorkItem	Returns the record of a specific work item
WMCompleteWorkItem	Specifies the WFM Engine that this work item has been completed.
WMFetchWorkitemState	Fetches all the states specified for the workitem
WMChangeWorkitemState	Changes the state of the named workitem.
WMReassignWorkItem	Allows a work item from one workflow participant�s worklist to be reassigned to another workflow participant�s worklist
WMFetchWorkItemAttribute	Returns the next work item attribute from the list of work item attributes that match the filter criterion
WMGetWorkItemAttributeValue	Fetches the values associated with the workitem attribute.
WMAssignWorkItemAttribute	Assigns the proper attribute to a work item.

Worklist Calls

WFSearchWorkItemList	Searches for the workitem depending upon the criterion specified.
WMFetchWorkItems	Returns the next work item from the worklist that met the selection criterion.

WAPI Administration Calls:

WMChangeProcessInstancesState	Changes the process instance state.
WMChangeActivityInstancesState	Changes the activity instance state.
WMTerminateProcessInstances	Terminates the process instances.
WMAssignProcessInstancesAttribute	Assigns the attributes to the process
WMAssignActivityInstancesAttribute	Assigns the attributes to the activity.
WMAbortProcessInstances	Aborts the process instance.

User Management calls:

WMGetUserList	Fetches the user list for the cabinet..
WFGetUserProperty	Returns the properties of the specific user.
WMSetUserWorkAudit	Sets the auditor for the specific user and the percentage of the work to be audited.
WMGetUserWorkAudit	Returns the auditor name for the specific user and the percentage of the work audited.
WFSetDiversionforUser	Sets the diversion for the user for a particular time period to the target user.
WFGetDiversionforUser	Returns the details of the target user to which the workitems are diverted..
WFGetUserQueueDetails	Returns the queue details for the particular user.

Queue Management calls:

WMAddQueue	Adds the queue
WFDeleteQueue	Deletes the queue
WMGetQueueList	Fetches the list of queue
WFGetQueueProperty	Fetches the specific queue properties.
WMChangeQueueProperty	Changes the queue properties.
WFSetPreferedQueueList	Sets the queue preferences for the user
WFGetPreferredQueueList	Returns the queue preferences for the user.

Process Related calls:

WFGetProcessLog	Returns the log of Processes defined
WFGetUserPerformanceLog	Returns the Users Performance Log
WFGetProcessTurnAroundLog	Returns the turn around time of the process and the turnaround time of the individual activities.
WFGetActivityDelayLog	Returns the average delay for the individual activities of a process.
WFGetQueueLoadHistory	Returns the queue load history.
WFGetProcessLoadHistory	Returns the process load history.
WFGetProcessDelayLog	Returns the average delay for the process.
WFGetWorkItemExceptionLog	Returns the exception histories for the process Instance.
WFGetWorkItemHistory	Returns the history of actions performed on all workItems.
WFGetExpiredWorkItemLog	Returns the expired workitems Log for the process Instance
WFGetWorkAuditHistory	Returns the work audit history.
WFGetUserDiversionReport	Returns the Diversion Report of Users depending on input criterion.
WFGetTempQueueAssignmentReport	Returns the list of users which are temporarily assigned for the queue and till what date.
WFProcessingtimeReport	Returns the average processing for the process or activity-wise in a process.
WFParticipantReport	Returns the average file spent by the user(s) for a particular process.

Stream Related Calls

WMGetStreamList

Returns the list of streams.

Group Related Function

Returns the list of groups.

Miscellaneous Calls

WFGetVariableMapping	Returns the Variable Mapping.
WFSetVariableMapping	Sets external variable mapping.
WFGetExternalInterfaceList	Returns the list of external interface.
WFGetIdforName	Return queue id for queue name and activity id if activity name is passed...
WFGetStateList	Returns the list of states available for workitem.
WFReassignWorkItemAssignment	Reassigns work item to another user.
WFSetWorkItemAttribute	Sets workitem attributes.
WFSetAttributes	Assigns multiple attributes.
WFGetLinkedWorkitems	Gets linked workitems.
WFLinkWorkitem	Links workitem with the another.
WFGetNextUnlockedWorkItem	Fetches next unlocked workitem and lock it.
WFGetExternalData	Returns the external data associated with the workitem.
WFSetPreferences	Sets the preferences for the user.
WFGetPreferences	Returns the preferences set for the login user.
WFGenerateLog	Generates the log for workitems..
WFFetchInstrumentsList	Returns the list of Instruments..

Related Topics

Trouble Shooting & Debugging

List of Error Messages

Action Ids and Corresponding Actions