5.5
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
- Index
Debugging Workflows
Orchestrator provides a workflow debugging tool. You can debug a workflow to inspect the input and
output parameters and attributes at the start of any activity, replace parameter or attribute values during a
workflow run in edit mode, and resume a workflow from the last failed activity.
You can debug workflows from the standard workflow library and custom workflows. You can debug
custom workflows while developing them in the workflow editor.
Debug a Workflow
You can debug elements of a workflow by adding breakpoints to the elements in the workflow schema.
When a breakpoint is reached, you have several options to continue the debugging process. When you
debug an element from the workflow schema, you can view general information about the workflow run,
modify the workflow variables, and view log messages.
Prerequisites
Log in to the Orchestrator client as a user who can run workflows.
Procedure
1 From the drop-down menu in the Orchestrator client, select Design.
2 Click the Workflows view.
3 Select a workflow from the workflow library and click the Schema tab.
4 To add breakpoints to the schema elements that you want to debug, right-click a workflow element and
select Toggle breakpoint.
You can enable or disable the toggled breakpoints.
5
Click the Debug workflow icon ( ).
If the workflow requires input parameters, you must provide them.
6 When the workflow run is paused after it reaches a breakpoint, select one of the available options.
Option Description
Resume
Resumes the workflow run until another breakpoint is reached.
Step into
Lets you step into a workflow element.
NOTE You cannot step into a nested workflow element when you debug a
workflow in the workflow editor.
Step over
Steps over the current element in the schema and pauses the workflow run
on the next element.
Step return
Exits the workflow element that you have stepped into.
7 (Optional) From the Breakpoints tab, modify the breakpoints.
You can enable, disable, or remove existing breakpoints.
8 (Optional) From the Variables tab, review the variables.
You can modify the values of some of the variables during the debugging process.
Developing with VMware vCenter Orchestrator
72 VMware, Inc.