Edit

Share via

WMI Event Watcher Task

  • Article

Applies to: SQL Server SSIS Integration Runtime in Azure Data Factory

The WMI Event Watcher task watches for a Windows Management Instrumentation (WMI) event using a Management Instrumentation Query Language (WQL) event query to specify events of interest. You can use the WMI Event Watcher task for the following purposes:

  • Wait for notification that files have been added to a folder and then initiate the processing of the file.

  • Run a package that deletes files when the available memory on a server drops lower than a specified percentage.

  • Watch for installation of an application, and then run a package that uses the application.

Integration Services includes a task that reads WMI information.

For more information about this task, click the following topic:

WQL Queries

WQL is a dialect of SQL with extensions to support WMI event notification and other WMI-specific features. For more information about WQL, see the Windows Management Instrumentation documentation.

Note

WMI classes vary between versions of Windows.

The following query watches for notification that the CPU use is more than 40 percent.

SELECT * from __InstanceModificationEvent WITHIN 2 WHERE TargetInstance ISA 'Win32_Processor' and TargetInstance.LoadPercentage > 40

The following query watches for notification that a file has been added to a folder.

SELECT * FROM __InstanceCreationEvent WITHIN 10 WHERE TargetInstance ISA "CIM_DirectoryContainsFile" and TargetInstance.GroupComponent= "Win32_Directory.Name=\"c:\\\\WMIFileWatcher\""

Custom Logging Messages Available on the WMI Event Watcher Task

The following table lists the custom log entries for the WMI Event Watcher task. For more information, see Integration Services (SSIS) Logging.

Log entry Description
WMIEventWatcherEventOccurred Indicates that an event occurred that the task was monitoring.
WMIEventWatcherTimedout Indicates that the task timed out.
WMIEventWatcherWatchingForWMIEvents Indicates that the task began to execute the WQL query. The entry includes the query.

Configuration of the WMI Event Watcher Task

You can configure the WMI Data Reader task in the following ways:

  • Specify the WMI connection manager to use.

  • Specify the source of the WQL query. The source can be external to the task, a variable or a file, or the query can be stored in a task property.

  • Specify the action that the task takes when the WMI event occurs. You can log the event notification and the status after the event, or raise custom Integration Services events that provide information associated with the WMI event, the notification, and the status after the event.

  • Define how the task responds to the event. The task can be configured to succeed or fail, depending on the event, or the task can just watch for the event again.

  • Specify the action the task takes when the WMI query times out. You can log the time-out and the status after time-out, or raise a custom Integration Services event, indicating that the WMI event timed out and logging the time-out and time-out status.

  • Define how the task responds to the time-out. The task can be configured to succeed or fail, or the task can just watch for the event again.

  • Specify the number of times the task watches for the event.

  • Specify the time-out.

If the source is a file, the WMI Event Watcher task uses a File connection manager to connect to the file. For more information, see Flat File Connection Manager.

The WMI Event Watcher task uses a WMI connection manager to connect to the server from which it reads WMI information. For more information, see WMI Connection Manager.

You can set properties through SSIS Designer or programmatically.

For more information about the properties that you can set in SSIS Designer, click the following topic:

For more information about how to set these properties in SSIS Designer, click the following topic:

Programmatic Configuration of the WMI Event Watcher Task

For more information about programmatically setting these properties, click the following topic:

WMI Event Watcher Task Editor (General Page)

Use the General page of the WMI Event Watcher Task Editor dialog box to name and describe the WMI Event Watcher task.

For more information about WMI Query Language (WQL), see the Windows Management Instrumentation topic, Querying with WQL, in the MSDN Library.

Options

Name
Provide a unique name for the WMI Event Watcher task. This name is used as the label in the task icon.

Note

Task names must be unique within a package.

Description
Type a description of the WMI Event Watcher task.

WMI Event Watcher Task Editor (WMI Options Page)

Use the WMI Options page of the WMI Event Watcher Task Editor dialog box to specify the source of the Windows Management Instrumentation Query Language (WQL) query and how the WMI Event Watcher task responds to Microsoft Windows Instrumentation (WMI) events.

For more information about WMI Query Language (WQL), see the Windows Management Instrumentation topic, Querying with WQL, in the MSDN Library.

Static Options

WMIConnectionName
Select a WMI connection manager in the list, or click <New WMI Connection...> to create a new connection manager.

Related Topics: WMI Connection Manager, WMI Connection Manager Editor

WQLQuerySourceType
Select the source type of the WQL query that the task runs. This property has the options listed in the following table.

Value Description
Direct input Set the source to a WQL query. Selecting this value displays the dynamic option, WQLQuerySource.
File connection Select a file that contains the WQL query. Selecting this value displays the dynamic option, WQLQuerySource.
Variable Set the source to a variable that defines WQL query. Selecting this value displays the dynamic option, WQLQuerySource.

ActionAtEvent
Specify whether the WMI event logs the event and initiates an SSIS action, or only logs the event.

AfterEvent
Specify whether the task succeeds or fails after it receives the WMI event, or if the task continues watching for the event to occur again.

ActionAtTimeout
Specify whether the task logs a WMI query time-out and initiates an SSIS event in response, or only logs the time-out.

AfterTimeout
Specify whether the task succeeds or fails in response to a time-out, or if the task continues watching for another time-out to recur.

NumberOfEvents
Specify the number of events to watch for.

Timeout
Specify the number of seconds to wait for the event to occur. A value of 0 means that no time-out is in effect.

WQLQuerySource Dynamic Options

WQLQuerySource = Direct input

WQLQuerySource
Provide a query, or click the ellipsis button (...) and enter a query using the WQL Query dialog box.

WQLQuerySource = File connection

WQLQuerySource
Select a File connection manager in the list, or click <New connection...> to create a new connection manager.

Related Topics: File Connection Manager, File Connection Manager Editor

WQLQuerySource = Variable

WQLQuerySource
Select a variable in the list, or click <New variable...> to create a new variable.

Related Topics: Integration Services (SSIS) Variables, Add Variable