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
5 Writing Scripts on page 127
The Orchestrator scripting engine helps you to write scripts. Automatic insertion of functions and
automatic completion of lines of scripting accelerates the scripting process and minimizes the potential
for writing errors in scripts.
6 Add Parameters to Scripts on page 129
The Orchestrator scripting engine helps you to import available parameters into scripts.
7 Accessing the Orchestrator Server File System from JavaScript and Workflows on page 129
Orchestrator limits access to the Orchestrator server file system from JavaScript and Workflows to
specific directories.
8 Accessing Java Classes from JavaScript on page 130
By default, Orchestrator restricts JavaScript access to a limited set of Java classes. If you require
JavaScript access to a wider range of Java classes, you must set an Orchestrator system property to
allow this access.
9 Accessing Operating System Commands from JavaScript on page 130
The Orchestrator API provides a scripting class, Command, that runs commands in the Orchestrator
server host operating system. To prevent unauthorized access to the Orchestrator server host, by
default, Orchestrator applications do not have permission to run the Command class.
Access the Scripting Engine from the Workflow Editor
The Orchestrator scripting engine uses the Mozilla Rhino 1.7R4 JavaScript engine to help you write scripts
for scripted elements in workflows. You access the scripting engine for scripted workflow elements from the
Scripting tab in the workflow editor.
Procedure
1 Right-click a workflow in the Workflows view of the Orchestrator client and select Edit.
2 Click the Schema tab in the workflows editor.
3 Add a Scriptable Task element or a Custom Decision element to the workflow schema.
4 Click on the scriptable element's Scripting tab.
You accessed the scripting engine to define the scripted functions of workflow elements. The Scripting tab
allows you to navigate through the API, consult documentation about the objects, search for objects, and
write JavaScript.
What to do next
Search the Orchestrator API using the API Explorer.
Chapter 2 Scripting
VMware, Inc. 125