Share via

Common Report Controls

  • Article

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.

The controls in this section are used in various reports in Operations Manager 2007 to populate different kinds of parameters.

Boolean Picker

The ID of the Boolean Picker control is Microsoft.SystemCenter.DataWarehouse.Report.ParameterControl.BooleanPicker. This control provides a drop-down box that prompts for parameters that require a single value of true or false.

Example

The following XML code shows an example of the Boolean Picker control to populate the Enable3D parameter in a performance report.

<Control type="Microsoft.SystemCenter.DataWarehouse.Report.ParameterControl.BooleanPicker">
   <ReportParameters>
      <ReportParameter name="Enable3D">
         <Prompt>Microsoft.SystemCenter.DataWarehouse.Report.Library!Microsoft.SystemCenter.DataWarehouse.Report.ParameterPrompt.Chart3D</Prompt>
      </ReportParameter>
   </ReportParameters>
</Control>

Checked List Box

The ID of the Checked List Box control is Microsoft.SystemCenter.DataWarehouse.Report.ParameterControl.CheckedListBox. This control provides a set of check boxes where you can select one or more values. The box includes friendly text that represents the value instead of displaying the value itself.

Example

The following is an example of the XML code for a Checked List Box control populating the AlertSeverity parameter in an Alert Detail report. This uses a prompt to populate the list with the possible severities.

<Control type="Microsoft.SystemCenter.DataWarehouse.Report.ParameterControl.CheckedListBox" rowSpan="1" columnSpan="1">
   <ReportParameters>
      <ReportParameter name="AlertSeverity">
         <Prompt>Microsoft.SystemCenter.DataWarehouse.Report.Library!Microsoft.SystemCenter.DataWarehouse.Report.ParameterPrompt.AlertSeverity</Prompt>
      </ReportParameter>
   </ReportParameters>
</Control>

Combo Box

The ID of the Combo Box control is Microsoft.SystemCenter.DataWarehouse.Report.ParameterControl.ComboBox. This control provides a drop-down box where you can select one of multiple possible values for a parameter. The box includes friendly text that represents the value instead of displaying the value itself.

Example

The following is an example of the XML code for a Combo Box control populating the DataAggregation parameter in an Availability report. This uses a prompt to populate the combo box that has possible aggregation settings.

<Control type="Microsoft.SystemCenter.DataWarehouse.Report.ParameterControl.ComboBox">
   <ReportParameters>
      <ReportParameter name="DataAggregation">
         <Prompt>Microsoft.SystemCenter.DataWarehouse.Report.Library!Microsoft.SystemCenter.DataWarehouse.Report.ParameterPrompt.DataAggregation</Prompt>
         </ReportParameter>
      </ReportParameters>
</Control>

Object XML Picker

The ID of the Object XML Picker control is Microsoft.SystemCenter.DataWarehouse.Report.ParameterControl.MonitoringObjectXmlPicker. This control lets you select the objects that will be included in the report. It will populate the ObjectList parameter which most generic reports use. The data that is created by this control includes an ID for each object. The ID for an object is unique for each data warehouse and is not immediately available to hardcode in a parameter of the linked report. Therefore, this control is typically not removed from a linked report.

For performance reports, the Linked Performance Chart Object Picker control is typically used to populate the ObjectList parameter. This is discussed in the Performance Report Controls section of this guide.

Filtering Objects

A common source of frustration for users when they run a report is selecting appropriate objects. If they select an instance of the wrong class, the report will typically return no data, and the correct class to use may not be obvious. You can use a filter on the Object XML Picker to ease this frustration. This limits any searches to only instances of a class valid for the report.

The filter is set by the two properties of the Object XML Picker control in the following table.

Property Name Description Allowed Values

TypeFilter

ID of the class to limit searches

String with the ID of any class

ContextObjectBinding

Specifies whether just the selected object is used as the target of the report or all objects hosted or contained by the target are used

One of the following values:

  • Self

  • Containment

For example, the Microsoft SQL Server 2008 (Monitoring) management pack includes a report named SQL Server Configuration. This report is only intended to use instances of the SQL Server 2008 DB Engine the XML code shown here is used in the report to set the filter. This ensures that only instances of the class SQL Server 2008 DB Engine are returned.

<Property name="ContextObjectBinding">
   <Value>Containment</Value>
</Property>
<Property name="TypeFilter">
   <Value>Microsoft.SQLServer.2008.DBEngine</Value>
</Property>

Example

The XML code that is shown here shows an example of the Object XML Picker control that uses a filter for a custom class.

<Control columnSpan="2" rowSpan="2" type="Microsoft.SystemCenter.DataWarehouse.Report.ParameterControl.MonitoringObjectXmlPicker">
   <ReportParameters>
      <ReportParameter name="ObjectList">
         <Prompt>Microsoft.SystemCenter.DataWarehouse.Report.Library!Microsoft.SystemCenter.DataWarehouse.Report.ParameterPrompt.ObjectList</Prompt>
      </ReportParameter>
      <ReportParameter name="ManagementGroupId" binding="GroupList" />
   </ReportParameters>
   <Properties>
      <Property name="ContextObjectBinding">
         <Value>Containment</Value>
      </Property>
      <Property name="TypeFilter">
         <Value>MyMP.MyComputerRole1</Value>
      </Property>
   </Properties>
</Control>

Numeric Up Down

The ID of the Numeric Up Down control is Microsoft.SystemCenter.DataWarehouse.Report.ParameterControl.NumericUpDown. This control accepts a single numeric value. It provides arrows to increment the value up and down with a mouse click.

The Numeric Up Down control has two properties called minimum and maximum. These properties set the minimum and maximum value that the control will allow. This lets you specify the range of values that will be valid for the property.

Example

The following is an example of the XML code that uses the minimum and maximum properties to limit the range of the value collected by a numeric up down control to be between 1 and 100. This is from a Performance Top Instances report setting the number of instances to include in the report.

<Control type="Microsoft.SystemCenter.DataWarehouse.Report.ParameterControl.NumericUpDown">
   <ReportParameters>
      <ReportParameter name="TopCount">
         <Prompt>Microsoft.SystemCenter.DataWarehouse.Report.Library!Microsoft.SystemCenter.DataWarehouse.Report.ParameterPrompt.TopAlgorithmParameter</Prompt>
      </ReportParameter>
   </ReportParameters>
   <Properties>
      <Property name="Minimum">
         <Value>1</Value>
      </Property>
      <Property name="Maximum">
         <Value>100</Value>
      </Property>
   </Properties>
</Control>

See Also

Concepts

Common Parameters
Report Parameters