vSphere Client Design Guidelines

Object Workspace Guidelines

Object details are presented in a workspace that includes Summary, Monitor, and Configure tabs. Related objects appear under the More Objects tab. 

Although we recommend that you create a workspace for a custom object type, shown below, you can also extend an existing object workspace.



Creating an Object Workspace

When adding a custom object to the vSphere Client environment you must:

  • Extend the main workspace to display an object workspace for that custom object
  • Extend the Navigator with your custom object list

Use the XML templates provided with the vSphere Client SDK as described in Creating an Object Workspace for a Custom Object.  These templates automatically create the default tab structure and the proper layout within in each tab.


Extending an Existing Object Workspace

When you extend an existing object workspace, the layout of your data depends on the tab where your extension appears. You can:

  • Add a portlet to the Summary tab
  • Add views to to the Monitor and Configure tabs

The extension points are described in Extending an Existing Object Workspace in the SDK documentation.



  • Understand the intent and layout of each tab.
    Ensure that you are putting the right data in the right place.

  • Don't add a tab at the top-level of the object workspace. 
    Use the defined extension points in the Summary, Monitor, and Configure tabs.

  • Show your object details directly in the object workspace.
    Don't require users to open a modal or other pop-up to view the information.

  • Don't allow editing in the object workspace.
    This requirement is to prevent users from accidentally changing a value. Enable editing in a modal.