WMChangeActivityInstancesState

This call changes the state of the activity instances of a particular name associated to a process definition that match the specified filter criterion.

This command directs a WFM Engine to change the state of the named activity for a set of activity instances. It is assumed that a person who can change the state of the set of activity instances corresponding to a process definition has special authorization to do so. If the implementation supports a state such as suspended, and resumed or in-progress, then the calls for suspend and resume are implemented as state change calls. If the filter pointer pact_inst_filter is NULL, then the command is applied to all activity instances of the given activity definition.

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

 

Input Parameter description

 View Sample InputXML

Output Parameter description

 View Sample OutputXML

Errors and Warnings

 

 

Input Parameter description

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

 

ProcessDefinitionId

Root

It refers to the id of the process definition.

NA

 

ActivityDefinitionId

Activity

It refers to the activity definition id, whose instance state has to be changed.

NA

 

ActivityInstanceState

Activity

It refers to the activity instance state which has to be changed

NA

 

Type

Filter

Type of the filter criteria specified. Filter type can be SQL string or an attribute. If you are filtering on attributes, then filter string contains the value of the attribute. 0-255 are reserved , if it is 256 than its SQL type filter. Then you Filter string will contains an SQL query.

NA

 

AttributeName

Filter

It is the attribute name for filtering

NA

 

Comparison

Filter

It is operator for the filter

1 for > ; 2 for >= ;3 for =; 4 <> ; 5 for <; 6 for <=; 7 for like, 8 for not like.

FilterString

Filter

It is string specified for the filtering

NA

 

Length

Filter

It is the length of the filter.

NA

 

 

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

502

WM_INVALID_PROCESS_DEFINITION

The process definition ID was not valid.

3

WM_INVALID_ACTIVITY_DEFINITION

The activity was not valid.

15

WM_INVALID_FILTER

The requested filter is invalid.

9

WM_INVALID_STATE

Invalid state.

10

WM_TRANSITION_NOT_ALLOWED

The requested state transition is not allowed.