TDWMEventControl Function | Application Programming Reference | Teradata Vantage - 17.05 - TDWMEventControl - Teradata Database

Teradata Vantageā„¢ - Application Programming Reference

prodname
Advanced SQL Engine
Teradata Database
vrm_release
17.00
17.05
created_date
June 2020
category
Programming Reference
featnum
B035-1090-170K

Purpose

Activates or deactivates a user-defined event.

Definition

REPLACE PROCEDURE TDWM.TDWMEventControl
  (IN EventName     TD_ANYTYPE,
   IN Operation     VARCHAR(1) CHARACTER SET LATIN,
   IN Duration      INTEGER,
   OUT NewStatus    VARCHAR(8) CHARACTER SET LATIN,
   OUT PriorStatus  VARCHAR(8) CHARACTER SET LATIN
   )
                .
                .
                .
;

Input Parameters

Input Parameter Description
EventName Name of the event specified.
Operation Status of the event:
  • A = Active
  • I = Inactive
Duration Time, in minutes, after the event expires.

A value of zero indicates no expiration time.

Usage Notes

The user-defined event specified must be an existing event in the active rule set and can include the following actions:
  • Notifications (for example, send alerts, run programs, or post to a queue table)
  • Activate a health condition (SysCon) or planned environment (OpEnv). The highest priority for health conditions and planned environments determines the rule state values that the system enforces. Rule attributes that can be changed based on the rule state include:
    • Rule enable flag
    • Rule system session, system query, and utility throttle limits
    • Workload throttle limits

For more information on SysCon and OpEnv, see the Teradata Viewpoint Help.

The TDWMEventControl procedure provides similar functionality to the USER EVENT CONTROL request. For more information about this interface, see USER EVENT CONTROL.

Output Parameters

Column Name Description
NewStatus Status of the event after the procedure call.
PriorStatus Status of the event before the procedure call.

Example: Using TDWMEventControl

CALL TDWM.TDWMEventControl('NodeDownEvent', 'A', 0, NewStatus, PriorStatus);