5.5.1
Table Of Contents
- Developing with VMware vCenter Orchestrator
- Contents
- Developing with VMware vCenter Orchestrator
- Developing Workflows
- Key Concepts of Workflows
- Phases in the Workflow Development Process
- Access Rights for the Orchestrator Client
- Testing Workflows During Development
- Creating and Editing a Workflow
- Provide General Workflow Information
- Defining Attributes and Parameters
- Workflow Schema
- Obtaining Input Parameters from Users When a Workflow Starts
- Requesting User Interactions While a Workflow Runs
- Add a User Interaction to a Workflow
- Set the User Interaction security.group Attribute
- Set the timeout.date Attribute to an Absolute Date
- Calculate a Relative Timeout for User Interactions
- Set the timeout.date Attribute to a Relative Date
- Define the External Inputs for a User Interaction
- Define User Interaction Exception Behavior
- Create the Input Parameters Dialog Box for the User Interaction
- Respond to a Request for a User Interaction
- Calling Workflows Within Workflows
- Running a Workflow on a Selection of Objects
- Developing Long-Running Workflows
- Configuration Elements
- Workflow User Permissions
- Validating Workflows
- Debugging Workflows
- Running Workflows
- Resuming a Failed Workflow Run
- Generate Workflow Documentation
- Use Workflow Version History
- Restore Deleted Workflows
- Develop a Simple Example Workflow
- Create the Simple Workflow Example
- Create the Schema of the Simple Workflow Example
- Create the Simple Workflow Example Zones
- Define the Parameters of the Simple Workflow Example
- Define the Simple Workflow Example Decision Bindings
- Bind the Action Elements of the Simple Workflow Example
- Bind the Simple Workflow Example Scripted Task Elements
- Define the Simple Workflow Example Exception Bindings
- Set the Read-Write Properties for Attributes of the Simple Workflow Example
- Set the Simple Workflow Example Parameter Properties
- Set the Layout of the Simple Workflow Example Input Parameters Dialog Box
- Validate and Run the Simple Workflow Example
- Develop a Complex Workflow
- Create the Complex Workflow Example
- Create a Custom Action for the Complex Workflow Example
- Create the Schema of the Complex Workflow Example
- Create the Complex Workflow Example Zones
- Define the Parameters of the Complex Workflow Example
- Define the Bindings for the Complex Workflow Example
- Set the Complex Workflow Example Attribute Properties
- Create the Layout of the Complex Workflow Example Input Parameters
- Validate and Run the Complex Workflow Example
- Scripting
- Orchestrator Elements that Require Scripting
- Limitations of the Mozilla Rhino Implementation in Orchestrator
- Using the Orchestrator Scripting API
- Access the Scripting Engine from the Workflow Editor
- Access the Scripting Engine from the Action or Policy Editor
- Access the Orchestrator API Explorer
- Use the Orchestrator API Explorer to Find Objects
- Writing Scripts
- Add Parameters to Scripts
- Accessing the Orchestrator Server File System from JavaScript and Workflows
- Accessing Java Classes from JavaScript
- Accessing Operating System Commands from JavaScript
- Exception Handling Guidelines
- Orchestrator JavaScript Examples
- Developing Actions
- Creating Resource Elements
- Creating Packages
- Creating Plug-Ins by Using Maven
- Index
Table 1‑24. Bindings of the Log Exception Task Element
Parameter Name Binding Type
Bind to Existing
or Create
Parameter? Binding Values
vm
IN Bind
n
Local parameter: vm
n
Source parameter:
vm[attribute]
n
Type: VC:VirtualMachine
n
Description:
The current virtual machine
having a snapshot taken
errorCode
IN Bind
n
Local parameter: errorCode
n
Source parameter:
errorCode[attribute]
n
Type: string
n
Description:
An exception caught while
taking a snapshot of a
virtual machine
The Log Exception scriptable task element performs the following scripted function.
//Writes the following event in the vCO database
Server.error("Coudln't snapshot the VM '"+vm.name+"', exception: "+errorCode);
Set Output Scriptable Task Element
The Set Output scriptable generates the workflow's output parameter, that contains the array of virtual
machines of which snapshots have been taken. The following table shows the bindings that the Set Output
scriptable task element requires.
Table 1‑25. Bindings of the Set Output Task Element
Parameter Name Binding Type
Bind to Existing
or Create
Parameter? Binding Values
snapshotVmArray
IN Bind
n
Local parameter:
snapshotVmArray
n
Source parameter:
snapshotVmArray[attribute]
n
Type:
Array/VC:VirtualMachine
n
Description:
The Array of virtual
machines of which snapshots
have been taken
snapshotVmArrayOut
OUT Bind
n
Local parameter:
snapshotVmArrayOut
n
Source parameter:
snapshotVmArrayOut[out-
parameter]
n
Type:
Array/VC:VirtualMachine
n
Description:
The Array of virtual
machines of which snapshots
have been
Developing with VMware vCenter Orchestrator
118 VMware, Inc.