vSphere Web Client SDK 6.0 Update 1 Release Notes

Updated on: 7 October 2015

vSphere Web Client SDK 6.0 Update 1 | 10 SEPTEMBER 2015 | Build 3018528

Check for additions and updates to these release notes.

What's in the Release Notes

The release notes cover the following topics:

The following features have been introduced to the vSphere Web Client SDK 6.0 Update 1:

The following APIs have been changed since version 6.0 to support the development of HTML plug-ins by using the HTML bridge:

The WEB_PLATFORM.setGlobalRefreshHandler API replaces the WEB_PLATFORM.onGlobalRefreshRequest API to ensure that the global refresh works correctly in the HTML views. The onGlobalRefreshRequest API is still supported but you must avoid using it.
For more information about how to use the setGlobalRefreshHandler, see the chassis-summary.js JavaScript file of the chassisA-html sample. The file is located in the following vSphere Web Client SDK directory: vsphere-client-sdk\html-bridge\samples\chassisA-html\src\main\webapp\resources\js.
A small change is introduced in the VMware Web Client platform reference file ( web-platform.js ) to ensure that the HTML plug-ins are operational in case the vSphere Web Client runs inside an iFrame.
The userSession object returned by WEB_PLATFORM.getUserSession() in JavaScript no longer contains a samlTokenXml value like its Java counterpart. You must use userSession in the Java plug-in to retrieve the vCenter Single Sign-On user credentials by using the samlTokenXml property.

The following additional features have been added since version 6.0:

The developed vSphere Web Client plug-in bundles are no longer deployed by using the Java Management Extensions (JMX) technology. Instead, the Web Client Extension Manager copies the bundles to the vsphere-client-sdk\server\pickup directory on each server start. If you use the Eclipse IDE with the FlexBuilder plug-in in your development environment, this change will not affect the way you deploy bundles to the Virgo server instance. If you use another way to deploy your plug-in bundles, be aware that the pickup directory is cleared on each server restart.

The following are known issues for the vSphere Web Client SDK 6.0 Update 1.

New Some of the samples provided in the vSphere Web Client SDK cannot be deployed
The manifest file of the vim25.jar library, which is located in the vsphere-client-sdk\libs SDK directory, is missing. As a result, the globalview and vsphere-wssdk plug-in examples fail to deploy.

Workaround: Replace the vim25.jar library in the vSphere Web Client SDK 6.0 Update 1 with the one provided with the vSphere Web Client SDK version 6.0.
The log files of the Virgo server are missing on Japanese OS installations

Workaround: To resolve this issue, you can try the following:
1. Open the vSphereWebClient\configuration\serviceability.xml file with a Hex editor.
2. Remove the first three invisible bytes (EF BB BF) and save the file.
3. Restart the vSphere Web Client Service.
When a menu or a dialog overlaps an HTML view, the view becomes blank
Log in to the vSphere Web Client by using Mozilla Firefox version 31.0 or earlier. When you open a menu or a dialog which overlaps an HTML view, the view is hidden temporary and is displayed as a blank pane. This issue has no functional impact and the view is restored once you close the menu or dialog.

Workaround: Use another supported browser or a more recent version of Mozilla Firefox.

The following issues are resolved for the vSphere Web Client SDK 6.0 Update 1 release:

If the target object was not previously displayed in another HTML view, the sendNavigationRequest API stops working.

This issue is resolved in this release.
When you open a Flex component which overlap an HTML view, the view becomes invisible
When you open a Flex component, such as a menu or dialog, which overlaps an HTML view, the view is temporary hidden.

Workaround: None.

This issue is resolved in this release.

The following APIs are marked as deprecated in vSphere Web Client SDK 6.0 Update 1.

com.vmware.vise.data.query.ResourceItem.currentGenerations
com.vmware.vise.core.model.IdentifiableGenerationNumber
WEB_PLATFORM.onGlobalRefreshRequest
This API is replaced with the WEB_PLATFORM.setGlobalRefreshHandler API to ensure that global refreshes work correctly in the HTML views. The onGlobalRefreshRequest API is still supported in this release but you must avoid using it to ensure that your plug-ins will run on future versions of the vSphere Web Client.