State Views
Applies To: System Center Operations Manager 2007
Note
This topic has been updated in the latest version of the System Center Management Pack Authoring Guide on the TechNet Wiki.
State views provide a tabular listing of a set of instances of a particular class. Columns in the view can include the state of the object, the value of properties of the object, or the health state of objects that the target object hosts or contains.
Contents
The following properties determine the contents of a State view.
Target
All State views must specify a target class. The target class specified for a State view determines which objects are displayed and what properties are available. All instances of the target class in the management group are included unless criteria or a group is specified to limit the instances that are displayed.
Group
A State view does not require a group. If a group is specified, only instances of the target class in the group are included. Even though the group might contain objects of different classes, only instances of the target class are displayed.
Note
If the Entity class is used for the target class, all objects in the group are included in the view. This is because all classes inherit from the Entity class.
Criteria
A State view does not require criteria. If it is provided, criteria allows for the instances of the target class to be limited according to the values of one or more properties. To add and configure criteria , start the external editor from the Authoring console or modify the settings in the dialog box in the Operations console. The properties that you can use in criteria are provided in the following table.
Note
You can only set criteria if the target class is not abstract. An abstract class can be the target class of a State view, but you cannot use criteria.
| Condition | Description | Example |
|---|---|---|
Severity |
One or more health states matching the current health state of the object. Valid values are as follows:
|
|
InMaintenanceMode |
Specifies whether the object is currently in maintenance mode. Valid values are true and false. |
|
PropertyCriteria |
Value of one or more properties of the targeted class. The value can include a wildcard. |
|
Columns
Each column in a State view is defined in a ColumnInfo node under the Presentation node of the view. The following XML sample shows a column definition.
<ColumnInfo Index="0" SortIndex="-1" Width="100" Grouped="false" Sorted="false" IsSortable="true" Visible="true" SortOrder="Descending">
<Name>State</Name>
<Id>MyMP.MyClass</Id>
</ColumnInfo>
The content of each column is determined by its Id value with the title of the column defined by the Name value. The possible contents of a State view are identified in the following table.
| Name | ID | Description |
|---|---|---|
State |
ID of the target class |
Current state of the target object |
Maintenance Mode |
InMaintenanceMode |
Icon indicating whether the object is currently in maintenance mode |
Property value |
Name of the property |
Value for any property of the target object |
Name of hosted class |
ID of a class that the target class hosts or contains |
Current state of any objects that the target object hosts or contains |
When a State view is created in the Authoring console, no columns are defined. If the management pack is installed without column definitions, the following columns are displayed with default settings:
State of the object
Current maintenance mode setting
Display name
Path name
The state of each class that the target class hosts or contains is available to the view but is not visible.
After the view is installed, you can modify the settings in the Properties dialog box for the view in the Operations console. If any modification occurs, the Operations console adds the entire set of column definitions to the view. You can load the set of column definitions into the Authoring console for detailed configuration.
Formatting
To format a State view, modify the attributes of each column definition. You can do this the external editor from the Authoring console or with by modify the settings in the Properties dialog box for the view in the Operations console. The following table lists the different characteristics of each column and their corresponding attributes.
| Characteristic | Description |
|---|---|
Column Order |
The order of how the columns are positioned can be specified with the Index attribute for the column. You can also do this using the Display tab in the Properties dialog box for the view in the Operations console. |
Column Width |
Each column has a Width attribute defining the width of the column in pixels. The column width in the dialog box is used the first time that you open the Operations console. If you change the width in the Operations console, the new settings are saved on the local workstation. There is no guarantee that the column width in the management pack is retained on any workstation. |
Column Visibility |
Each column has a Visible attribute that defines whether the column is visible in the Operations console. If you do not want to display a column, still include it in the view with the Visible attribute set to false. If the column is not included in the view, it is not available as an option for the user to add it to the view in the Operations console. For this reason, all columns are typically included in the view with the visibility of the columns that you do not want to display set to false. |
Sorting |
The objects listed in a State view can be sorted by any of the included columns. The sorting configuration in the dialog box is used the first time that you open the Operations console. If you change the sort order in the Operations console, the new settings are saved on the local workstation. There is no guarantee that the sort order in the management pack is retained on any workstation. The dialog box in the Operations console enables the view to be sorted by a single column. You can sort multiple columns by modifying the XML attributes of the view. Change the value of the Sorted attribute of the column entry to true. The SortIndex attribute defines the order in which the columns are sorted, and its value must be changed to a value of 0 or greater. The SortOrder attribute must be either Ascending or Descending depending on which sort order for the column you want. |
Grouping |
You cannot group columns in a State view. |