SIGNAL EVENT

Identify a place in an application program where one or more events could be emitted.

SIGNAL EVENT

Read syntax diagramSkip visual syntax diagram SIGNAL EVENT( data-value) FROMCHANNEL( data-value)FROM( data-area)FROMLENGTH( data-value)

Conditions: CHANNELERR, EVENTERR, LENGERR

This command is threadsafe.

Description

The SIGNAL EVENT identifies a place in an application program where one or more events could be emitted. Events are emitted when the following conditions are satisfied:

  • Event processing is active.
  • There is least one matching capture specification enabled. A capture specification matches if it has a capture point of SIGNAL EVENT, and all its predicates evaluate to true.

SIGNAL EVENT has a primary predicate of EVENT, and allows secondary predicates on the FROM data-area or the FROMCHANNEL and its containers. The data in any CICS® Event emitted as a result of SIGNAL EVENT is defined in the Business Event that contains the matching capture specification.

Options

EVENT(data-value)
Specifies an identifier (1 – 32 characters) that identifies this SIGNAL EVENT.

The acceptable characters are A-Z a-z 0-9 $ @ # / % & ? ! : | " = , ; < > . - and _. Leading and embedded blank characters are not permitted. If the name supplied is fewer than 32 characters, it is padded with trailing blanks up to 32 characters.

Event identifiers are always in EBCDIC. The allowable set of characters for event identifiers, listed above, includes some characters that do not have the same representation in all EBCDIC code pages. We therefore recommend that the characters used in naming them should be restricted to A-Z a-z 0-9 & : = , ; < > . - and _.

FROMCHANNEL(data-value)
Specifies the name (1 – 16 characters) of a channel containing data for this event. You can specify the channel name DFHTRANSACTION to use the transaction channel.
FROM(data-area)
Specifies a data area containing data for this event.
FROMLENGTH(data-value)
Specifies a fullword binary value that is the length in bytes of the FROM data area.

Conditions

122 CHANNELERR
RESP2 values:
2
The channel specified on the FROMCHANNEL option could not be found.
111 EVENTERR
RESP2 values:
6
The identifier specified on the EVENT option contains an incorrect character or combination of characters.
22 LENGERR
RESP2 values:
3
The length that you have specified in FROMLENGTH is not greater than zero.