SMS_ReportParameter Server WMI Class

Article
05/03/2011

Applies To: System Center Configuration Manager 2007, System Center Configuration Manager 2007 R2, System Center Configuration Manager 2007 R3, System Center Configuration Manager 2007 SP1, System Center Configuration Manager 2007 SP2

The SMS_ReportParameter Windows Management Instrumentation (WMI) class is an SMS Provider server class, in Configuration Manager, that represents a user-supplied parameter that is required to run the report.

The following syntax is simplified from Managed Object Format (MOF) code and includes all inherited properties.

Class SMS_ReportParameter
{
      Boolean AllowEmpty;
      String DefaultValue;
      String PromptText;
      String SampleValueSQL;
      String VariableName;
};

Methods

The SMS_ReportParameter class does not define any methods.

Properties

AllowEmpty
Data type: Boolean

Access type: Read/Write

Qualifiers: None

true if the report parameter can be unspecified by the user. The value of the DefaultValue property is used instead.

DefaultValue
Data type: String

Access type: Read/Write

Qualifiers: None

Value to use if the report parameter is unspecified by the user. Set this property to null to use SQL NULL as a default. This property is only applicable if AllowEmpty is set to true.

PromptText
Data type: String

Access type: Read/Write

Qualifiers: None

Text displayed to the user to request the report parameter value.

SampleValueSQL
Data type: String

Access type: Read/Write

Qualifiers: None

Text of the SQL query that populates a list of sample values for the parameter.

VariableName
Data type: String

Access type: Read/Write

Qualifiers: None

Name of the report parameter as it appears in the SQL statement.

Remarks

Class qualifiers for this class include:

Embedded

For more information about both the class qualifiers and the property qualifiers included in the Properties section, see Configuration Manager Class and Property Qualifiers.

This class is an embedded class used only as a member of SMS_Report Server WMI Class.

The user-supplied parameter provided to this class is substituted for a variable in an SQL query for the report. Usually this is a value in a WHERE clause.

Requirements

Runtime Requirements

For more information, see Configuration Manager Server Runtime Requirements.

Development Requirements

For more information, see Configuration Manager Server Development Requirements.

Partager via