本文件已封存並已停止維護。

Common Parameters

更新日期: 2010年7月

適用於: System Center Operations Manager 2007

The following parameters are common to different kinds of reports.

Date Parameters

Most of the generic reports require a date range that provides the start date and end date for the data to include in the report. Generic reports use a set of common parameters to define these dates. Rather than just enabling a specific start date and end date, parameters can define dates relative to the current date. Therefore, a linked report can specify a predetermined date range without requiring input from the user when the report is run.

For example, you can create a linked report that shows data from the previous week. The starting date could be set to the seven days prior to the date that the report is run, or it could be set to the Sunday of the previous week. Each time you run the report, the dates are set dynamically so that you do not have to provide the start and end date each time.

Relative Data Time Parameters

The following table lists the date and time parameters and their allowed values.

 

Parameter Description Allowed Values

TimeZone

Code for the time zone of the provided dates.

If the Relative Date Time Picker control is not used to let the user select the time zone, the value should be left blank to use the time zone of the current workstation.

A valid time zone code such as E001000000000000C4FFFFFF00000B0000000100020000000000000000000300000002000200000000000000|Pacific Standard Time

TimeZoneName

The name of the time zone.

If the Relative Date Time Picker control is not used to let the user select the time zone, the value should be left blank to use the time zone of the current workstation.

A valid time zone name such as (UTC-08:00) Pacific Time (US & Canada)

StartDate_BaseType

EndDate_BaseType

The type of date for the start date or the end date.

  • Fixed

  • Today

  • Sunday

  • Monday

  • Tuesday

  • Wednesday

  • Thursday

  • Friday

  • Saturday

  • FirstDayMonth

  • LastDayMonth

  • FirstDayQuarter

  • LastDayQuarter

  • FirstDayYear

  • LastDayYear

StartDate_BaseValue

EndDate_BaseValue

Date and time. Date is only used when StartDate_BaseType is Fixed. For other values of StartDate_BaseType only the time portion of the value is used.

A valid data and time string such as 1/1/2010 12:00:00 AM

StartDate_OffsetType

EndDate_OffsetType

The type of offset to use from the base date and value

A valid integer such as -7.

Date Parameter Examples

The following table shows example values required for the relative date parameters to achieve different scenarios.

 

Scenario BaseType BaseValue OffsetType OffsetValue

Specific date and time

Fixed

5/17/2010 02:00:00 PM

None

0

The current date at a specific time

Today

1/1/2010 12:00:00 AM

None

0

Yesterday at a specific time

Today

1/1/2010 02:00:00 PM

Day

-1

This week

Sunday

1/1/2010 12:00:00 AM

None

0

Previous week

Sunday

1/1/2010 12:00:00 AM

Week

-1

This month

FirstDayMonth

LastDayMonth

1/1/2010 12:00:00 AM

None

0

Previous month

FirstDayMonth

LastDayMonth

1/1/2010 12:00:00 AM

Month

-1

This quarter

FirstDayQuarter

LastDayQuarter

1/1/2010 12:00:00 AM

Time only

None

0

Previous quarter

FirstDayQuarter

LastDayQuarter

1/1/2010 12:00:00 AM

Time only

Quarter

-1

This year

FirstDayYear

LastDayYear

1/1/2010 12:00:00 AM

Time only

None

0

Previous year

FirstDayYear

LastDayYear

1/1/2010 12:00:00 AM

Time only

Year

-1

Business Relative Date Time Parameters

Some reports use parameters in addition to the relative data time parameters that restrict the analysis period to business hours. These parameters are listed in the following table.

 

Parameter Description Allowed Values

TimeType

Specifies if all hours should be used or business hours only.

Regular

Business

TimeWeekMap

Specifies the days of the week that business hours are applied. One or more values may be provided.

Only applies if the TimeType is Business.

Sunday

Monday

Tuesday

Wednesday

Thursday

Friday

Saturday

If the TimeType parameter is set to Business, the time in the StartDate_BaseValue and EndDate_BaseValue parameter is used to define business hours. The date portion of those values is used to define the start date and end date.

ManagementGroupId

The ManagementGroupID parameter specifies the GUID of the management group to retrieve data from.

You can use the Microsoft.SystemCenter.DataWarehouse.Report.ParameterPrompt.ManagementPack prompt with the Checked List Box or Combo Box control to populate the control with the list of management packs installed in the management group.

ManagementPackId

The ManagementPackID parameter specifies the ID for one or more management packs to include in the report.

You can use the Microsoft.SystemCenter.DataWarehouse.Report.ParameterPrompt.ManagementPack prompt with the Checked List Box or Combo Box control to populate the control with the list of management packs installed in the management group.

ObjectList

The ObjectList parameter contains XML code defining the objects used in the report. This includes an element called Object that includes the ID for the object in the data warehouse. This ID is typically not known when the report is created and is provided by the user with the Performance Object Picker control when the report is run. More than one Object element can be used if the series should contain data from more than one target object.

The Object element includes an attribute called Use that defines whether the object itself is used in the report or whether the object and all its contained objects are used. The value of this attribute can be either Self or Containment.

The following XML code shows an example of the ObjectList parameter including two objects.

<Data>
   <Objects>
      <Object Use="Containment">5</Object>
      <Object Use="Self">2</Object>
   </Objects>
</Data>

Performance reports also use the ObjectList parameter, but it includes additional elements in those reports. This is documented in Performance Parameters.

另請參閱

顯示: