VMware vSphere SDKs and Tools 8.0

8.0 7.0 6.7 6.5

Custom Object Extension Points

When you instantiate a
objectViewTemplate
 for your custom object, the template creates a number of extension points that you can use to fill out the user interface for the object.
The extension points that are created for a custom object include some of the listed extension points in Object Workspace Extension Points. In addition, the
objectViewTemplate
 creates the following list of extension points at runtime for a particular namespace.
You can use the extension points to define views and tabs for the custom object workspace. If you want a specific view or tab to appear in the
vSphere Client
 user interface for a custom object, you must explicitly create an extension that references the extension point of the view or tab.
${namespace}.views
deprecated
Adds a top-level tab view for custom objects.
Requires a data object of type
ViewSpec
 with available properties:
  • name
     - user-visible name of the Getting Started view.
  • contentSpec
    • url
       - relative URL to the HTML page that loads the view content.
Accessibility: {custom object root}
Example: 
<extension id="com.vmware.samples.chassisa.MainView">
   <extendedPoint>com.vmware.samples.chassisa.views</extendedPoint>
   <object>
      <name>Chassis Main</name>
      <contentSpec>
         <url>/ui/chassisa/resources/chassis-main.html</url>
      </contentSpec>
   </object>
</extension>
${namespace}.summaryViews
deprecated
Adds a Summary tab view for custom objects.
Requires a data object of type
ViewSpec
 with available properties:
  • name
     - user-visible name of the global view.
  • icon
     - (optional) 18x18 portlet icon resource ID.
  • contentSpec
    • url
       - relative URL to the HTML page that loads the view content.
    • dialogTitle
      - portlet title.
    • dialogSize
      - portlet width and height.
Accessibility: {custom object root}
Example: 
<extension id="com.vmware.samples.chassisa.SummaryView">
   <extendedPoint>com.vmware.samples.chassisa.summaryViews</extendedPoint>
   <object>
      <name>Chassis Summary</name>
      <contentSpec>
         <url>/ui/chassisa/resources/chassis-summary.html</url>
      </contentSpec>
   </object>
</extension>
${namespace}.monitorViews
deprecated
Adds a sub-view to the Monitor tab view for custom objects.
Requires a data object of type
ViewSpec
 with available properties:
  • name
     - user-visible name of the Monitor view.
  • categoryUid
     - (optional) ID of the category this monitor view belongs to.
  • contentSpec
    • url
       - relative URL to the HTML page that loads the view content.
Accessibility: {custom object root} → Monitor page
Example: 
<extension id="com.vmware.samples.chassisa .monitor">
   <extendedPoint>com.vmware.samples.chassisa.monitorViews</extendedPoint>
   <object>
      <name>Monitor view</name>
      <categoryUid>com.vmware.samples.chassisa.monitor.category</categoryUid>
      <contentSpec>
         <url>/ui/vspherewssdk/resources/vm-monitor.html</url>
      </contentSpec>
   </object>
</extension>
${namespace}.manageViews
deprecated
Adds a sub-view to the Configure tab view for custom objects.
Requires a data object of type
ViewSpec
 with available properties:
  • name
     - user-visible name of the Configure view.
  • categoryUid
     - (optional) ID of the category this Configure view belongs to.
  • contentSpec
    • url
       - relative URL to the HTML page that loads the view content.
Accessibility: {custom object root} → Configure page
Example: 
<extension id="com.vmware.samples.chassisa.manage">
   <extendedPoint>com.vmware.samples.chassisa.manageViews</extendedPoint>
   <object>
      <name>Configure view</name>
      <categoryUid>com.vmware.samples.chassisa.manage.category</categoryUid>
      <contentSpec>
         <url>/ui/vspherewssdk/resources/vm-configure.html</url>
      </contentSpec>
</extension>
${namespace}.list.columns
deprecated
Creates a new column in the list of custom objects.
Requires a data object of type
com.vmware.ui.lists.ColumnSetContainer
 which is a collection of columns with available properties:
  • headerText
     - column header text.
  • requestedProperties
     - object properties whose value representation will be displayed in the column (commonly a 1-element array).
  • requestedParameters
     - parameters of the requested object properties.
  • sortProperty
     - enables column sorting by header selection.
  • exportProperty
     - enables exporting column data.
Only the XML representation is supported.
Accessibility: {custom object list}
Example: 
<extension id="com.vmware.samples.chassisa.list.sampleColumns">
   <extendedPoint>com.vmware.samples.chassisa.list.columns</extendedPoint>
   <object>
      <items>
         <com.vmware.ui.lists.ColumnContainer>
            <uid>com.vmware.samples.chassisa.column.name</uid>
            <dataInfo>
               <com.vmware.ui.lists.ColumnDataSourceInfo>
                  <headerText>Name</headerText>
                  <requestedProperties>
                     <String>name</String>
                  </requestedProperties>
                  <sortProperty>name</sortProperty>
                  <exportProperty>name</exportProperty>
               </com.vmware.ui.lists.ColumnDataSourceInfo>
            </dataInfo>
         </com.vmware.ui.lists.ColumnContainer>
         ...
      </items>
   </object>
</extension>
${namespace}.gettingStartedViews
deprecated
Adds a Getting Started tab view for custom objects.
Requires a data object of type
ViewSpec
 with available properties:
  • name
     - user-visible name of the Getting Started view.
  • categoryUid
     - (optional) ID of the category this Getting Started view belongs to.
  • contentSpec
     - parameters of the requested object properties.
    • url
       - relative URL to the HTML page that loads the view content.
Accessibility: {custom object root}
${namespace}.monitor.issuesViews
deprecated
Adds a sub-view under the Issues second-level tab of the Monitor tab view for custom objects.
Requires a data object of type
ViewSpec
.
Accessibility: {custom object root} → Monitor → Issues
${namespace}.monitor.performanceViews
deprecated
Adds a sub-view under the Performance second-level tab of the Monitor tab view for custom objects.
Requires a data object of type
ViewSpec
.
Accessibility: {custom object root} → Monitor → Performance
${namespace}.monitor.performance.overviewViews
deprecated
Adds a sub-view under the Performance/Overview section of the Monitor tab view for custom objects.
Requires a data object of type
ViewSpec
.
Accessibility: {custom object root} → Monitor → Performance → Overview
${namespace}.monitor.performance.advancedViews
deprecated
Adds a sub-view under the Performance/Advanced section of the Monitor tab view for custom objects.
Requires a data object of type
ViewSpec
.
Accessibility: {custom object root} → Monitor → Performance → Advanced
${namespace}.monitor.taskViews
deprecated
Adds a sub-view under the Tasks second-level tab of the Monitor tab view for custom objects.
Requires a data object of type
ViewSpec
.
Accessibility: {custom object root} → Monitor → Tasks
${namespace}.monitor.eventsViews
deprecated
Adds a sub-view under the Events second-level tab of the Monitor tab view for custom objects.
Requires a data object of type
ViewSpec
.
Accessibility: {custom object root} → Monitor → Events
${namespace}.manage.settingsViews
deprecated
Adds a sub-view under the Settings second-level tab of the Configure tab view for custom objects.
Requires a data object of type
ViewSpec
.
Accessibility: {custom object root} → Configure → Settings
${namespace}.manage.alarmDefinitionsViews
deprecated
Adds a sub-view under the Issues/Alarm Definitions section of the Configure tab view for custom objects.
Requires a data object of type
ViewSpec
.
Accessibility: {custom object root} → Configure → Alarm Definitions
${namespace}.manage.permissionsViews
deprecated
Adds a sub-view to the Permissions tab view for custom objects.
Requires a data object of type
ViewSpec
.
Accessibility: {custom object root} → Configure → Permissions

Content feedback and comments