System.Scheduler

Article
05/16/2012

Applies To: Operations Manager 2007 R2

The System.Scheduler module is a data source module type that outputs System.Discovery.Data data on a scheduled, repeating interval.

Usage

Use this module to initiate a workflow at the scheduled interval. If you plan to use this module for a simple schedule, consider using the System.SimpleScheduler instead. Do not use this module type from within a discovery workflow. For discovery workflows, use the System.Discovery.Scheduler module type.

Type Definition

<DataSourceModuleType ID="System.Scheduler" Accessibility="Public" Batching="false">
  <Configuration>
    <IncludeSchemaTypes>
      <SchemaType>System.ExpressionEvaluatorSchema</SchemaType>
    </IncludeSchemaTypes>
    <xsd:element name="Scheduler" type="PublicSchedulerType"/>
  </Configuration>
  <ModuleImplementation Isolation="Any">
    <Native>
      <ClassID>C3339855-80B3-4c06-B7AB-5C5D97B59A0D</ClassID>
    </Native>
  </ModuleImplementation>
  <OutputType>System.TriggerData</OutputType>
</DataSourceModuleType>

Parameters

System.Scheduler supports the configuration parameter described in the following table.

Parameter	Type	Overrideable	Description
Scheduler	PublicSchedulerType	False	Required parameter. Defines the schedule for a workflow.

For information about how to define the Scheduler parameter, see PublicSchedulerType. If you choose a weekly schedule, you must use the same value in the Start and End elements. The PublicSchedulerType schema data type exposes a MultipleDays element. Do not use this element for the System.Scheduler module.

Composition

The System.Scheduler module is a native module.

Errors

The errors listed in the following table can occur from within the System.Scheduler module.

Exception	Reason
11250	The module failed to initialize.
11251	One or more of the module’s input parameters are not valid.
11253	The module failed to process an incoming data item and the data item was dropped
11254	The module failed to initialize properly while starting background work.
11255	The module failed to process an interval cycle.

Module Type	Usage
System.Discovery.Scheduler	Outputs System.Discovery.Data data on a scheduled, repeating interval. Used in discoveries only.
System.SchedulerFilter	A condition detection module type that allows for the scheduling of rules and monitors.

External Module References

The System.Scheduler module is a member of the public modules described in the following table.

Module Type	Library	Usage
Microsoft.Windows.WmiProvider	Microsoft.Windows.Library	Queries a WMI namespace at a scheduled frequency and returns the results as System.PropertyBagData type data.
System.SimpleScheduler	System.Library	Implements a simple schedule timer that is used as a workflow trigger.
Microsoft.SystemCenter.WSManagement.TimedInvoker	Microsoft.SystemCenter.WSManagement.Library	Calls the WS-Management Invoke operation to run a method on a WS-Management object at a scheduled frequency

Sample

The following XML sample shows a rule that runs on a five-minute schedule and runs a script. The script logs an event to the Operations Manager event log when the script completes.

<Rule ID="Microsoft.Samples.ExecuteTestScript" Enabled="true" Target="Microsoft.Samples.ApplicationX" >
  <Category>Custom</Category>
  <DataSources>
    <DataSource ID="Scheduler" TypeID="System!System.Scheduler">
      <Scheduler>
        <SimpleReccuringSchedule>
          <Interval Unit="Minutes">5</Interval>
        </SimpleReccuringSchedule>
        <ExcludeDates/>
      </Scheduler>
    </DataSource>
  </DataSources>
  <WriteActions>
    <WriteAction ID="Script" TypeID="Windows!Microsoft.Windows.ScriptWriteAction">
      <ScriptName>Microsoft.Samples.LogOpsMgrEvent.vbs</ScriptName>
      <Arguments/>
      <ScriptBody>
        Option Explicit
        Dim OMAPI
        Set OMAPI = CreateObject("MOM.ScriptAPI")
        Call OMAPI.LogScriptEvent("Microsoft.Samples.LogOpsMgrEvent",101,0,"Script Executed")
      </ScriptBody>
      <TimeoutSeconds>30</TimeoutSeconds>
    </WriteAction>
  </WriteActions>
</Rule>

Information


Module Type	DataSourceModuleType
InputType	None
Output Type	System.TriggerData
Implementation	Native
Library	System.Library