DEFINE INPUT EVENT

Define a BTS input event.

DEFINE EVENT

Read syntax diagramSkip visual syntax diagramDEFINEINPUTEVENT( data-value)

Conditions: EVENTERR, INVREQ

Description

DEFINE INPUT EVENT defines an input event to BTS. Typically, an input event is passed to an activity by its parent, causing the activity to be activated. (Sometimes, however, the input event originates from outside the process.)

Most events fire on the completion of something, such as an activity or a specified time interval. An input event is different in that it fires after a RUN command that names it is issued.

An activity defines an input event in order to receive notification (via the INPUTEVENT option of the RUN or LINK ACTIVITY commands) of why it has been activated.

Note: System events such as DFHINITIAL are a special type of input event. They are recognized by all activities and do not need to be defined.

Options

EVENT(data-value)
specifies the name (1–16 characters) of the input event being defined. The acceptable characters are A-Z a-z 0-9 $ @ # . - and _. Leading and embedded blank characters are not permitted. If the name supplied is less than 16 characters, it is padded with trailing blanks up to 16 characters.

Conditions

111 EVENTERR
RESP2 values:
6
The event name specified on the EVENT option is invalid.
7
The event name specified on the EVENT option has already been defined to this activity.
16 INVREQ
RESP2 values:
1
The command was issued outside the scope of an activity.