Performance 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 to populate parameters for performance reports in Operations Manager 2007.

Performance Chart Object Picker

The ID of the Performance Chart Object Picker is Microsoft.SystemCenter.DataWarehouse.Report.ParameterControl. PerformanceChartObjectPicker. This control lets you select the details of the charts and series that will be include in the report. It will populate the ObjectList parameter as described in the Performance Parameters section of this document and the ManagementGroupId parameter described in Common Parameters.

Using this control, you must select which objects and which collection rules are included in the data when the report is run. Most linked reports will not use this control because linked performance reports will typically define the collection rules being used so that the user does not have to perform this selection. Using this control, the linked report would not vary significantly from the generic report. Linked reports will typically use the Linked Performance Chart Object Picker control instead which gives users just the objects to be selected, while the graph configuration is provided in a property of the control.

Example

The following is an example of the XML code for a Performance Chart Object Picker control. If the control is used in a linked report, this code would typically be used without change.

<Control type="Microsoft.SystemCenter.DataWarehouse.Report.ParameterControl.PerformanceChartObjectPicker" columnSpan="4" rowSpan="3">
   <ReportParameters>
      <ReportParameter name="ObjectList">
         <Prompt>Microsoft.SystemCenter.DataWarehouse.Report.Library!Microsoft.SystemCenter.DataWarehouse.Report.ParameterPrompt.ObjectList</Prompt>
      </ReportParameter>
      <ReportParameter name="ManagementGroupId" binding="GroupList" />
   </ReportParameters>
</Control>

Linked Performance Chart Object Picker

The ID of the Linked Performance Chart Object Picker is Microsoft.SystemCenter.DataWarehouse.Report.ParameterControl.LinkedPerformanceChartObjectPicker. This control allows you to select the Object elements for the ObjectList parameter. The other elements for this parameter are expected to be set by the report and not changed by the user.

This control is used only in linked reports where the performance rules and graph configuration are predefined and the user is required to only select the specific objects to include in the report. The control resembles the Monitoring Object XML Picker control but includes no interface for graph configuration. The control has the following properties to provide the configuration for the graph.

Properties

The Linked Performance Chart Object Picker control uses the same properties as the Object XML Picker control to filter available objects in addition to a property to specify the configuration of the graph. The following table lists the properties that can be defined on the Linked Performance Chart Object Picker control.

Property Description Allowed Values

TypeFilter

ID of the class to limit searches

String with the ID of any class

ContextObjectBinding

Specifies whether the report will contain data from the selected

Self

Containment

ValueTemplate

Defines the configuration of each series included in the chart

XML code described later.

ValueTemplate Property

The ValueTemplate property contains XML code defining the configuration of the charts and series included in the report. This XML code resembles the code for the ObjectList parameter that is used by performance reports. The following table describes the elements that may be included in this parameter.

Property Description Allowed Values

Chart

Defines a chart in the report. Includes an attribute called ObjectJoin that specifies the behavior of the report if multiple objects are selected.

This element has no data. Each Chart element specifies a separate chart. The allowed values for the ObjectJoin attribute are provided later.

Rule

The rule that collects the data to include in the series. This should be an $MPElement variable instead of a GUID to allow for the rule to be transferred between management packs.

The GUID of the rule. If the parameter is populated from a control when the report is run, then it will be the actual GUID of the rule. If a value is provided in the linked report, then an $MPElement variable is typically used such as $MPElement[Name="MyMP.MyApp.MyCollectionRule"]$.

Scale

Multiplier to use against the value.

An integer value. For example, to use the collected value, you would set this parameter to 1. To multiply the collected value by 100, you would set this parameter to 100. To divide the collected value by 1,000, you would set this parameter to .001.

Type

The type of graph

One of the following values

  • Area

  • Column

  • Line

  • Point

  • Spline

  • SplineArea

  • StepLine

Color

Three numeric values that indicate the color of the line.

The allowed values are shown in the table that follows.

The ObjectJoin attribute of the Chart attribute specifies the behavior of the report if multiple objects are selected. The allowed values are listed in the following table.

Value Description

ChartPerObject

A separate chart is created for each object.

AverageAll

A single chart is displayed with the average of the value from all objects.

The values for common values for the Color element are listed in the following table.

Color Value

Light Blue

63,63,255

Dark Green

0,159,0

Light Red

255,31,31

Yellow

255,221,0

Black

0,0,0

Dark Blue

31,31,159

Light Green

63,255,63

Orange

255,127,63

Light Gray-Blue

191,191,255

Brown

191,111,47

Example

Each chart is defined by a Charts element while each series in the chart is defined by a Value element. The following XML code shows an example of a report that has two charts. The first chart has two series, and the second chart has a single series.

<Control type="Microsoft.SystemCenter.DataWarehouse.Report.ParameterControl.LinkedPerformanceChartObjectPicker" columnSpan="4" rowSpan="3">
   <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="ValueTemplate">
         <Value><![CDATA[
            <Data>
               <Chart ObjectJoin="ChartPerObject">
                  <Series>
                     <Rule>$MPElement[Name="MyApp.MyCollectionRule1"]$</Rule>
                     <Scale>1</Scale>
                     <Type>Line</Type>
                     <Color>63,63,255</Color>
                  </Series>
                  <Series>
                     <Rule>$MPElement[Name=" MyApp.MyCollectionRule2"]$</Rule>
                     <Scale>1</Scale>
                     <Type>Line</Type>
                     <Color>0,159,0</Color>
                  </Series>
               </Chart>
            </Data>
         ]]></Value>
      </Property>
      <Property name="ContextObjectBinding">
         <Value>Containment</Value>
      </Property>
      <Property name="TypeFilter">
         <Value>MyApp.MyComputerRole1</Value>
      </Property>
   </Properties>
</Control>

Performance Rule Picker

The ID of the Performance Rule Picker is Microsoft.SystemCenter.DataWarehouse.Report.ParameterControl.PerformanceRulePicker. This control lets you select the rule to include in a top instance performance report. It will populate the RuleID parameter as described in the Performance Parameters section of this document and the ManagementGroupId parameter described in Common Parameters.

Example

The following is an example of the XML code for a Performance Chart Object Picker control. If the control is used in a linked report, this code would typically be used without change.

<Control type="Microsoft.SystemCenter.DataWarehouse.Report.ParameterControl.PerformanceRulePicker" columnSpan="3">
   <ReportParameters>
      <ReportParameter name="RuleId">
         <Prompt>Microsoft.SystemCenter.DataWarehouse.Report.Library!Microsoft.SystemCenter.DataWarehouse.Report.ParameterPrompt.PerformanceRule</Prompt>
      </ReportParameter>
      <ReportParameter name="ManagementGroupId" binding="GroupList" />
   </ReportParameters>
</Control>

Performance Rule Instance Picker

The ID of the Performance Rule Picker is Microsoft.SystemCenter.DataWarehouse.Report.ParameterControl.PerformanceRuleInstancePicker. This control lets you select the rule and one or more instances to include in a top object performance report. It will populate the RuleID and RuleInstance parameters as described in the Performance Parameters section of this document and the ManagementGroupId parameter described in Common Parameters.

Example

The following is an example of the XML code for a Performance Chart Object Picker control. If the control is used in a linked report, this code would typically be used without change.

<Control type="Microsoft.SystemCenter.DataWarehouse.Report.ParameterControl.PerformanceRuleInstancePicker" columnSpan="2" rowSpan="3">
   <ReportParameters>
      <ReportParameter name="RuleId">
   <Prompt>Microsoft.SystemCenter.DataWarehouse.Report.Library!Microsoft.SystemCenter.DataWarehouse.Report.ParameterPrompt.PerformanceRule</Prompt>
      </ReportParameter>
      <ReportParameter name="ManagementGroupId" binding="GroupList" />
      <ReportParameter name="RuleInstance" binding="InstanceList" />
   </ReportParameters>
</Control>

See Also

Concepts

Performance Parameters
Performance Reports