4.0

Type Value Description
String
eventName
The eventName property is the name of the event that a workflow is waiting for before
running. The eventName string you pass to sendCustomEvent must match the name
of an Event object declared in the script, action or workflow that defines the custom
event.
String
serializedProperties
The serializedProperties property defines the parameters to pass to the waiting
workflow as a series of name-value pairs. The syntax of serializedProperties is as
follows:
"
name1 = value1 \n name2 = value2 \n name3 = value3 "
If the workflow requires no input parameters, the serializedProperties property
can be null or omitted.
Return Value
No return value informs applications that the sendCustomEvent operation ran successfully.
The sendCustomEvent operation returns an exception if you pass it an invalid parameter.
Receiving Messages from sendCustomEvent
Workflows waiting for a message from sendCustomEvent before they run must declare the event they are
waiting for by calling the System.waitCustomEventUntil operation from the Orchestrator API. The following
example shows two calls to waitCustomEventUntil.
System.waitCustomEventUntil("internal", customEventKey, myDate );
System.waitCustomEventUntil("external", customEventKey, myDate );
The waitCustomEventUntil operation's parameters are as follows.
internal / external
The awaited event comes from another workflow (internal) or from a Web
service application (external).
customEventKey
The name of the awaited event.
myDate
The date until which waitCustomEventUntil waits for a message from
sendCustomEvent.
simpleExecuteWorkflow Operation
The simpleExecuteWorkflow operation uses string attributes to start a workflow.
IMPORTANT This operation is deprecated since Orchestrator 4.0. Do not use simpleExecuteWorkflow.
Type Value Description
String
workflowId
ID of the Workflow to be run.
String
username
Orchestrator user name.
String
password
Orchestrator password.
String
attributes
The format for the attributes parameter is a list of attributes separated by commas. Because
commas are used as separators, attribute name strings containing commas are not processed
correctly.
Each attribute is represented by its name, type, and value, as shown in the following examples.
Name1 , Type1 , Value1 , Name2 , Type2 , Value2
Return Value
Runs a workflow. Returns a WorkflowToken object.
vCenter Orchestrator Developer's Guide
280 VMware, Inc.