2.8.5 EventHandlerType

The EventHandlerType type is used to specify the triggering events and the executables that are executed when a specific event occurs during the execution of a container, task, or package.

The following is the XSD of the EventHandlerType complex type.

   <xs:complexType name="EventHandlerType">
     <xs:sequence>
       <xs:element name="Property"
                   maxOccurs="unbounded">
         <xs:complexType>
           <xs:complexContent>
             <xs:extension base="DTS:PropertyElementBaseType">
               <xs:attribute name="Name"
                   type="DTS:EventHandlerPropertyNameEnum"
                   use="required"/>
             </xs:extension>
           </xs:complexContent>
         </xs:complexType>
       </xs:element>
       <xs:element name="PropertyExpression"
                   type="DTS:PropertyExpressionElementType"
                   minOccurs="0" maxOccurs="unbounded"/>
       <xs:element name="Variable" type="DTS:VariableType" 
                   minOccurs="0" maxOccurs="unbounded"/>
       <xs:element name="LoggingOptions" type="DTS:LoggingOptionsType"/>
       <xs:element name="Executable" type="DTS:AnyNonPackageExecutableType" 
                   minOccurs="0" maxOccurs="unbounded"/>
       <xs:element name="PrecedenceConstraint" 
                   type="DTS:PrecedenceConstraintType" 
                   minOccurs="0" maxOccurs="unbounded"/>      
     </xs:sequence>
   </xs:complexType>

The following table provides additional information about the elements, types, and constraints for the EventHandlerType complex type.

Element

Constraints

Type definition

Description

Property

In some cases, constraints are placed on the Property element’s value for specific values of the Name attribute of the Property element. If such constraints exist, they are specified where the meaning of the particular property name is specified. These constraints MUST be followed. If the optional DataType attribute is present, the value of the Property element MUST be of the type indicated by the DataType attribute.

Inline in the XSD in this section.

Specifies values for many different properties associated with an instance of the containing EventHandler element, according to the Name attribute of each Property element.

Variable

None

VariableType

Specifies definitions of variables that can be defined in the context of the event handler.

LoggingOptions

None

LoggingOptionsType

Specifies information about what kind of information is logged for this event handler and where that information is recorded.

PropertyExpression

Additional constraints exist for the PropertyExpression element. For more information, see PropertyExpressionElementType.

PropertyExpressionElementType

Serves the same purpose as specified for the Property element, except that an expression that is evaluated at run time is contained in the element’s value that is stored in the Microsoft SQL Server Integration Services (SSIS) file format.

Executable

None

AnyNonPackageExecutableType

Specifies the executables that are executed when the event handler is fired.

PrecedenceConstraint

None

PrecedenceConstraintType

Specifies information about precedence constraints between contained executables in this EventHandler element.