Performance Parameters
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 following parameters are used in Performance reports in Operations Manager 2007 to set the contents and configuration of performance charts.
AggregationType
The AggregationType parameter specifies how to aggregate the data on the X-axis of the performance chart. Allowed values for this parameter are provided in the following table.
| Value | Description |
|---|---|
0 |
None |
1 |
Daily |
2 |
Weekly |
3 |
Monthly |
4 |
Yearly |
Use the Microsoft.SystemCenter.DataWarehouse.Report.ParameterPrompt.Histogram prompt to populate a ComboBox control with the possible values for the AggregationType parameter.
DataAggregation
The DataAggregation parameter specifies how to aggregate the data included in the performance chart. Allowed values for this parameter are provided in the following table.
| Value | Description |
|---|---|
0 |
Hourly |
1 |
Daily |
Use the prompt Microsoft.SystemCenter.DataWarehouse.Report.Library!Microsoft.SystemCenter.DataWarehouse.Report.ParameterPrompt.DataAggregation to populate a Combo Box control with the list of sources currently in the data warehouse.
Enable3D
The Enable3D parameter specifies whether the chart should be displayed in 3D or not. It can have a value of True or False.
Use the Microsoft.SystemCenter.DataWarehouse.Report.ParameterPrompt.Chart3D prompt to populate a Boolean Picker control with the valid values for the Enable3D parameter.
ObjectList
In performance reports, the ObjectList parameter contains XML code defining the configuration of the charts and series included in the report. The following table describes the elements that may be included in this parameter.
| Property | Description | Allowed Values |
|---|---|---|
Object |
ID for the object in the data warehouse. This ID is typically not known and is provided by the user who has the Performance Object Picker control. More than one Object element can be used if the series should contain data from more than one target object. The element includes an attribute called Use that defines whether the object is used or whether the object and all its contained objects are used. |
The ID of an object in the data warehouse. The Use attribute may have the value Self or Containment. |
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 it to be transferred between management packs. |
The GUID of the rule. If the parameter is populated from a control when the report is run, it will be the actual GUID of the rule. If a value is provided in the linked report, 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 kind of graph |
One of the following values
|
Color |
Three numeric values that indicate the color of the line. |
The allowed values are shown in the following table. |
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 |
Each chart is defined by a Values element and 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.
<Data>
<Values>
<Value>
<Object Use="Containment">2</Object>
<Rule>$MPElement[Name="MyMP.MyApp.MyCollectionRule1"]$</Rule>
<Color>63,63,255</Color>
<Type>Line</Type>
<Scale>1</Scale>
</Value>
<Value>
<Object Use="Self">5</Object>
<Object Use="Self">2</Object>
<Rule>$MPElement[Name="MyMP.MyApp.MyCollectionRule2"]$</Rule>
<Color>0,159,0</Color>
<Type>Line</Type>
<Scale>.01</Scale>
</Value>
</Values>
<Values>
<Value>
<Object Use="Self">2</Object>
<Rule>$MPElement[Name="MyMP.MyApp.MyCollectionRule3"]$</Rule>
<Color>255,127,63</Color>
<Type>Line</Type>
<Scale>100</Scale>
</Value>
</Values>
</Data>
RuleId
The RuleId parameter specifies the ID of a collection rule for performance reports that display the top objects or instances for a particular rule. If this parameter is collected by a control when you run the report, this is the actual GUID of the rule. If a specific rule is specified in the linked report, an $MPElement variable for the rule should be used.
Use the Microsoft.SystemCenter.DataWarehouse.Report.Library!Microsoft.SystemCenter.DataWarehouse.Report.ParameterPrompt.PerformanceRule prompt to populate a Performance Rule Picker or Performance Rule Instance Picker control with a list of rule IDs currently in the data warehouse.
RuleInstance
The RuleInstance parameter specifies the name of one or more instances to include in a performance object report.
SortOrder
The SortOrder parameter specifies whether to sort from the top or bottom in a top instances or top object performance report. Allowed values for this parameter are provided in the following table.
| Value | Description |
|---|---|
-1 |
Top |
1 |
Bottom |
Use the prompt Microsoft.SystemCenter.DataWarehouse.Report.Library!Microsoft.SystemCenter.DataWarehouse.Report.ParameterPrompt.TopAlgorithmParameter to populate a Combo Box control with the allowed values for the SortOrder parameter.
TopCount
The TopCount parameter specifies how many instances or objects to include in a performance report.
Use the prompt Microsoft.SystemCenter.DataWarehouse.Report.Library!Microsoft.SystemCenter.DataWarehouse.Report.ParameterPrompt.TopAlgorithm to populate a Combo Box control with the allowed values for the TopCount parameter.