WMChangeProcessInstanceState

This command is defined to allow a process instance to be changed temporarily to a specific state such as suspended. This command depends on the user's rights on that process. Execution of this command will cause the single process instance that is named to be transition to a new state. In this case, the meaning of all states is dependent upon the particular WFM Engine implementation. This command will set the state attribute of the process instance to a state such as suspended or running.

You can view the XML input and output parameters which have to be passed for changing the process instance and displaying it. There is a list of errors and warning that can occur in the process.

Input Parameter description	View Sample InputXML
Output Parameter description	View Sample OutputXML
Errors and Warnings	View Sample Code

Input Parameter description

* implies for the mandatory parameter.

Name	Parent Tag	Description	Valid Value
Option *	Root	It refers to the case sensitive call name.	case sensitive call name.
EngineName *	Root	It is the cabinet or database name, which has to be connected.	NA
SessionID *	Root	It is the logged in user session id.	NA
ProcessInstanceID *	Root	It is the Id of the process instance whose state has to be changed.	NA
ProcessInstanceState*	Root	It is the process instance state. It can be Completed, Running, Suspended, Aborted, Not Started, Terminated	Completed, Running, Suspended, Aborted, Not Started, Terminated

Output Parameter description

Name	Parent Tag	Description
Option	Root	It refers to the case sensitive call name.
MainCode	Exception	Error code specified by WAPI.

Errors and Warnings

Code	Constant Value	Message
11	WM_INVALID_SESSION_HANDLE	Invalid session.
4	WM_INVALID_PROCESS_INSTANCE	The process instance ID was not valid.
9	WM_INVALID_STATE	Invalid state.
10	WM_TRANSITION_NOT_ALLOWED	The requested state transition is not allowed