VMware

vSphere Web Client SDK Release Notes

Released 10 September 2012

Build 797199 is VMware vSphere Web Client for vSphere 5.1

This document contains the following information:

  • About the VMware vSphere Web Client SDK
  • What's in this Release?
  • Requirements
  • Known Issues

About the VMware vSphere Web Client SDK

The VMware vSphere Web Client SDK allows you to create extensions to the vSphere Web Client graphical user interface.

What's in this Release?

This is the initial release of the vSphere Web Client SDK.

Upon installing the vSphere Web Client SDK, take note of the following directories:

  • docs - follow the instructions in GettingStarted.html to set up your development environment. Check the most recent SDK documentation on vmware.com
  • libs - the Flex and Java libraries
  • samples - various examples that use the different vSphere Web Client APIs
  • resources - files used by build scripts
  • tools - the Eclipse IDE plug-in to create new UI or Java plug-in projects
The main focus of the vSphere Web Client SDK in vSphere 5.1. is the rich extensibility framework and the in-built Data Service. The actual client UI components are not part of the SDK. To create your own UI components for the vSphere Web Client, you can use common Flex libraries.

Be sure to check the VMware Communities forums for additional information and troubleshooting help.

Requirements

To create plug-in modules for the vSphere Web Client, your development environment must include the following items.
  • A development environment capable of developing Flex web applications using ActionScript and MXML. A best practice is to use the FlexBuilder plug-in for the Eclipse IDE. The vSphere Web Client SDK includes tools and plug-ins for the Eclipse IDE to aid you in creating vSphere Web Client plug-in modules.
  • A text editor for creating XML files. While you can use any text editor to create the required XML, a best practice is to use an XML editor such as Altova XML Spy to ensure that you create well-formed XML files.
  • A development environment capable of developing Java-based web applications. A best practice is to use the Eclipse IDE. The vSphere Web Client contains tools and plug-ins for the Eclipse IDE to aid you in creating services compatible with the vSphere Web Client Virgo server framework.
  • A build of the vSphere Web Client on a web server, running the vSphere Web Client Virgo server framework.

Known Issues

The following is a list of known issues for the vSphere Web Client SDK.
  • When updating the vSphere Web Client with a newer version of a plug-in module found on vCenter Server, the vSphere Web Client can experience a deadlock when un-deploying the old plug-in module. This can result in a five-minute timeout exception and will cause a delay in logging into the vSphere Web Client on the first launch after the update. The vSphere Web Client authentication will time-out on the first login attempt. The new plug-in may not be visible during the first login. Subsequent logins should function correctly.