4.1

Manuals Brands VMware Manuals Applications vCenter Orchestrator

Table Of Contents

vCenter Orchestrator Developer's Guide

vCenter Orchestrator Developer's Guide

vCenter Orchestrator 4.1

This document supports the version of each product listed and

supports all subsequent versions until the document is replaced

by a new edition. To check for more recent editions of this

document, see http://www.vmware.com/support/pubs.

EN-000320-04

Summary of content (336 pages)

PAGE 1

vCenter Orchestrator Developer's Guide vCenter Orchestrator 4.1 This document supports the version of each product listed and supports all subsequent versions until the document is replaced by a new edition. To check for more recent editions of this document, see http://www.vmware.com/support/pubs.
PAGE 2

vCenter Orchestrator Developer's Guide You can find the most up-to-date technical documentation on the VMware Web site at: http://www.vmware.com/support/ The VMware Web site also provides the latest product updates. If you have comments about this documentation, submit your feedback to: docfeedback@vmware.com Copyright © 2009, 2010 VMware, Inc. All rights reserved. This product is protected by U.S. and international copyright and intellectual property laws.
PAGE 3

Contents Updated Information 5 About This Book 7 1 Introduction to VMware vCenter Orchestrator 9 Key Features of the Orchestrator Platform 9 Orchestrator User Roles and Related Tasks 10 Orchestrator Architecture 11 Deprecated Features in Orchestrator 4.
PAGE 4

vCenter Orchestrator Developer's Guide Orchestrator JavaScript Examples 120 5 Creating Resource Elements 129 View a Resource Element 129 Import an External Object to Use as a Resource Element 130 Edit the Resource Element Information and Access Rights 130 Save a Resource Element to a File 131 Update a Resource Element 131 Add a Resource Element to a Workflow 131 Add a Resource Element to a Web View 132 6 Creating Packages 135 Create a Package 135 Set User Permissions on a Package 136 7 Developing Plug
PAGE 5

Updated Information This VMware vCenter Orchestrator Developer's Guide is updated with each release of the product or when necessary. This table provides the update history of the VMware vCenter Orchestrator Developer's Guide. Revision Description EN-000320-04 Added topic “Propagate the Input Parameters and Presentation of a Child Workflow to the Parent Workflow,” on page 52, which explains how to propagate the input parameters and presentation of a child workflow to its parent workflow.
PAGE 6

vCenter Orchestrator Developer's Guide 6 VMware, Inc.
PAGE 7

About This Book The VMware vCenter Orchestrator Developer's Guide provides information and instructions about how to use the VMware vCenter Orchestrator platform to develop process-automation applications for virtual environments. Intended Audience This document is intended for developers who want to develop applications using the Orchestrator platform. Specifically, this document is intended for the following types of developer.
PAGE 8

vCenter Orchestrator Developer's Guide Technical Support and Education Resources The following technical support resources are available to you. To access the current version of this book and other books, go to http://www.vmware.com/support/pubs. Online and Telephone Support To use online support to submit technical support requests, view your product and contract information, and register your products, go to http://www.vmware.com/support.
PAGE 9

Introduction to VMware vCenter Orchestrator 1 VMware vCenter Orchestrator is a development and process-automation platform that provides a library of extensible workflows to allow you to create and run automated, configurable processes to manage the VMware vCenter infrastructure. Orchestrator exposes every operation in the vCenter Server API, allowing you to integrate all of these operations into your automated processes.
PAGE 10

vCenter Orchestrator Developer's Guide Scripting engine Workflow engine The Mozilla Rhino JavaScript engine provides a way to create new building blocks for Orchestrator Platform. The scripting engine is enhanced with basic version control, variable type checking, name space management and exception handling. It can be used in the following building blocks: n Actions n Workflows n Policies The workflow engine allows you to capture business processes.
PAGE 11

Chapter 1 Introduction to VMware vCenter Orchestrator Managing version control of imported elements n Users in this role are granted access to only the Web front end. They can run and schedule workflows and policies. End Users Orchestrator Architecture Orchestrator contains a workflow library and workflow engine to allow you to create and run workflows that automate orchestration processes.
PAGE 12

vCenter Orchestrator Developer's Guide 12 VMware, Inc.
PAGE 13

Developing Workflows 2 You develop workflows in the Orchestrator client interface. Workflow development involves using the workflow editor, the built-in Mozilla Rhino JavaScript scripting engine, and the Orchestrator and vCenter Server APIs. n Principal Phases in the Workflow Development Process on page 14 The process for developing a workflow involves a series of phases. n Accessing the Orchestrator Client on page 15 By default, all Orchestrator users can access the Orchestrator client.
PAGE 14

vCenter Orchestrator Developer's Guide n Calling Workflows Within Workflows on page 50 Workflows can call on other workflows during their run. A workflow can start another workflow either because it requires the result of the other workflow as an input parameter for its own run, or it can start a workflow and let it continue its own run independently. Workflows can also start a workflow at a given time in the future, or start multiple workflows simultaneously.
PAGE 15

Chapter 2 Developing Workflows Accessing the Orchestrator Client By default, all Orchestrator users can access the Orchestrator client. However, for security reasons, the Orchestrator administrator can limit access to the Orchestrator client to members of the Orchestrator administrator LDAP group. If the Orchestrator administrator has limited the access to the client and if you are not a member of the Orchestrator administrator group, you cannot log in to the Orchestrator client.
PAGE 16

vCenter Orchestrator Developer's Guide Create a Workflow You can create workflows in the workflows hierarchical list in the Orchestrator client interface. Procedure 1 In the Orchestrator client, click the Workflows view. 2 (Optional) Right-click the root of the workflows hierarchical list, or a folder in the list, and select Add folder to create a new workflow folder. 3 (Optional) Name the new folder. 4 Right-click the new folder or an existing folder and select New workflow.
PAGE 17

Chapter 2 Developing Workflows 7 Click the Workflow folder value to search for a folder in which to save the duplicate workflow. Select the folder you created in Step 2. If you did not create a folder, select a folder that is not in the library of standard workflows. 8 Click Yes or No to copy the workflow version history to the duplicate. Option Description Yes The version history of the original workflow is replicated in the duplicate. No The version of the duplicate reverts to 0.0.0.
PAGE 18

vCenter Orchestrator Developer's Guide Table 2-1. Workflow Editor Tabs (Continued) Tab Description Events Provides information about each individual event that occurs when the workflow runs. This information includes a description of the event, the user who triggered it, the type and origin of the event, and the time and date when it occurred. Permissions Sets the permissions to interact with the workflow for users or groups of users.
PAGE 19

Chapter 2 Developing Workflows Defining Attributes and Parameters After you create a workflow, you must determine the workflow's global attributes and input and output parameters. Workflow attributes are data that workflows process internally. Workflow input parameters are data that comes from an outside source, such as a user or another workflow. Workflow output parameters are data that the workflow delivers when it ends.
PAGE 20

vCenter Orchestrator Developer's Guide 8 (Optional) If you decide that the attribute should be an input or output parameter rather than an attribute, right-click the attribute and select Move as INPUT/OUTPUT parameter to change the attribute into a parameter. You defined an attribute for the workflow. What to do next You can define the workflow's input and output parameters. Define Workflow Parameters Input and output parameters allow you to pass information and data into and out of the workflow.
PAGE 21

Chapter 2 Developing Workflows Table 2-2.
PAGE 22

vCenter Orchestrator Developer's Guide View Workflow Schema You view a workflow schema in the Schema tab for that workflow in the Orchestrator client. Procedure 1 Navigate to a workflow in the workflow hierarchical list. 2 Click the workflow. Information about that workflow appears in the right pane. 3 Select the Schema tab in the right pane. You see the graphical representation of the workflow. Building a Workflow in the Workflow Schema Workflow schemas consist of a sequence of schema elements.
PAGE 23

Chapter 2 Developing Workflows 7 Drag schema elements from the Basic, Log, or Network menus to the workflow schema. You can edit the names of the elements in the Basic, Log, or Network menus. You cannot edit their scripting. 8 Drag schema elements from the Action & Workflow menu to the workflow schema. When you drag actions or workflows to the workflow schema, a dialog box appears that allows you to search for the action or workflow to insert.
PAGE 24

vCenter Orchestrator Developer's Guide Table 2-3. Schema Elements and Icons (Continued) Schema Element Name 24 Description Icon Icon Location in Workflow editor Decision Boolean function. Decision elements take one input parameter and return either true or false. The type of decision the element makes depends on the type of the input parameter. Decision elements allow the workflow to branch into different directions, depending on the input parameter the decision element receives.
PAGE 25

Chapter 2 Developing Workflows Table 2-3. Schema Elements and Icons (Continued) Schema Element Name Description Icon Icon Location in Workflow editor Thrown Exception Creates an exception and stops the workflow. Multiple occurrences of this element can be present in the workflow schema. Exception elements have one input parameter, which can only be of the String type, and have no output parameter. When a workflow reaches an Exception element, the workflow token enters the failed state.
PAGE 26

vCenter Orchestrator Developer's Guide Table 2-3. Schema Elements and Icons (Continued) Schema Element Name Description Icon Icon Location in Workflow editor Asynchronous Workflows Starts a workflow asynchronously. When a workflow reaches an asynchronous workflow element, it starts that workflow and continues its own run. The original workflow does not wait for the called workflow to finish before continuing.
PAGE 27

Chapter 2 Developing Workflows Schema Element Properties Tabs You access a schema element's properties by clicking on a schema element that you have dragged into the workflow schema. The element properties appear in tabs at the bottom of the workflow editor. Different element types present different properties tabs, as shown in Table 2-4. Table 2-4.
PAGE 28

vCenter Orchestrator Developer's Guide Table 2-4. Properties Tabs per Schema Element (Continued) Schema Element Property Tab Description Applies to Schema Element Type Info The schema element's general properties and description. The information the Info tab displays depends on the type of schema element.
PAGE 29

Chapter 2 Developing Workflows Logical Flow of a Workflow The logical flow of a workflow is the progression of the workflow from one element to the next in the schema as the workflow runs. You define the logical flow of the workflow by linking elements in the schema. The standard path is the path that the workflow takes through the logical flow if all elements run normally. The exception path is the path that the workflow takes through the logical flow if an element does not run normally.
PAGE 30

vCenter Orchestrator Developer's Guide n b The SnapVMsInResourcePool workflow encounters an error. c The workflow returns an exception and stops in the failed state. false decision result, exception. a The decision element returns false. b The operation the Scriptable task element defines encounters an error. c The workflow returns an exception and stops in the failed state. Element Links Links connect schema elements and define the logical flow of the workflow from one element to the next.
PAGE 31

Chapter 2 Developing Workflows What to do next The elements are joined, but you have not defined the data flow. You must define the IN and OUT bindings to bind incoming and outgoing data to workflow attributes. Data Flow of a Workflow The data flow of a workflow is the manner in which workflow element input and output parameters bind to workflow attributes as each element of the workflow runs. You define the data flow of a workflow by using schema element bindings.
PAGE 32

vCenter Orchestrator Developer's Guide Element Bindings You must bind all workflow element input and output parameters to workflow attributes. Bindings set data in the elements, and define the output and exception behavior of the elements. Links define the logical flow of the workflow, whereas bindings define the data flow. To set data in an element, generate ouput parameters from the element after processing, and handle any errors that might occur when the element runs, you must set the element binding.
PAGE 33

Chapter 2 Developing Workflows 2 Click the IN tab. The contents of the IN tab depend on the type of element you selected. 3 n If you selected a predefined task, workflow, or action element, the IN tab lists the possible local input parameters for that type of element, but the binding is not set.
PAGE 34

vCenter Orchestrator Developer's Guide Decisions are always Boolean functions. The only possible outcomes for each decision are true or false. Custom Decisions Custom decisions differ from standard decisions in that you define the decision statement in a script. Custom decisions return true or false according to the statement you define, as the following example shows.
PAGE 35

Chapter 2 Developing Workflows What to do next The decision element is linked to two other elements, but you did not define how the workflow determines which path to take. You must define the decision statement. Create Workflow Branches Using Decisions Decision elements are simple Boolean functions that you use to create branches in workflows. Decision elements determine whether or not the input received matches the decision statement you set.
PAGE 36

vCenter Orchestrator Developer's Guide Create Exception Bindings Elements can set bindings that define how the workflow behaves if it encounters an error in that element. Prerequisites The Schema tab of the workflow editor must contain elements. Procedure 1 Click the element on which to set the exception binding. 2 Click the connector tool button in the toolbar at the top of the Schema tab or hold down Ctrl and move the pointer over the right of the element for which to set the exception binding.
PAGE 37

Chapter 2 Developing Workflows The Presentation tab also allows you to add descriptions of the input parameters to help users when they provide input parameters. You can also set properties and constraints on parameters in the Presentation tab to limit the parameters that users provide. If the parameters the user provides do not meet the constraints you set in the Presentation tab, the workflow will not run. IMPORTANT The use of OGNL expressions in workflow presentations is deprecated as of Orchestrator 4.
PAGE 38

vCenter Orchestrator Developer's Guide 2 Right-click the Presentation node and select Create new step. A New Step node appears under the Presentation node. 3 Double-click the New Step node to provide it with an appropriate name and press Enter. This name appears as a section header in the input parameters dialog box when the workflow runs. 4 Click the input step and add a description in the General tab in the bottom half of the Presentation tab.
PAGE 39

Chapter 2 Developing Workflows Dynamic property values depend on the value of another parameter or attribute. You define the functions by which dynamic properties obtain values by using an object graph navigation language (OGNL) expression. If a dynamic parameter property value depends on the value of another parameter property value and the other parameter property value changes, the OGNL expression recalculates and changes the dynamic property value.
PAGE 40

vCenter Orchestrator Developer's Guide 9 Click Save at the bottom of the workflow editor. You defined the properties of the workflow's input parameters. What to do next Validate and debug the workflow. Workflow Input Parameter Properties You can set parameter properties to constrain the input parameters that users provide when they run workflows. The possible properties for each type of parameter are listed in Table 2-5. Table 2-5.
PAGE 41

Chapter 2 Developing Workflows Table 2-5. Workflow Input Parameter Properties (Continued) Parameter Property Parameter Type Description Select as Any parameter type obtained from a plug-in Use a list or hierarchical list selector to select the parameter. Default value Any Default value for this parameter. Custom validation OGNL scriptable validation If the OGNL expression returns a string, the validation shows this string as the text of the error result.
PAGE 42

vCenter Orchestrator Developer's Guide When you set the timeout.date attribute, you set a time and date until which the workflow waits for the information from the user. You can set an absolute date, or you can create a scripted workflow element to calculate a time relative to the current time. Procedure 1 (Optional) Add a User Interaction to a Workflow on page 42 You request input parameters from users during a workflow run by adding a User Interaction schema element to the workflow.
PAGE 43

Chapter 2 Developing Workflows 3 Click the User Interaction element to display its properties tabs in the bottom half of the Schema tab. 4 Provide a name and a description for the user interaction in the Info tab. 5 Click Save. You added a user interaction element to a workflow. When the workflow reaches this element, it waits for information from the user before continuing its run. What to do next Set the security.
PAGE 44

vCenter Orchestrator Developer's Guide What to do next Set the timer.date attribute to set the timeout period for the user interaction. n To set the timeout to an absolute date and time, see “Set the timeout.date Attribute to an Absolute Date,” on page 44. n To create a function to calculate a timeout that is relative to the current date and time, see “Calculate a Relative Timeout for User Interactions,” on page 45. (Optional) Set the timeout.date Attribute to an Absolute Date You set the timeout.
PAGE 45

Chapter 2 Developing Workflows (Optional) Calculate a Relative Timeout for User Interactions You can calculate in a Date object a relative time and date at which a user interaction times out. You can set an absolute time and date in a Date object. When the time on the given date arrives, the request for a user interaction times out. Alternatively, you can create a workflow element that calculates and generates a relative Date object according to a function that you define.
PAGE 46

vCenter Orchestrator Developer's Guide You created a function that calculates a time and date relative to the current time and date and generates a Date object. A User Interaction element can receive this Date object as an input parameter to set the timeout period until which it waits for input from the user. When the workflow arrives at the User Interaction element, it suspends its run and waits either until the user provides the required information, or for 24 hours before it times out.
PAGE 47

Chapter 2 Developing Workflows Procedure 1 Click the User Interaction element in the workflow schema. 2 Click the External Inputs tab. 3 Right-click in the External Inputs tab and select Bind to workflow parameter/attribute to define the parameters that the user must provide in the user interaction. 4 (Optional) If you already defined the input parameters in the workflow, select the parameters from the proposed list.
PAGE 48

vCenter Orchestrator Developer's Guide 5 Create an errorCode attribute. An errorCode attribute has the following default properties: n Name: errorCode n Type: string n Create: Create workflow ATTRIBUTE with the same name n Value: Type an appropriate error message. 6 Click OK to close the Parameter information dialog box. 7 Drag a scriptable task element next to the user interaction element in the workflow schema.
PAGE 49

Chapter 2 Developing Workflows 2 Click the Presentation tab of the user interaction element. The Presentation tab shows the external input parameters that you created for the user interaction. 3 (Optional) Right-click the Presentation node in the Presentation tab and select Create new step. Steps allow you to create sections in the dialog box, with descriptions and headings under which you can organize the input parameters.
PAGE 50

vCenter Orchestrator Developer's Guide 5 Follow the instructions in the input parameters dialog box to provide the information that the workflow requires. You provided information to a workflow that was waiting for user input during its run. Calling Workflows Within Workflows Workflows can call on other workflows during their run.
PAGE 51

Chapter 2 Developing Workflows the next. For example, a workflow can create various objects during its run. The workflow can then start asynchronous workflows that use these objects as input parameters in their own runs. When the original workflow has started all the required workflows and run its remaining elements, it ends. However, the asynchronous workflows it started continue their runs independently of the workflow that started them.
PAGE 52

vCenter Orchestrator Developer's Guide 4 Right-click the workflow, and select References > Find Elements that Use this Element. A list of workflows that call this workflow appears. 5 Double-click a workflow in the list to highlight it in the Workflows view in the Orchestrator client. 6 Right-click the workflow, and select Edit. The workflow editor opens. 7 Click the Schema tab in the workflow editor.
PAGE 53

Chapter 2 Developing Workflows Procedure 1 Drag a Workflow element from the Action & Workflow menu to the appropriate position in the workflow schema. The Choose workflow selection dialog box appears. 2 Search for ands select the workflow you want and click OK. If the search returns a partial result, narrow your search criterion or increase the number of search results from the Tools > User preferences menu in the client.
PAGE 54

vCenter Orchestrator Developer's Guide 6 Bind the required output parameter in the OUT tab of the asynchronous workflow element. You can bind the output parameter either to the called workflow, or to that workflow's result. n Bind to the called workflow to return that workflow as an output parameter n Bind to the workflow token of the called workflow to return the result of running the called workflow. 7 Define the exception behavior of the asynchronous workflow element in the Exceptions tab.
PAGE 55

Chapter 2 Developing Workflows What to do next You can call multiple workflows simultaneously from a workflow. Call Several Workflows Simultaneously Calling several workflows simultaneously runs the called workflows synchronously as part of the run of the calling workflow. The calling workflow waits for all of the called workflows to complete before it continues. The calling workflow can use the results of the called workflows as input parameters when it runs its subsequent schema elements.
PAGE 56

vCenter Orchestrator Developer's Guide What to do next You can define long-running workflows. Running a Workflow on a Selection of Objects You can automate repetitive tasks by running a workflow on a selection of objects. For example, you can create a workflow that takes a snapshot of all the virtual machines in a virtual machine folder, or you can create a workflow that powers off all the virtual machines on a given host.
PAGE 57

Chapter 2 Developing Workflows You implement the Start workflows in a series and Start workflows in parallel workflows in the same way. The Start workflows in a series workflow runs the workflow on each object sequentially. The Start workflows in parallel workflow runs the workflow on all the objects simultaneously. Prerequisites Open a workflow for editing in the workflow editor.
PAGE 58

vCenter Orchestrator Developer's Guide Developing Long-Running Workflows A workflow in a waiting state consumes system resources because it constantly polls the object from which it requires a response. If you know that a workflow will potentially wait for a long time before it receives the response it requires, you can add long-running workflow elements to the workflow. Every running workflow consumes a system thread.
PAGE 59

Chapter 2 Developing Workflows 8 Define a function to calculate and generate a Date object named timerDate in the scripting pad in the Scripting tab. For example, you can create a Date object by implementing the following JavaScript function, in which the timeout period is a relative delay in milliseconds. timerDate = new Date(); System.log( "Current date : '" + timerDate + "'" ); timerDate.setTime( timerDate.getTime() + (86400 * 1000) ); System.
PAGE 60

vCenter Orchestrator Developer's Guide 6 Click the timer.date parameter's Not set button to bind the parameter to an appropriate Date object. The Waiting Timer selection dialog box opens, presenting a list of possible bindings. 7 n Select a predefined Date object from the proposed list, for example one defined by a Scriptable Task element elsewhere in the workflow. n Alternatively, create a Date object that sets a specific date and time for the workflow to await.
PAGE 61

Chapter 2 Developing Workflows 2 Link the Scriptable Task element to the elements that precede and follow it in the workflow schema. One of the elements that precedes the Scriptable Task must generate a VC:Task object as its output parameter. 3 Click the Scriptable Task element to show its properties tabs in the bottom half of the Schema tab. 4 Provide a name and description for the trigger in Info properties tab. 5 Click the IN properties tab.
PAGE 62

vCenter Orchestrator Developer's Guide Prerequisites You must have created a workflow, opened it for editing in the workflow editor, added some elements to the workflow schema, and defined a trigger event, encapsulated in a Trigger object. Procedure 1 Drag a Waiting Event element from the Generic menu to the position in the workflow schema at which you want to suspend the workflow's run. 2 Link the Waiting Event element to the elements that precede and follow it in the workflow schema.
PAGE 63

Chapter 2 Developing Workflows Create a Configuration Element Configuration elements allow you to set common attributes across an Orchestrator server. All elements that are running in the server can call on the attributes you set in a configuration element. Creating configuration elements allows you to define common attributes once in the server, rather than individually in each element. Procedure 1 Click the Configurations view in the Orchestrator client.
PAGE 64

vCenter Orchestrator Developer's Guide Workflow User Permissions Orchestrator defines levels of permissions that you can apply to users or groups to allow or deny them access to workflows. View The user can view the elements in the workflow, but cannot view the schema or scripting. Inspect The user can view the elements in the workflow, including the schema and scripting. Execute The user can run the workflow. Edit The user can edit the workflow. Admin The user can set permissions on the workflow.
PAGE 65

Chapter 2 Developing Workflows Validating Workflows Orchestrator provides a workflow validation tool. Validating a workflow helps identify errors in the workflow and checks that the data flows from one element to the next correctly. When you validate a workflow, the validation tool creates a list of any errors or warnings. Clicking an error in the list highlights the workflow element that contains the error.
PAGE 66

vCenter Orchestrator Developer's Guide 9 Repeat the preceding steps until you have eliminated all validation errors. You validated a workflow, and possibly fixed any validation errors. What to do next You can run the workflow. Running Workflows A workflow runs according to a logical flow of events. When you run a workflow, each schema element in the workflow runs according to the following sequence.
PAGE 67

Chapter 2 Developing Workflows 3 Right-click the Create simple virtual machine workflow and select Start workflow. 4 Provide the following information into the Start workflow input parameters dialog box to create a virtual machine in a vCenter Server connected to Orchestrator. Option Action Virtual machine name Name the virtual machine orchestrator-test. Virtual machine folder a b Click Not set for the Virtual machine folder value. Select a virtual machine folder from the inventory.
PAGE 68

vCenter Orchestrator Developer's Guide Develop a Simple Example Workflow Developing a simple example workflow demonstrates the most common steps in the workflow development process. The example workflow, named Start VM and Send Email, starts an existing virtual machine in the vCenter Server and sends an email to the administrator to confirm that the virtual machine has started. The example workflow performs the following tasks: 1 Prompts the user for a virtual machine to start.
PAGE 69

Chapter 2 Developing Workflows 6 Define the Simple Workflow Example Decision Bindings on page 75 You bind a workflow's elements together in the Schema tab of the workflow editor. Decision bindings define how decision elements compare the input parameters received to the decision statement, and generate output parameters according to whether the input parameters match the decision statement.
PAGE 70

vCenter Orchestrator Developer's Guide 2 Log in using the Orchestrator username and password. 3 Click Workflows on the left side of the client interface. 4 Right-click the root of the workflows list and select Add folder. 5 Name the new folder Workflow Examples and click OK. 6 Right-click the Workflow Examples folder and select New Workflow. 7 Name the new workflow Start VM and Send Email and click OK. 8 Right-click the Start VM and Send Email workflow and select Edit.
PAGE 71

Chapter 2 Developing Workflows 9 n Type: String n Description: The email address of the person to inform of the result of this workflow Click Save at the bottom of the Inputs tab. You defined the workflow's input parameters. What to do next You must create the workflow's schema. Create the Simple Workflow Example Schema You create a workflow schema in the Schema tab of the workflow editor. The workflow schema contains the elements that the workflow runs.
PAGE 72

vCenter Orchestrator Developer's Guide n Drag a scripted element to the right of OK and name it Send Email. n Drag a scripted element to the right of Timeout 2 and name it Send Email Failed. 13 Drag an end element to the right of Send Email. 14 Click Save at the bottom of the workflow editor Schema tab. Figure 2-3 shows the layout of the Start VM and Send Email workflow schema elements. Figure 2-3.
PAGE 73

Chapter 2 Developing Workflows Table 2-7.
PAGE 74

vCenter Orchestrator Developer's Guide Create Workflow Zones You can emphasize different zones in workflow by adding workflow notes of different colors. Creating different workflow zones helps to make complicated workflow schema easier to read and understand. Prerequisites You must have created the Start VM and Send Email workflow, laid out its schema, and linked the schema elements together. Procedure 1 Drag a workflow note element from the Generic menu into the workflow editor.
PAGE 75

Chapter 2 Developing Workflows Define the Simple Workflow Example Decision Bindings You bind a workflow's elements together in the Schema tab of the workflow editor. Decision bindings define how decision elements compare the input parameters received to the decision statement, and generate output parameters according to whether the input parameters match the decision statement.
PAGE 76

vCenter Orchestrator Developer's Guide 3 Click the IN tab in the schema element properties pane at the bottom of the Schema tab. You will see the two possible input parameters available to the startVM action, vm and host. Orchestrator automatically binds the vm parameter to vm[in-parameter] because the startVM action can only take a VC:VirtualMachine as an input parameter.
PAGE 77

Chapter 2 Developing Workflows Table 2-8. Binding Values of the vim3WaitTaskEnd Action Parameter Name Binding Type Bind to Existing or Create Parameter? task IN Create progress IN Create Binding Values n Local Parameter: task n Source parameter: task[attribute] n Type: VC:Task n Description: The vCenter server task currently running.
PAGE 78

vCenter Orchestrator Developer's Guide Table 2-9. Binding Values of the vim3WaitToolsStarted Action Parameter Name Binding Type Bind to Existing or Create Parameter? vm IN Automatic binding pollingRate IN Bind Binding Values n Local Parameter: vm n Source parameter: vm[inparameter] n Type: VC:VirtualMachine n n Value: Not editable, variable is not a workflow attribute. Description: The virtual machine to start.
PAGE 79

Chapter 2 Developing Workflows 3 Click the IN tab in the schema element properties pane at the bottom of the Schema tab. Because this is a custom scriptable task element, no properties are predefined for you. 4 Right-click in the IN tab and select Bind to workflow parameter/attribute. 5 Select vm from the proposed list of parameters. 6 Leave the OUT and Exception tabs blank. This element does not generate an output parameter or exception. 7 Click the Scripting tab.
PAGE 80

vCenter Orchestrator Developer's Guide Table 2-10. Bindings of the Start VM Failed Scriptable Task Element Parameter Name Binding Type Bind to Existing or Create Parameter? vm IN Bind errorCode IN Create Binding Values n Local Parameter: vm n Source parameter: vm[inparameter] n Type: VC:VirtualMachine n Description: The virtual machine to power on.
PAGE 81

Chapter 2 Developing Workflows Table 2-11. Bindings of the Timeout 1 Scriptable Task Element Parameter Name Binding Type Bind to Existing or Create Parameter? vm IN Bind errorCode IN Bind Binding Values n Local Parameter: vm n Source parameter: vm[inparameter] n Type: VC:VirtualMachine n Description: The virtual machine to start. n Local Parameter: errorCode n Source parameter: errorCode[attribute] n Type: string Description: Catch any exceptions while powering on a VM.
PAGE 82

vCenter Orchestrator Developer's Guide Table 2-12. Bindings of the Timeout 2 Scriptable Task Element Parameter Name Binding Type Bind to Existing or Create Parameter? vm IN Bind errorCode IN Bind Binding Values n Local Parameter: vm n Source parameter: vm[inparameter] n Type: VC:VirtualMachine n Description: The virtual machine to power on. n Local Parameter: errorCode n Source parameter: errorCode[attribute] n Type: string Description: Catch any exceptions while powering on a VM.
PAGE 83

Chapter 2 Developing Workflows The OK scriptable task element requires the following scripted function. body = "The VM '"+vm.name+"' has started successfully and is ready for use"; //Writes the following event in the vCO database Server.log(body); Send Email Failed Scriptable Task Element The Send Email Failed scriptable task element receives notice that the sending of the email failed, and writes the event in the Orchestrator log.
PAGE 84

vCenter Orchestrator Developer's Guide Table 2-15. Bindings of the Send Email Scriptable Task Element Parameter Name Binding Type Bind to Existing or Create Parameter? vm IN Bind toAddress IN Bind Binding Values n Local Parameter: vm n Source parameter: vm[inparameter] n Type: VC:VirtualMachine n Description: The virtual machine to power on.
PAGE 85

Chapter 2 Developing Workflows //Apply the method that sends the email message myEmailMessage.sendMessage(); System.log("Sent email to '"+toAddress+"'"); Define the Simple Example Workflow Exception Bindings You define exception bindings in the Schema tab in the workflow editor. Exception bindings define how elements process errors. The following elements in the workflow return exceptions: startVM, vim3WaitTaskEnd, Send Email, and vim3WaitToolsStarted.
PAGE 86

vCenter Orchestrator Developer's Guide 2 Check the check boxes to make the following attributes read-only constants: n progress n pollRate n timeout n smtpHost n fromAddress n subject You have defined which of the workflow's attributes are constants and which are variables. What to do next You must set the parameter properties and place constraints on the possible values for that parameter.
PAGE 87

Chapter 2 Developing Workflows 12 Add a description in the Description tab in the bottom half of the screen. For example, type The email address of the person to notify. 13 Click the Properties tab for (string)toAddress. 14 Right-click the Properties tab and select Add Property > Mandatory input. 15 Set the value of the Mandatory input property to Yes. 16 Right-click the Properties tab and select Add Property > Matching regular expression.
PAGE 88

vCenter Orchestrator Developer's Guide 5 Provide a description of the Virtual Machine display group in the Description text box in the General tab at the bottom of the Presentation tab. For example, type Select the virtual machine to start. The text you enter here appears as a prompt in the input parameter dialog box when users start the workflow. 6 Drag the (VC:VirtualMachine)vm parameter under the Virtual Machine display group.
PAGE 89

Chapter 2 Developing Workflows 9 Click the workflow token to follow the progress of the workflow as it runs. If the workflow ran successfully, the virtual machine you identified is in the powered-on state, and the email recipient you defined receives a confirmation email. Develop a Complex Workflow Developing a complex example workflow demonstrates the most common steps in the workflow development process and more advanced scenarios, such as creating custom decisions and loops.
PAGE 90

vCenter Orchestrator Developer's Guide 6 Create the Complex Workflow Example Zones on page 94 Optionally, you can highlight different zones of the workflow by adding workflow notes. Creating different workflow zones helps to make complicated workflow schema easier to read and understand. 7 Define the Complex Workflow Example Bindings on page 95 You bind a workflow's elements together in the Schema tab of the workflow editor. Bindings define the data flow of the workflow.
PAGE 91

Chapter 2 Developing Workflows Define the Complex Workflow Example Input Parameters You define workflow input parameters in the workflow editor. The input parameters provide data for the workflow to process. Prerequisites You must have created the Take a Snapshot of All Virtual Machines in a Resource Pool workflow, and opened it for editing in the workflow editor. Procedure 1 Click the Inputs tab in the workflow editor. 2 Define the following input parameter.
PAGE 92

vCenter Orchestrator Developer's Guide 9 Add the following description of the action in the General tab. This action returns an array containing the disk modes of all disks on a VM. The elements in the array each have one of the following string values: - persistent - independent-persistent - nonpersistent - independent-nonpersistent Legacy values: - undoable - append 10 Click the Scripting tab.
PAGE 93

Chapter 2 Developing Workflows 3 Add the following schema elements to the workflow schema. Table 2-16.
PAGE 94

vCenter Orchestrator Developer's Guide 2 Create the following links between the elements in the schema. Table 2-17.
PAGE 95

Chapter 2 Developing Workflows Procedure 1 2 Create the following workflow zones by using workflow notes. Elements in Zone Description Start element; Initialize scriptable task; VMs to Process? custom decision Get an array of virtual machines from a resource pool, initialize the counter of the Array and set the first virtual machine to be treated, if any. Pool has no VMs scriptable task. Resource pool contains no virtual machines of which to take snapshots.
PAGE 96

vCenter Orchestrator Developer's Guide 3 Click Save at the bottom of the workflow editor Schema tab. All the elements' input and output parameters are bound to the appropriate parameter types and values. What to do next You must set the attribute properties. Complex Workflow Example Bindings Bindings define how the simple workflow example's action elements process input and output parameters.
PAGE 97

Chapter 2 Developing Workflows Table 2-18.
PAGE 98

vCenter Orchestrator Developer's Guide Pool Has No VMs Scriptable Task Element The Pool Has No VMs scriptable task element logs the fact that the resource pool contains no eligible virtual machines in the Orchestrator database. Table 2-20 shows the bindings that the Pool Has No VMs scriptable task element requires. Table 2-20.
PAGE 99

Chapter 2 Developing Workflows getVMDisksModes Action Element The getVMDisksModes action element obtains the modes of the disks running in a virtual machine. Table 2-22 shows the bindings that the getVMDisksModes action element requires. Table 2-22.
PAGE 100

vCenter Orchestrator Developer's Guide if (vmDisksModes[i].charAt(0)=="i") { containsIndependentDisks = true; } } } else { //if no disk found no need to try to snapshot the VM System.warn("Won't snapshot '"+vm.name+"', no disks found"); return false; } if (containsIndependentDisks) { System.warn("Won't snapshot '"+vm.name+"', independent disk(s) found"); return false; } else { System.log("Snapshoting '"+vm.
PAGE 101

Chapter 2 Developing Workflows Table 2-24. Bindings of the Create a snapshot Workflow Element (Continued) Parameter Name Binding Type Bind to Existing or Create Parameter? memory IN Create Binding Values n Local parameter: memory n Source parameter: snapshotMemory[attribute] n Type: Boolean Value: no Description: If TRUE, a dump of the internal state of the virtual machine (a memory dump) is included in the snapshot.
PAGE 102

vCenter Orchestrator Developer's Guide Table 2-25. Bindings of the VM Snapshots Scriptable Task Element Parameter Name Binding Type Bind to Existing or Create Parameter? vm IN Bind snapshotVmArray snapshotVmArray IN OUT Bind Bind Binding Values n Local parameter: vm n Source parameter: vm[attribute] n Type: VC:VirtualMachine n Description: An active virtual machine of which to take a snapshot.
PAGE 103

Chapter 2 Developing Workflows Table 2-26.
PAGE 104

vCenter Orchestrator Developer's Guide Table 2-27.
PAGE 105

Chapter 2 Developing Workflows The Set Output scriptable task element performs the following scripted function. //Passes the value of the internal attribute to a workflow output parameter snapshotVmArrayOut = snapshotVmArray; Set the Complex Workflow Example Attribute Properties You set the attribute properties in the General tab in the workflow editor. Prerequisites You must have created the workflow, created and linked its schema, and defined the IN and OUT bindings for all elements.
PAGE 106

vCenter Orchestrator Developer's Guide 7 Click the Properties tab for (VC:ResourcePool)resourcePool. 8 Right-click the Properties tab and select Add Property > Mandatory input. 9 Right-click the Properties tab again and select Select value as from the list of proposed properties. When you set this property, you set how the user selects the value of the (VC:ResourcePool)resourcePool input parameter. 10 Drag the (VC:ResourcePool)resourcePool parameter under the Resource Pool display group.
PAGE 107

Developing Actions 3 Orchestrator provides libraries of predefined actions. Actions represent individual functions that you use as building blocks in workflows, Web views, and scripts. Actions are JavaScript functions. They take multiple input parameters and have a single return value. They can call on any object in the Orchestrator API, or on objects in any API that you import into Orchestrator by using a plug-in. When a workflow runs, an action takes its input parameters from the workflow's attributes.
PAGE 108

vCenter Orchestrator Developer's Guide 2 Browse the libraries of actions by expanding the nodes of the actions hierarchical list. You can use the Actions view to view information about the actions in the libraries and create and edit actions. Components of the Actions View When you click an action in the actions hierarchical list, information about that action appears in the Orchestrator client's right pane. The Actions view presents four tabs.
PAGE 109

Chapter 3 Developing Actions 7 To change the default return type, click the void link. 8 Add the action input parameters by clicking the arrow icon. 9 Write the action script. 10 Click Save and close. You created a custom action and added the action input parameters. What to do next You can use the new custom action in a workflow.
PAGE 110

vCenter Orchestrator Developer's Guide n Avoid writing loops in an action. Create loops in the workflow instead. If the server restarts, a running workflow resumes at its last check point, at the start of an element. If you write a loop inside an action and the server restarts while the workflow is running that action, the workflow resumes at the check point at the beginning of that action, and the loop starts again from the beginning. Action Naming Guidelines Use basic guidelines when you name actions.
PAGE 111

Scripting 4 Orchestrator uses JavaScript to create building blocks from which you create actions, workflow elements, and policies that access the APIs of the technologies that you plug into Orchestrator. Orchestrator uses the Mozilla Rhino 1.6 JavaScript engine as its scripting engine. The scripting engine provides variable type checking, name space management, automatic completion, and exception handling.
PAGE 112

vCenter Orchestrator Developer's Guide Orchestrator Elements that Require Scripting Not all Orchestrator elements require you to write scripts. To provide maximum flexibility to your applications, you can customize certain elements by adding JavaScript functions. You can add scripts in the following Orchestrator elements. Actions Actions are scripted functions.
PAGE 113

Chapter 4 Scripting Using the Orchestrator API The Orchestrator API exposes as JavaScript objects and methods all of the objects and functions of the technologies that Orchestrator accesses through its plug-ins. For example, you can access JavaScript implementations of the vCenter Server API through the Orchestrator API, to include vCenter operations in scripted elements that you create.
PAGE 114

vCenter Orchestrator Developer's Guide Access the Scripting Engine from the Workflow Editor The Orchestrator scripting engine uses the Mozilla Rhino 1.6 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.
PAGE 115

Chapter 4 Scripting Procedure u You can access the API Explorer from either the Orchestrator client or from the Scripting tabs of the workflow, policy, and action editors. n To access the API Explorer from the Orchestrator client, click Tools > API Explorer in the Orchestrator client tool bar. n To access the API Explorer from the Scripting tabs of the workflow, policy, and action editors, click Search APIon the left.
PAGE 116

vCenter Orchestrator Developer's Guide Table 4-1. JavaScript Objects in the Orchestrator API (Continued) Object Icon in Hierarchical List Description Method JavaScript methods Constructor JavaScript constructors Enumeration JavaScript enumerations String set String set, default values Module A collection of actions Plug-in Image that plug-in defines The APIs that plug-ins expose to Orchestrator Writing Scripts The Orchestrator scripting engine helps you to write scripts.
PAGE 117

Chapter 4 Scripting What to do next Add parameters to the script. Color Coding of Scripting Keywords When you add scripts on the Scripting tab of a scripted workflow element, certain types of keywords appear in different colors to enhance the readability of the code. All scripting appears in standard black font unless stated otherwise. Table 4-2.
PAGE 118

vCenter Orchestrator Developer's Guide Accessing the Orchestrator Server File System from JavaScript and Workflows Orchestrator limits access to the Orchestrator server file system from JavaScript and Workflows to specific directories. Javascript functions and workflows only have read, write, and execute permission in the permanent directory c:\orchestrator.
PAGE 119

Chapter 4 Scripting Exception Handling Guidelines The Orchestrator implementation of the Mozilla Rhina JavaScript Engine supports exception handling, to allow you to process errors. You must use the following guidelines when writing exception handlers in scripts. n Use the following European Computer Manufacturers Association (ECMA) error types. Use Error as a generic exception that plug-in functions return, and the following specific error types.
PAGE 120

vCenter Orchestrator Developer's Guide Orchestrator JavaScript Examples You can cut, paste, and adapt the Orchestrator JavaScript examples to help you write JavaScripts for common orchestration tasks. n Basic Scripting Examples on page 120 Workflow scripted elements, actions, and policies require basic scripting of common tasks. You can cut, paste, and adapt these examples into your scripted elements.
PAGE 121

Chapter 4 Scripting ; System.log("'people' = " + people); // built-in XML type System.log("'people' is of type : " + typeof(people)); // list-like interface System.log("which contains a list of " + people.person.length() + " persons"); System.log("whose first element is : " + people.person[0]); // attribute 'id' is mapped to field '@id' people.person[0].@id='47'; // change Moe's id to 47 // also supports search by constraints System.log("Moe's id is now : " + people.person.(name=='Moe').
PAGE 122

vCenter Orchestrator Developer's Guide Compare Types The following JavaScript example checks whether an object matches a given object type. var path = 'myurl/test'; if(typeof(path, string)){ throw("string"); else { throw("other"); } Run a Command in the Orchestrator Server The following JavaScript example allows you to run a command line on the Orchestrator server. Use the same credentials as those used to start the server. NOTE Access to the file system is limited by default.
PAGE 123

Chapter 4 Scripting Add Content to a Simple Text File The following JavaScript example adds content to a text file. var tempDir = System.getTempDirectory() ; var fileWriter = new FileWriter(tempDir + "/readme.txt") ; fileWriter.open() ; fileWriter.writeLine("File written at : "+new Date()) ; fileWriter.writeLine("Another line") ; fileWriter.close() ; Obtain the Contents of a File The following JavaScript example obtains the contents of a file from the Orchestrator server host machine.
PAGE 124

vCenter Orchestrator Developer's Guide Networking Scripting Examples Workflow scripted elements, actions, and policies require scripting of common networking tasks. You can cut, paste, and adapt these examples into your scripted elements. Obtain Text from a URL The following JavaScript example accesses a URL, obtains text, and converts it to a string. var url = new URL("http://www.vmware.com") ; var htmlContentAsString = url.
PAGE 125

Chapter 4 Scripting Handle Enumeration Types The following JavaScript example allows Orchestrator to use scripting to handle vCenter Server enumerations through the vCenter Server plug-in. // a VcSharesLevel FINDER ENUMERATION TYPE, for example // received from an input parameter var sharesLevel = ... // get the String value of the FINDER ENUMERATION TYPE var sharesLevelString = sharesLevel.value; // Assign to a DataObject var sharesInfo = new VcSharesInfo(); sharesInfo.
PAGE 126

vCenter Orchestrator Developer's Guide } } } } Set vCenter Server Option Values The following JavaScript example allows Orchestrator to set vCenter VcOptionManager option values. var myVcOptionValue = new VcOptionValue(); myVcOptionValue.key = VimAdvancedOptionKey; myVcOptionValue.value_LongValue = VimAdvancedOptionValue; You can set the following optional value types as VcOptionValue attributes. value Attribute is a string value. value_FloatValue Attribute value is a float value.
PAGE 127

Chapter 4 Scripting var workflowScheduleDate = new Date() ; var time = workflowScheduleDate.getTime() + (60*60*1000) ; workflowScheduleDate.setTime(time) ; var scheduledTask = workflowToLaunch.schedule(workflowParameters,workflowScheduleDate); Run a Workflow on a Selection of Objects in a Loop The following JavaScript example takes the array of virtual machines and runs a workflow on each one in a For loop. VMs and workflowToRun are workflow inputs. var len=VMs.
PAGE 128

vCenter Orchestrator Developer's Guide 128 VMware, Inc.
PAGE 129

Creating Resource Elements 5 Workflows and Web views can require as attributes objects that you create independently of Orchestrator. To use external objects as attributes in workflows or Web views, you import them into the Orchestrator server as resource elements. Objects that workflows and Web views can use as resource elements include image files, scripts, XML templates, HTML files, and so on.
PAGE 130

vCenter Orchestrator Developer's Guide What to do next Import and edit a resource element. Import an External Object to Use as a Resource Element Workflows and Web views can require as attributes objects that you create independently of Orchestrator. To use external objects as attributes in workflows or Web views, you import them to the Orchestrator server as resource elements. Prerequisites An image file, script, XML template, HTML file, or other type of object to import.
PAGE 131

Chapter 5 Creating Resource Elements What to do next Save the resource element to a file to update it, or add the resource element to a workflow or Web view. Save a Resource Element to a File You can save a resource element to a file on your local system. Saving the resource element as a file allows you to edit it. Prerequisites You must have a resource element in the Orchestrator server to save to a file. Procedure 1 Right-click the resource element and select Save to file.
PAGE 132

vCenter Orchestrator Developer's Guide Procedure 1 Click the Workflows view in the Orchestrator client. 2 Expand the hierarchical tree viewer to navigate to the workflow that requires the resource element as an attribute. 3 Right-click the workflow and select Edit. 4 On the General tab, right-click in the attributes pane and select Add attribute. 5 Click the attribute name and type a new name for the attribute. 6 Click Type to set the attribute type.
PAGE 133

Chapter 5 Creating Resource Elements 8 In the Select a type dialog box, type resource in the Filter box to search for an object type. Option Action Define a single resource element as an attribute Select ResourceElement from the list. Define a folder that contains multiple resource elements as an attribute Select ResourceElementCategory from the list. 9 Click Value and type the name of the resource element or category of resource elements in the Filter text box.
PAGE 134

vCenter Orchestrator Developer's Guide 134 VMware, Inc.
PAGE 135

Creating Packages 6 Packages are the vehicle for transporting content from one Orchestrator server to another. Packages can contain workflows, actions, policies, Web views, configurations, or resources. When you add an element to a package, Orchestrator checks for dependencies and adds any dependent elements to the package. For example, if you add a workflow that uses actions or other workflows, Orchestrator adds those actions and workflows to the package.
PAGE 136

vCenter Orchestrator Developer's Guide Procedure 1 Click the Packages view in the Orchestrator client. 2 Click the menu button in the title bar of the Packages list and select Add package. 3 Name the new package and click OK. The syntax for package names is domain.your_company.folder.package_name. For example, com.vmware.myfolder.mypackage. 4 Right-click the package and select Edit. The package editor opens. 5 Add a description for the package in the General tab.
PAGE 137

Chapter 6 Creating Packages 3 Search for a user or user group. The search results show all of the users and user groups from the Orchestrator LDAP server that match the search. 4 Select a user or user group and click OK. 5 Right-click the user and select Add access rights. 6 Check the appropriate check boxes to set the level of permissions for this user and click OK.
PAGE 138

vCenter Orchestrator Developer's Guide 138 VMware, Inc.
PAGE 139

Developing Plug-Ins 7 Plug-ins allow you to use Orchestrator to access and control external technologies and applications. Exposing an external technology in an Orchestrator plug-in allows you to incorporate objects and functions in workflows that access the objects and functions of that external technology. Plug-ins allow you to extend the Orchestrator scripting API with scripting types, classes, and methods that you can use in workflows to perform operations in the plugged-in technology.
PAGE 140

vCenter Orchestrator Developer's Guide n Role of the vso.xml File on page 142 You use the vso.xml file to map the objects, classes, methods, and attributes of the plugged-in technology to Orchestrator inventory objects, scripting types, scripting classes, scripting methods, and attributes. The vso.xml file also defines the configuration and start-up behavior of the plug-in. n Roles of the Plug-In Adapter on page 142 The plug-in adapter is the entry point of the plug-in to the Orchestrator server.
PAGE 141

Chapter 7 Developing Plug-Ins Plug-ins are composed of the following parts. Plug-In Module The plug-in itself, as defined by a collection of Java classes, a vso.xml file, and packages of the workflows and actions that interact with the objects that you access through the plug-in. The plug-in module is mandatory. Plug-In Adapter Defines the interface between the plugged-in technology and the Orchestrator server. The adapter is the point of entry of the plug-in to the orchestration platform.
PAGE 142

vCenter Orchestrator Developer's Guide Role of the vso.xml File You use the vso.xml file to map the objects, classes, methods, and attributes of the plugged-in technology to Orchestrator inventory objects, scripting types, scripting classes, scripting methods, and attributes. The vso.xml file also defines the configuration and start-up behavior of the plug-in. The vso.xml file performs the following principal roles.
PAGE 143

Chapter 7 Developing Plug-Ins technology, to allow Orchestrator to launch defined actions if certain events occur on the object, or if the object's values pass certain thresholds. Similarly, you can define PluginTrigger and PluginWatcher instances that define events that Wait Event elements in long-running workflows await. Sets the plug-in name You provide a name for the plug-in in the vso.xml file. The plug-in adapter gets this name from the vso.
PAGE 144

vCenter Orchestrator Developer's Guide Role of Finder Objects Finder objects identify and locate specific instances of managed object types in the plugged-in technology. Orchestrator can modify and interact with objects that it finds in the plugged-in technology by running workflows on the finder objects. Every instance of a given managed object type in the plugged-in technology must have a unique identifier so that Orchestrator finder objects can find them.
PAGE 145

Chapter 7 Developing Plug-Ins Role of Event Handlers Events are changes in the states or attributes of the objects that Orchestrator finds in the plugged-in technology. Orchestrator monitors events by implementing event handlers. Orchestrator plug-ins allow you to monitor events in a plugged-in technology in different ways. The Orchestrator plug-in API allows you to create the following types of event handlers to monitor events in a plugged-in technology.
PAGE 146

vCenter Orchestrator Developer's Guide n Naming Plug-In Objects on page 147 You must provide a unique identifier for every object that the plug-in finds in the plugged-in technology. You define the object names in the elements and in the