Scripting with workflow tokens
by Daniel Langenhan
VMware vRealize Orchestrator Cookbook - Second Edition
- VMware vRealize Orchestrator Cookbook Second Edition
- VMware vRealize Orchestrator Cookbook Second Edition
- Credits
- About the Author
- About the Reviewers
- www.PacktPub.com
- Preface
- 1. Installing and Configuring Orchestrator
- 2. Optimizing Orchestrator Configuration
- Introduction
- Tuning the appliance
- Tuning Java
- Configuring the Kerberos authentication
- Configuring access to the local filesystem
- Configuring the Orchestrator service SSL certificate
- Orchestrator log files
- Redirecting Orchestrator logs to an external server
- Backup and recovery
- Control Center titbits
- 3. Distributed Design
- Introduction
- Building an Orchestrator cluster
- Load-balancing Orchestrator
- Upgrading a cluster
- Managing remote Orchestrators
- Synchronizing Orchestrator elements between Orchestrator servers
- 4. Programming Skills
- Introduction
- Version control
- Changing elements in a workflow
- Importing and exporting Orchestrator elements
- Working with packages
- Workflow auto documentation
- Resuming failed workflows
- Using the workflow debugging function
- Undelete workflows and actions
- Scheduling workflows
- Sync presentation settings
- Locking elements
- 5. Visual Programming
- 6. Advanced Programming
- Introduction
- JavaScript complex variables
- Working with JSON
- JavaScript special statements
- Turning strings into objects
- Working with the API
- Creating actions
- Waiting tasks
- Sending and waiting for custom events
- Using asynchronous workflows
- Scripting with workflow tokens
- Working with user interactions
- 7. Interacting with Orchestrator
- Introduction
- User management
- User preferences
- Using Orchestrator though the vSphere Web Client
- Accessing Orchestrator REST API
- Accessing the Control Center via the REST plugin
- Running Orchestrator workflows using PowerShell
- Using PHP to access the REST API
- 8. Better Workflows and Optimized Working
- 9. Essential Plugins
- 10. Built-in Plugins
- Introduction
- Working with XML
- Working with SQL (JDBC)
- Working with SQL (SQL plugin)
- Working with PowerShell
- Working with SOAP
- Working with Active Directory
- Working with SNMP
- Working with AMQP
- 11. Additional Plugins
- 12. Working with vSphere
- 13. Working with vRealize Automation
- Introduction
- Working with the vRA-integrated Orchestrator
- Automating a vRA instance in Orchestrator
- Configuring an external Orchestrator in vRA
- Adding Orchestrator as an infrastructure endpoint
- Adding an Orchestrator endpoint
- Integrating Orchestrator workflows as XaaS Blueprints
- Managing AD users with vRA
- Using the Event Manager to start workflows
In this recipe, we have taken a closer look at the workflow token. The workflow token is the execution of a given workflow.
In this example, we start a workflow asynchronously and then wait for it to finish the workflow token:
- Create a new workflow and create the following variables:
Name
Type
Section
Use
sleepTimeNumber
IN
It defines the time the workflow should sleep.
wfTokenWorkflowToken
Attribute
The workflow token of the asynchronous workflow.
waitTaskTimeNumber
Attribute
How long to wait between checks.
- Build the following workflow (
06.07.01 Wait for Workflow Tokenin the example package):
- The custom decision element should contain the following script:
if (wfToken.state =="completed"){ return true; } else { return false; } - Save and run the workflow
The workflow token is a unique ID that is created with each workflow run. It contains a link to all the content of a workflow run, such as the logs, as well as all the attributes and in-and out parameters. You can access it via JavaScript, the API (see the recipe Accessing Orchestrator REST API in Chapter 7, Interacting with Orchestrator) or the Control Center (see the recipe Control Center titbits in Chapter 2, Optimizing Orchestrator Configuration). When you look at a workflow run (the items underneath a workflow), you see nothing else but the Orchestrator Client accessing the data stored in the workflow token.
In addition to the properties, there are also some methods that allow you to cancel or answer the workflow.
Each workflow token has simple properties and methods, and they are as follows:
|
Properties and methods |
Description |
|
|
Converts the token ID into a string. |
|
|
This is the date and time the workflow was started. |
|
|
This is the date and time the workflow was finished. |
|
|
This is the state the workflow is in. The different states are |
|
|
This is the name of the workflow. |
|
|
This is the error message a workflow generated and is |
|
|
This helps get all the attributes of the workflow; it returns an Orchestrator properties object. The return is a JavaScript object. |
|
|
This helps get all the in-parameters of the workflow; it returns an Orchestrator properties object. The return is a JavaScript object. |
|
|
This helps get all the out-parameters of the workflow; it returns an Orchestrator properties object. The return is a JavaScript object |
|
|
Cancels the workflow execution. |
|
|
Saves the image of the workflow schema to a |
|
|
Gets the state of a given |
-
No Comment