You use the Environment Overview widget configuration options to customize each instance of the widget that you add to your dashboards.

How the Environment Overview Widget Configuration Options Work

To use the Environment Overview widget, you must add it to the dashboard and configure the data that appears in the widget. You must select at least one badge and an object. Additionally, you can select an object type.

The Environment Overview widget has basic and advanced configuration options. The basic configuration options are enabled by default.

To use all features of the Environment Overview widget, you must change the default configuration of the widget. Log in to the vRealize Operations Manager machine and set skittlesCustomMetricAllowed to true in the web.properties file. The web.properties file is located in the /usr/lib/vmware-vcops/user/conf/web folder. The change is propagated after you use the service vmware-vcops-web restart command to restart the UI.

You must use the Badge tab to select the badge parameters that the widget shows for each object. You must use the Config tab to select an object or object type. To observe a concrete object from the inventory, you can use the Basic option. To observe a group of objects or objects from different types, you must use the Advanced option.

Where You Find Environment Overview Widget Configuration Options

To customize the data that appears in the dashboard widget, click Content in the left pane, and click Dashboards. On the Dashboards toolbar, click the plus sign to add a dashboard or the pencil to edit the selected dashboard. In the Dashboard workspace, on the left, click Widget List, and drag a widget to the right pane of the dashboard. On the title bar of the selected widget, click the pencil to access the configuration options.

You edit an environment overview widget after you add it to a dashboard.

To access the configuration options, locate the Environment Overview widget on the dashboard, and click the pencil at the right corner of the widget.

Table 1. Environment Overview Widget Configuration Options

Option

Description

Title

Enter a custom title that identifies this widget from other instances that are based on the same widget template.

Selected Object

Object that is the basis for the widget data.

To populate the text box, select Config > Basic and select an object from the list.

Refresh Content

Enable or disable the automatic refreshing of the data in this widget.

If not enabled, the widget is updated only when the dashboard is opened or when you click the Refresh button on the widget in the dashboard.

Self Provider

Indicates whether the objects for which data appears in the widget are defined in the widget or provided by another widget.

  • On. You define the objects for which data appears in the widget.

  • Off. You configure other widgets to provide the objects to the widget using the dashboard widget interactions options.

Refresh Interval

If you enable the Refresh Content option, specify how often to refresh the data in this widget .

Badge

Defines a parameter to observe. You can select or deselect Health, Risk, and Efficiency parameters using check boxes. Default configuration of the widget selects all badges.

Select at least one badge parameter.

Custom Label shows the custom name of a badge. You can use Custom Label to rename a badge. To rename a badge, double-click the badge and enter a name in a text box. To save the custom name, click Update.

Custom Label is available only when custom metrics and badge customization are enabled.

Config

Basic

List of objects in your environment that you can search or sort by column so that you can locate the object on which you are basing the data that appears in the widget.

If you select an object in the list, the object becomes the selected object for the widget.

Advanced

You can use Object Types to select a type of the objects to observe information about health, risk, and efficiency. Double-click the object type to select it.

Use the Adapter Type drop-down menu to filter the objects types based on an adapter.

You can use the Use vSphere Default button to observe the main vSphere object types.

To remove an object type from the list, click Remove Selected next to Use vSphere Default.

You can use the Object Type Categories menu to select a group or groups of object types to observe.

You can use the Object tree to select an object to filter the displayed objects. For example, to observe a datastore of a VM, double-click Datastore from the Object Types menu to select it. Click the datastore when it is in the list of object types, and find the VM in the object tree and select it. To return to your previous configuration of the widget, click Datastore from the list of object types and click Deselect All in the object tree window.

The metrics tree and badge data grids are available configuration options only if the default configuration of the widget is changed. To use these configuration options, log in to the vRealize Operations Manager machine and set skittlesCustomMetricAllowed to true in the web.properties file. The web.properties file is located in the /usr/lib/vmware-vcops/user/conf/web folder.

The badge data grid shows custom badges and enables you to customize a badge for a custom metric. You can select a metric from the metrics tree and set the color of the badge.

The Badge column contains the badge icons.

The Metric column contains a custom metric that you can select from the metric tree.

You can use Box Label text box to define a label of a badge. The tool tip description of a badge and tool tip of each object with this badge use the badge label.

You can use Measurement Unit text box to define a measurement unit that is used in a tool tip description of each object.

You can use Yellow Bound text box to define a value for which the badge is yellow.

You can use Orange Bound text box to define a value for which the badge is orange.

You can use Red Bound to define a value for which the badge is red.

For example, if you want to observe the availability of a virtual machine and use the Health badge, you must select virtual machine as an object type, select the Health badge icon, search for availability in the metrics tree, and double-click it. You must define a meaningful label name and measurement unit to help you when observe the objects. You must specify different values for each color, for example -1 for yellow, 0 for orange, and 1 for red.

You can use the metrics tree to select a metric that is specific for each object type. You can click Select Object to select specific metrics for an object. Select Object takes you to the object list data grid. The object list data grid displays all available objects in the environment and details about them.