Raising Events in the Script Component

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

Events provide a way to report errors, warnings, and other information, such as task progress or status, to the containing package. The package provides event handlers for managing event notifications. The Script component can raise events by calling methods on the ComponentMetaData property of the ScriptMain class. For more information about how Integration Services packages handle events, see Integration Services (SSIS) Event Handlers.

Events can be logged to any log provider that is enabled in the package. Log providers store information about events in a data store. The Script component can also use the Log method to log information to a log provider without raising an event. For more information about how to use the Log method, see the following section.

To raise an event, the Script task calls one of the following methods of the IDTSComponentMetaData100 interface exposed by the ComponentMetaData property:

Event	Description
FireCustomEvent	Raises a user-defined custom event in the package.
FireError	Informs the package of an error condition.
FireInformation	Provides information to the user.
FireProgress	Informs the package of the progress of the component.
FireWarning	Informs the package that the component is in a state that warrants user notification, but is not an error condition.

Here is a simple example of raising an Error event:

Dim myMetadata as IDTSComponentMetaData100

myMetaData = Me.ComponentMetaData

myMetaData.FireError(...)

See Also

Integration Services (SSIS) Event Handlers
Add an Event Handler to a Package