Appendix B - Parameter Values and Parameter Controls
Applies To: Operations Manager 2007 R2, Operations Manager 2007 SP1
This appendix provides information about specific parameter values and parameter controls that can be used when creating linked reports.
Parameter Values
DateTime
Parameters: StartDate_BaseType,EndDate_BaseType
BaseType Values:
Fixed
Today
Monday
Tuesday
Wednesday
Thursday
Friday
Saturday
Sunday
FirstDayMonth
LastDayMonth
FirstDayQuarter
LastDayQuarter
FirstDayYear
LastDayYear
Parameters: StartDate_OffsetType, EndDate_OffsetType
OffsetType Values:
None
Day
Week
Month
Quarter
Year
Example:
<Parameter Name="StartDate_BaseType">
<Value>Friday</Value>
</Parameter>
<Parameter Name="StartDate_OffsetType">
<Value>Week</Value>
</Parameter>
<Parameter Name="StartDate_OffsetValue">
<Value>-1</Value>
</Parameter>
<Parameter Name="EndDate_BaseType">
<Value>Today</Value>
</Parameter>
<Parameter Name="EndDate_OffsetType">
<Value>None</Value>
</Parameter>
<Parameter Name="EndDate_OffsetValue">
<Value>0</Value>
</Parameter>
Aggregation Parameter
Daily |
1 |
Hourly |
0 |
Downtime Parameter
Warning |
2 |
Planned Maintenance |
6 |
Unplanned Maintenance |
5 |
Monitor disabled |
4 |
Unmonitored |
3 |
Threshold
1 second(s) |
1 |
2 second(s) |
2 |
5 second(s) |
5 |
10 second(s) |
10 |
15 second(s) |
15 |
30 second(s) |
30 |
1 minute(s) |
60 |
2 minute(s) |
120 |
5 minute(s) |
300 |
10 minute(s) |
600 |
15 minute(s) |
900 |
30 minute(s) |
1800 |
Chart Scale
Hourly |
0 |
Daily |
1 |
Monthly |
2 |
Severity
Information |
0 |
Warning |
1 |
Critical |
2 |
Priority
0 |
0 |
1 |
1 |
2 |
2 |
Criteria
Defined In |
0 |
Applied To |
1 |
Exclude Sealed MP
Boolean
Histogram
No |
0 |
Daily |
1 |
Weekly |
2 |
Monthly |
3 |
3D Chart
Boolean
Objects
Example:
<Data>
<Values Title="Test">
<Value>
<Object Use="Containment">9</Object>
<Rule>7c512fe8-a3c4-1049-9891-88b259cb5f47</Rule>
<Color>63,63,255</Color>
<Type>Line</Type>
<Scale>1</Scale>
</Value>
<Value>
<Object Use="Self">9</Object>
<Rule>406fc269-8b85-b13a-9079-86dd1df5831b</Rule>
<Color>0,159,0</Color>
<Type>Line</Type>
<Scale>1</Scale>
</Value>
</Values>
</Data>
Where
<Object>–Object Row Id
<Rule>–Rule GUID
<Color>–In the format of R,G,B.
<Type>–One of: Area, Column, Line, Point, Spline, SplineArea, or StepLine.
<Scale>–Double
Report Parameter Controls
The most commonly used report parameter controls in custom reports are as follows:
Microsoft.SystemCenter.DataWarehouse.Report.ParameterControl.CheckedListBox
Description: A way to select multiple values from a list of valid ones. Replaces standard SSRS multi-value value picker.
Properties:
Bindings
Default (report parameter has to be a multi-value parameter with a list of valid values)
Sample:
<LinkedReport>
<ParameterBlock>
<Controls>
<Control type="Microsoft.SystemCenter.DataWarehouse.Report.ParameterControl.CheckedListBox" rowSpan="1" columnSpan="1">
<ReportParameters>
<ReportParameter name="Severity"/>
</ReportParameters>
</Control>
</Controls>
</ParameterBlock>
<Parameters>
<Parameter Name="Severity">
<Value>0,1,2</Value>
</Parameter>
</Parameters>
</LinkedReport>
Microsoft.SystemCenter.DataWarehouse.Report.ParameterControl.ComboBox
Description: A way to select a value from a set. Replaces standard SSRS value picker control.
Properties:
Bindings
Default (report parameter has to have a list of valid values)
Sample:
<LinkedReport>
<ParameterBlock>
<Controls>
<Control type="Microsoft.SystemCenter.DataWarehouse.Report.ParameterControl.ComboBox" rowSpan="1" columnSpan="1">
<ReportParameters>
<ReportParameter name="AggregationType"/>
</ReportParameters>
</Control>
</Controls>
</ParameterBlock>
<Parameters>
<Parameter Name="AggregationType">
<Value>3,4</Value>
</Parameter>
</Parameters>
</LinkedReport>
Microsoft.SystemCenter.DataWarehouse.Report.ParameterControl.BooleanPicker
Description: A way to enter parameter value of Boolean type. Replaces standard SSRS Boolean picker
Properties:
Bindings
Default (report parameter has to be Boolean type)
Sample:
<LinkedReport>
<ParameterBlock>
<Controls>
<Control type="Microsoft.SystemCenter.DataWarehouse.Report.ParameterControl.BooleanPicker" rowSpan="2" columnSpan="2">
<ReportParameters>
<ReportParameter name="Enable3D"/>
</ReportParameters>
</Control>
</Controls>
</ParameterBlock>
</LinkedReport>
Microsoft.SystemCenter.DataWarehouse.Report.ParameterControl.DatePicker
Description: A way to select date value. Replaces standard SSRS date picker control.
Properties:
Bindings
Default (report parameter has to be DateTime type)
Sample:
<LinkedReport>
<ParameterBlock>
<Controls>
<Control type="Microsoft.SystemCenter.DataWarehouse.Report.ParameterControl.DatePicker" rowSpan="2" columnSpan="2">
<ReportParameters>
<ReportParameter name="StartDate_BaseType" binding="StartDate_BaseType" />
<ReportParameter name="StartDate_BaseValue" binding="StartDate_BaseValue"> <Prompt>Microsoft.SystemCenter.DataWarehouse.Report.Library!Microsoft.SystemCenter.DataWarehouse.Report.ParameterPrompt.StartDateTime</Prompt>
</ReportParameter>
<ReportParameter name="StartDate_OffsetType" binding="StartDate_OffsetType" />
<ReportParameter name="StartDate_OffsetValue" binding="StartDate_OffsetValue" />
<ReportParameter name="EndDate_BaseType" binding="EndDate_BaseType" />
<ReportParameter name="EndDate_BaseValue" binding="EndDate_BaseValue">
<Prompt>Microsoft.SystemCenter.DataWarehouse.Report.Library!Microsoft.SystemCenter.DataWarehouse.Report.ParameterPrompt.EndDateTime</Prompt>
</ReportParameter>
<ReportParameter name="EndDate_OffsetType" binding="EndDate_OffsetType" />
<ReportParameter name="EndDate_OffsetValue" binding="EndDate_OffsetValue" />
</ReportParameters>
</Control>
</Controls>
</ParameterBlock>
</LinkedReport>
Microsoft.SystemCenter.DataWarehouse.Report.ParameterControl.DateTimePicker
Description: A way to select date and time value.
Properties:
Bindings
Default (report parameter has to be DateTime type)
Sample:
<LinkedReport>
<ParameterBlock>
<Controls>
<Control type="Microsoft.SystemCenter.DataWarehouse.Report.ParameterControl.DateTimePicker" rowSpan="2" columnSpan="2">
<ReportParameters>
<ReportParameter name="TimeZone" binding="TimeZone" />
<ReportParameter name="TimeZoneName" binding="TimeZoneName" />
<ReportParameter name="StartDate_BaseType" binding="StartDate_BaseType" />
<ReportParameter name="StartDate_BaseValue" binding="StartDate_BaseValue">
<Prompt>Microsoft.SystemCenter.DataWarehouse.Report.Library!Microsoft.SystemCenter.DataWarehouse.Report.ParameterPrompt.StartDateTime</Prompt>
</ReportParameter>
<ReportParameter name="StartDate_OffsetType" binding="StartDate_OffsetType" />
<ReportParameter name="StartDate_OffsetValue" binding="StartDate_OffsetValue" />
<ReportParameter name="EndDate_BaseType" binding="EndDate_BaseType" />
<ReportParameter name="EndDate_BaseValue" binding="EndDate_BaseValue">
<Prompt>Microsoft.SystemCenter.DataWarehouse.Report.Library!Microsoft.SystemCenter.DataWarehouse.Report.ParameterPrompt.EndDateTime</Prompt>
</ReportParameter>
<ReportParameter name="EndDate_OffsetType" binding="EndDate_OffsetType" />
<ReportParameter name="EndDate_OffsetValue" binding="EndDate_OffsetValue" />
</ReportParameters>
</Control>
</Controls>
</ParameterBlock>
</LinkedReport>
Microsoft.SystemCenter.DataWarehouse.Report.ParameterControl.NumericUpDown
Description: A way to select an integer value.
Properties:
Bindings
Default (report parameter has to be Integer type)
Parameters
Minimum (minimum possible integer value)
Maximum (maximum possible integer value)
Sample:
<LinkedReport>
<ParameterBlock>
<Controls>
<Control type="Microsoft.SystemCenter.DataWarehouse.Report.ParameterControl.DateTimePicker" rowSpan="2" columnSpan="2">
<ReportParameters>
<ReportParameter name="TimeZone" binding="TimeZone" />
<ReportParameter name="TimeZoneName" binding="TimeZoneName" />
<ReportParameter name="StartDate_BaseType" binding="StartDate_BaseType" />
<ReportParameter name="StartDate_BaseValue" binding="StartDate_BaseValue">
<Prompt>Microsoft.SystemCenter.DataWarehouse.Report.Library!Microsoft.SystemCenter.DataWarehouse.Report.ParameterPrompt.StartDateTime</Prompt>
</ReportParameter>
<ReportParameter name="StartDate_OffsetType" binding="StartDate_OffsetType" />
<ReportParameter name="StartDate_OffsetValue" binding="StartDate_OffsetValue" />
<ReportParameter name="EndDate_BaseType" binding="EndDate_BaseType" />
<ReportParameter name="EndDate_BaseValue" binding="EndDate_BaseValue">
<Prompt>Microsoft.SystemCenter.DataWarehouse.Report.Library!Microsoft.SystemCenter.DataWarehouse.Report.ParameterPrompt.EndDateTime</Prompt>
</ReportParameter>
<ReportParameter name="EndDate_OffsetType" binding="EndDate_OffsetType" />
<ReportParameter name="EndDate_OffsetValue" binding="EndDate_OffsetValue" />
</ReportParameters>
</Control>
</Controls>
</ParameterBlock>
</LinkedReport>
Microsoft.SystemCenter.DataWarehouse.Report.ParameterControl.TextBox
Description: A way to enter string parameter value. Replaces standard SSRS text box control.
Properties:
Bindings
Default
Parameters
Multiline (True/False)
Sample:
<LinkedReport>
<ParameterBlock>
<Controls>
<Control type="Microsoft.SystemCenter.DataWarehouse.Report.ParameterControl.NumericUpDown" rowSpan="2" columnSpan="2">
<ReportParameters>
<ReportParameter name="EventID"/>
</ReportParameters>
</Control>
</Controls>
</ParameterBlock>
<Parameters>
<Parameter Name="EventID">
<Value>26319</Value>
</Parameter>
</Parameters>
</LinkedReport>
Microsoft.SystemCenter.DataWarehouse.Report.ParameterControl.RelativeDateTimePicker
Description: A way to select relative date time range. This class is used on the report side to process values entered by this control.
Properties:
Bindings
TimeZone (time zone reference)
TimeZoneName (name of the time zone displayed in the report)
StartDate_BaseType (start date base type)
StartDate_BaseValue (start date base value)
StartDate_OffsetType (type of start date offset)
StartDate_OffsetValue (start date offset value)
EndDate_BaseType (end date base type)
EndDate_BaseValue (end date base value)
EndDate_OffsetType (type of end date offset)
EndDate_OffsetValue (end date offset value)
Parameters
MaxWidth (control maximum width in pixels)
Sample:
<LinkedReport>
<ParameterBlock>
<Controls>
<Control type="Microsoft.SystemCenter.DataWarehouse.Report.ParameterControl.RelativeDateTimePicker" rowSpan="2" columnSpan="2">
<ReportParameters>
<ReportParameter name="TimeZone" binding="TimeZone" />
<ReportParameter name="TimeZoneName" binding="TimeZoneName" />
<ReportParameter name="StartDate_BaseType" binding="StartDate_BaseType" />
<ReportParameter name="StartDate_BaseValue" binding="StartDate_BaseValue">
<Prompt>Microsoft.SystemCenter.DataWarehouse.Report.Library!Microsoft.SystemCenter.DataWarehouse.Report.ParameterPrompt.StartDateTime</Prompt>
</ReportParameter>
<ReportParameter name="StartDate_OffsetType" binding="StartDate_OffsetType" />
<ReportParameter name="StartDate_OffsetValue" binding="StartDate_OffsetValue" />
<ReportParameter name="EndDate_BaseType" binding="EndDate_BaseType" />
<ReportParameter name="EndDate_BaseValue" binding="EndDate_BaseValue">
<Prompt>Microsoft.SystemCenter.DataWarehouse.Report.Library!Microsoft.SystemCenter.DataWarehouse.Report.ParameterPrompt.EndDateTime</Prompt>
</ReportParameter>
<ReportParameter name="EndDate_OffsetType" binding="EndDate_OffsetType" />
<ReportParameter name="EndDate_OffsetValue" binding="EndDate_OffsetValue" />
</ReportParameters>
</Control>
</Controls>
</ParameterBlock>
</LinkedReport>
Microsoft.SystemCenter.DataWarehouse.Report.ParameterControl.BusinessRelativeDateTimePicker
Description: A way to select relative date time range with business hours. This class is used on the report side to process values entered by this control.
Properties:
Bindings
TimeZone (time zone reference)
TimeZoneName (name of the time zone displayed in the report)
StartDate_BaseType (start date base type)
StartDate_BaseValue (start date base value)
StartDate_OffsetType (type of start date offset)
StartDate_OffsetValue (start date offset value)
EndDate_BaseType (end date base type)
EndDate_BaseValue (end date base value)
EndDate_OffsetType (type of end date offset)
EndDate_OffsetValue (end date offset value)
TimeType (type of time entered (business or regular))
TimeWeekMap (days of week selected for business time)
Parameters
MaxWidth (control maximum width in pixels)
Sample:
<LinkedReport>
<ParameterBlock>
<Controls>
<Control type="Microsoft.SystemCenter.DataWarehouse.Report.ParameterControl.BusinessRelativeDateTimePicker" rowSpan="2" columnSpan="2">
<ReportParameters>
<ReportParameter name="TimeZone" binding="TimeZone" />
<ReportParameter name="TimeZoneName" binding="TimeZoneName" />
<ReportParameter name="StartDate_BaseType" binding="StartDate_BaseType" />
<ReportParameter name="StartDate_BaseValue" binding="StartDate_BaseValue">
<Prompt>Microsoft.SystemCenter.DataWarehouse.Report.Library!Microsoft.SystemCenter.DataWarehouse.Report.ParameterPrompt.StartDateTime</Prompt>
</ReportParameter>
<ReportParameter name="StartDate_OffsetType" binding="StartDate_OffsetType" />
<ReportParameter name="StartDate_OffsetValue" binding="StartDate_OffsetValue" />
<ReportParameter name="EndDate_BaseType" binding="EndDate_BaseType" />
<ReportParameter name="EndDate_BaseValue" binding="EndDate_BaseValue">
<Prompt>Microsoft.SystemCenter.DataWarehouse.Report.Library!Microsoft.SystemCenter.DataWarehouse.Report.ParameterPrompt.EndDateTime</Prompt>
</ReportParameter>
<ReportParameter name="EndDate_OffsetType" binding="EndDate_OffsetType" />
<ReportParameter name="EndDate_OffsetValue" binding="EndDate_OffsetValue" />
</ReportParameters>
</Control>
</Controls>
</ParameterBlock>
</LinkedReport>
Microsoft.SystemCenter.DataWarehouse.Report.ParameterControl.MonitoringObjectPicker
Description: A way to select monitoring object for report. List of Monitoring Object IDs are passed to the report as a result value (default binding).
Properties:
Bindings
Default (report parameter has to be multi-value Integer type)
GroupList (list of management groups objects are allowed to be selected from)
Sample:
<LinkedReport>
<ParameterBlock>
<Controls>
<Control type="Microsoft.SystemCenter.DataWarehouse.Report.ParameterControl.MonitoringObjectPicker" rowSpan="2" columnSpan="3">
<ReportParameters>
<ReportParameter name="MonitoringObjectId" />
<ReportParameter name="ManagementGroupId" binding="GroupList" />
</ReportParameters>
</Control>
</Controls>
</ParameterBlock>
</LinkedReport>
Microsoft.SystemCenter.DataWarehouse.Report.ParameterControl.MonitoringObjectXmlPicker
Description: For object Selection input parameters as XML
Properties:
Bindings
Default (report parameter has to be multi-value Integer type)
GroupList (list of management groups objects are allowed to be selected from)
Sample:
<LinkedReport>
<ParameterBlock>
<Controls>
<Control type="Microsoft.SystemCenter.DataWarehouse.Report.ParameterControl.MonitoringObjectXmlPicker" rowSpan="2" columnSpan="3">
<ReportParameters>
<ReportParameter name="MonitoringObjectId">
<Prompt>Microsoft.SystemCenter.DataWarehouse.Report.Library!Microsoft.SystemCenter.DataWarehouse.Report.ParameterPrompt.ObjectList</Prompt>
</ReportParameter>
<ReportParameter name="ManagementGroupId" binding="GroupList"/>
</ReportParameters>
</Control>
</Controls>
</ParameterBlock>
</LinkedReport>
Microsoft.SystemCenter.DataWarehouse.Report.ParameterControl.PerformanceObjectPicker
Description: The Performance counter selection is based on the Object Selector. A performance counter selection has to support several objectives:
a) Scale is a parameter needed to allow comparing two counters with different value ranges.
b) The Dundas chart control allows changing of the chart type per series and also changing of the z-order (which series is sorted to the front, which to the back)
Properties:
Bindings
Default (report parameter has to be multi-value Integer type)
GroupList (list of management groups objects are allowed to be selected from)
Sample:
<LinkedReport>
<ParameterBlock>
<Controls>
<Control type="Microsoft.SystemCenter.DataWarehouse.Report.ParameterControl.PerformanceObjectPicker" rowSpan="2" columnSpan="3">
<ReportParameters>
<ReportParameter name="MonitoringObjectId">
<Prompt>Microsoft.SystemCenter.DataWarehouse.Report.Library!Microsoft.SystemCenter.DataWarehouse.Report.ParameterPrompt.ObjectList</Prompt>
</ReportParameter>
<ReportParameter name="ManagementGroupId" binding="GroupList"/>
</ReportParameters>
</Control>
</Controls>
</ParameterBlock>
</LinkedReport>
Microsoft.SystemCenter.DataWarehouse.Report.ParameterControl.PerformanceChartObjectPicker
Description: For performance Chart Object Selection
Properties:
Bindings
Default (report parameter has to be multi-value Integer type)
GroupList (list of management groups objects are allowed to be selected from)
Sample:
<LinkedReport>
<ParameterBlock>
<Controls>
<Control type="Microsoft.SystemCenter.DataWarehouse.Report.ParameterControl.PerformanceChartObjectPicker" rowSpan="2" columnSpan="3">
<ReportParameters>
<ReportParameter name="ObjectList"/>
<ReportParameter name="MonitoringObjectId">
<Prompt>Microsoft.SystemCenter.DataWarehouse.Report.Library!Microsoft.SystemCenter.DataWarehouse.Report.ParameterPrompt.ObjectList</Prompt>
</ReportParameter>
<ReportParameter name="ManagementGroupId" binding="GroupList"/>
</ReportParameters>
</Control>
</Controls>
</ParameterBlock>
</LinkedReport>
Microsoft.SystemCenter.DataWarehouse.Report.ParameterControl.PerformanceRulePicker
Description: For Performance Rules Selection
Properties:
Bindings
Default (report parameter has to be multi-value Integer type)
GroupList (list of management groups objects are allowed to be selected from)
Sample:
<LinkedReport>
<ParameterBlock>
<Controls>
<Control type="Microsoft.SystemCenter.DataWarehouse.Report.ParameterControl.PerformanceRulePicker" rowSpan="2" columnSpan="3">
<ReportParameters>
<ReportParameter name="ObjectList"/>
<ReportParameter name="MonitoringObjectId">
<Prompt>Microsoft.SystemCenter.DataWarehouse.Report.Library!Microsoft.SystemCenter.DataWarehouse.Report.ParameterPrompt.PerformanceRule</Prompt>
</ReportParameter>
<ReportParameter name="ManagementGroupId" binding="GroupList"/>
</ReportParameters>
</Control>
</Controls>
</ParameterBlock>
</LinkedReport>
Microsoft.SystemCenter.DataWarehouse.Report.ParameterControl.PerformanceRuleInstancePicker
Description: For Performance Rule Instances Selection
Sample:
<LinkedReport>
<ParameterBlock>
<Controls>
<Control type="Microsoft.SystemCenter.DataWarehouse.Report.ParameterControl.PerformanceRuleInstancePicker" rowSpan="2" columnSpan="3">
<ReportParameters>
<ReportParameter name="ObjectList"/>
<ReportParameter name="MonitoringObjectId">
<Prompt>Microsoft.SystemCenter.DataWarehouse.Report.Library!Microsoft.SystemCenter.DataWarehouse.Report.ParameterPrompt.PerformanceRule</Prompt>
</ReportParameter>
<ReportParameter name="ManagementGroupId" binding="GroupList"/>
</ReportParameters>
</Control>
</Controls>
</ParameterBlock>
</LinkedReport>
Microsoft.SystemCenter.DataWarehouse.Report.ParameterControl.LinkedPerformanceObjectPicker
Description: For Performance Object Selection
Sample:
<LinkedReport>
<ParameterBlock>
<Controls>
<Control type="Microsoft.SystemCenter.DataWarehouse.Report.ParameterControl.LinkedPerformanceObjectPicker" rowSpan="2" columnSpan="3">
<ReportParameters>
<ReportParameter name="ObjectList"/>
<ReportParameter name="MonitoringObjectId">
<Prompt>Microsoft.SystemCenter.DataWarehouse.Report.Library!Microsoft.SystemCenter.DataWarehouse.Report.ParameterPrompt.PerformanceRule</Prompt>
</ReportParameter>
<ReportParameter name="ManagementGroupId" binding="GroupList"/>
</ReportParameters>
</Control>
</Controls>
</ParameterBlock>
</LinkedReport>
Microsoft.SystemCenter.DataWarehouse.Report.ParameterControl.LinkedPerformanceChartObjectPicker
Description: For performance Chart Object selection.
Sample:
<LinkedReport>
<ParameterBlock>
<Controls>
<Control type="Microsoft.SystemCenter.DataWarehouse.Report.ParameterControl.LinkedPerformanceChartObjectPicker" rowSpan="2" columnSpan="3">
<ReportParameters>
<ReportParameter name="ObjectList"/>
<ReportParameter name="MonitoringObjectId">
<Prompt>Microsoft.SystemCenter.DataWarehouse.Report.Library!Microsoft.SystemCenter.DataWarehouse.Report.ParameterPrompt.PerformanceRule</Prompt>
</ReportParameter>
<ReportParameter name="ManagementGroupId" binding="GroupList"/>
</ReportParameters>
</Control>
</Controls>
</ParameterBlock>
</LinkedReport>
Microsoft.SystemCenter.DataWarehouse.Report.ParameterControl.ReportColumnPicker
Description: For Report Column Selection
Sample:
<LinkedReport>
<ParameterBlock>
<Controls>
<Control type="Microsoft.SystemCenter.DataWarehouse.Report.ParameterControl.ReportColumnPicker" rowSpan="2" columnSpan="3">
<ReportParameters>
<ReportParameter name="ColumnId">
<Prompt>Microsoft.SystemCenter.DataWarehouse.Report.Library!Microsoft.SystemCenter.DataWarehouse.Report.ParameterPrompt.ColumnList</Prompt>
</ReportParameter>
</ReportParameters>
</Control>
</Controls>
</ParameterBlock>
</LinkedReport>