4.0

WorkflowParameter Object
The WorkflowParameter object defines a parameter in a workflow, for example, an input, an output, or an
attribute.
Workflow developers can set up arbitrary parameters to provide any input parameters or output parameters
that the workflows need. The format of the parameters is defined entirely by the workflow.
The following table shows the properties of the WorkflowParameter object.
Type Value Description
String
name
The parameter name.
String
type
The parameter type.
WorkflowToken Object
A WorkflowToken object represents a specific instance of a workflow in the running, waiting, waiting-signal,
canceled, completed or failed state.
You obtain a WorkflowToken object by starting a workflow or by obtaining an existing workflow token by its
ID, as the following method signatures show.
public WorkflowToken executeWorkflow(String workflowId, String username, String password,
WorkflowTokenAttribute[] attributes);
public WorkflowToken getWorkflowTokenForId(String workflowTokenId, String username, String
password);
The following table shows the properties of the WorkflowToken object.
Type Value Description
String
id
The identifier of this particular instance of a completed workflow.
String
title
The title of this particular instance of a completed workflow.
By default, the WorkflowToken title is the same as the Workflow title, although some
operations do allow you to set a different WorkflowToken title when you start the workflow.
String
workflowId
The identifier of the workflow of which this WorkflowToken object is a running instance.
String
currentItemName
The name of the step in the workflow that is running at the moment when
getWorkflowTokenForId is called.
String
currentItemState
The state of the current step in the workflow, with the following possible values:
n
running: the step is running
n
waiting: the step is waiting for runtime parameters, which can be provided by
answerWorkflowInput
n
waiting-signal: the step is waiting for an external event from a plug-in
n
canceled: the step was canceled by a user or API-integrated program
n
completed: the step has finished
n
failed: the step encountered an error
You must run getWorkflowTokenForId every time you update this value.
NOTE VMware recommends that you do not use currentItemState. The globalState
property makes currentItemState redundant.
Chapter 8 Developing a Web Services Client
VMware, Inc. 265