executeWFTransitions

Purpose

This operation executes the workflow transition on a request in PPM Center.

Function

This operation executes the workflow transition on a request.

Limitations

This operation has the following limitations:

• Supports only the decision step. It does not support the execution step.

• Does not support branching; it will fail if there is a branch on the same transition.

• No security check on workflow transition. Even though the user may not be allowed to perform the transition from PPM standard interfaces, or the workflow step may require reauthentication, the transition will be performed by this Web service call, as long as the status value matches the transition name.

Related Information

The following data type:

• Request

Input

The following inputs are required for this operation:

• Receiver ID, which is the identifier for the request in PPM Center.

• Transition name, which should exactly match the value on the action buttons (case sensitive).

Return

When the transition is valid and executed, the operation returns the following string:

Workflow transition was successful.

When the transition is invalid, the operation returns the following string:

There were no matches for the transition name provided.

Java Interface

ExecuteWFTransitionsResponseDocument
executeWFTransitions(ExecuteWFTransitionsDocument in)

Parameters	Description
ExecuteWFTransitionsDocument	Wrapper of the request ID and the transition name.
ExecuteWFTransitionsResponseDocument	Wrapper of the return code of this operation.

Java Examples

Example: execute a workflow transition on an existing request.

public class ExampleSetExecuteWFTransitions {
. . .
    private void executeWFTransitions(String serviceURL, String
requestId,
             String transition) throws Exception {

        // construct the Identifiers
        Identifier receiverId =
Identifier.Factory.newInstance();
        receiverId.setId(requestId);

        // get Webservice handle
        DemandServiceStub stub = new DemandServiceStub(ctx,
serviceURL);

        // Construct message to send
        ExecuteWFTransitionsDocument inDoc =
ExecuteWFTransitionsDocument.Factory
                .newInstance();
        ExecuteWFTransitionsDocument.ExecuteWFTransitions exec =
inDoc
                .addNewExecuteWFTransitions();
         exec.setReceiver(receiverId);
         exec.setTransition(transition);
. . .
}
}

Errors and Exceptions

Message Code	Message	Cause(s)	Possible Corrective Action
N/A	Update remote reference status Succeeded. Return code: There were no matches for the transition name provided.	The transition has been provided but there are no matches for the transition name.	Provide a matching transition for the request.
KNTA-11186	Internal error has occurred while calling PPM Web Service. Contact PPM support with the detail information if the problem persists. (KNTA-11186) Details: Missing required element {http://mercury.com/ppm/dm/service/1.0}transition	You have not provided the transition.	Provide the transition for the request
KNTA-11186	Internal error has occurred while calling PPM Web Service. Contact PPM support with the detail information if the problem persists. (KNTA-11186) Details: Missing required element {http://mercur y.com/ppm/dm/service/1.0}receiver	You have not set the request ID.	Provide the request ID for the request.
KNTA-11186	Internal error has occurred while calling PPM Web Service. Contact PPM support with the detail information if the problem persists. (KNTA-11186) Details: null; nested exception is:java.lang.NullPointerException	The request ID value is invalid.	The request ID value has to be a numeric value. Correct the value and try again.