Previous Topic: Message Routing to Remote HostsNext Topic: Test Message Action


Message Action Definitions

You can use several types of actions in any sequence or combination to automate the processing of an input or output message. Actions that are labeled “Windows only” can be sent to a Windows computer running CA NSM.

ALLOW

Permits the execution of a command that is entered at the system console or issued using the oprcmd command.

Return Code: Return code from the executed command

ANNOTATE

(Windows only) Adds text as an annotation to the last console log record.

Note: For detailed information, see the online help.

AUTORPLY

Automatically answers a message on the Event Console that is waiting a reply. The Text field lets you specify the answer.

Return Code:

Example: &1 reply

BANNER

Displays a scrolling ticker‑tape style message in a separate window on the desktop of the node that the message action specifies. That node must be a Windows server and must be a node that has the Event Management real‑time components running on it.

The Text field specifies the text that you want displayed.

COMMAND

Permits the execution of a program or command. On the UNIX platforms, this action is the same as UNIXCMD; you can use either term.

The Text field specifies text string for the command syntax. CCS interprets the first element of this text string as the name of a program, script, or batch file to execute. The remaining elements are passed as arguments.

On z/OS, COMMAND must name a shell script or a zSeries File System (zFS) executable that can be invoked using the "Spawn" system service.

You can use a number of command prefixes with the COMMAND action. For details on these prefixes, see the online help for the cautil MSGACTION statement.

CORRELATE

(Windows only) Sends a message that is based on the TEXT operand to the specified Distributed State Machine (DSM).

Note: For detailed information, see the online help.

DELAY

Causes the message action processing to wait a specific amount of time before proceeding to the next action.

The Text field specifies the time.

Example: hh:mm:ss

DELKEEP

Deletes a live console message that a SENDKEEP action previously retained.

The Text field specifies the text that must be matched and then deleted. Wildcards are accepted.

Return Code:

DISABLE

Marks the message record currently being processed as unavailable for selection. When disabled, an input or output message cannot be selected for automatic processing until the message record is enabled with the ENABLE option.

For example, a typical response to an invalid reply is that the reply is rejected and the original message reissued. If the errant reply comes from an incorrectly defined Event Management message action, the result is an infinite loop of invalid replies. You can address this loop exposure by using the DISABLE message action.

DISCARD

Prevents an unwanted message from being displayed at an operator console. The message is not placed in the Event Console Log.

ENABLE

Marks a message record that was previously disabled as available for selection.

EVALUATE

Initiates that message selection was based on the text the Text field supplies. The text is itself matched against the message record as if it were a message received by Event Management. Then the actions that are associated with the matched text are performed. If a match is not found, EVALUATE functions identically to SENDOPER.

Return Code:

Zero

Match

Nonzero

No match

EXIT

Terminates the message processing for this event. Further actions are skipped.

EXPORT

Sets the value of an environment variable in the process in which the actions are being performed and in the Event Manager.

The Text field specifies the variable and its value:

variablename=value

In the local environment of the Event Management daemon, value is assigned to this environment variable. Any variable that you specify can be tested later through the TEST message action.

EXTERNAL

(Windows only) Permits the execution of a user-defined function in a dynamic-link library (DLL).

Return Code: Return code from the executed function

FORWARD

Forwards a message to another server for further evaluation.

The Text field specifies the text to be forwarded. If no text value is specified, the original message is forwarded. You can use this action to let a central node process all the messages generated on a set of remote nodes. The FORWARD action sends an event to a remote node, and allows for further matching and action on the remote node.

GOTO

Chains non‑consecutive actions together to enable branching to another action associated with the message. Optionally, you can base the branching on the return code from the last action to perform a conditional GOTO.

The Text field specifies the action sequence number to go to.

HILITE

Highlights the message when displayed on the Event Console.

The Text field specifies the text to highlight. If no value is specified, the original message is highlighted.

IGNORE

Indicates that all actions for this message are ignored and not performed.

PERMIT

Permits the execution of a command that is either entered at the system console or issued using the caiopr oprcmd command.

PREVENT

Prevents the execution of a specific command that is entered at the Event Console. It also intercepts the oprcmd command to prevent execution of a specific command.

PROHIBIT

Prevents the execution of a specific command that is entered at the Event Console. It also intercepts the oprcmd command to prevent execution of a specific command.

SENDKEEP

Marks a message for persistent display in the held messages area of the Event Console. The console operator must acknowledge and delete the message.

The Text field specifies the text to display on the console. If no value is specified, the original message is displayed.

SENDOPER

Sends a message to the Event Console.

The Text field specifies the text to be sent to the console. If no value is specified, the original message is displayed. The SENDOPER keyword sends an action to a remote node where the event is logged and no further matching is possible.

SENDUSER

Sends the text that the Text field specified to the user who created the message.

Return Code: Return code from the UNIX write command.

SUPPRESS

Prevents an unwanted message from being displayed on the Event Console but records the message in the Event Console Log.

The Text field specifies the message text to be suppressed on the Event Console.

UPDATEMAP

(Windows only) Updates the status of WorldView objects.

Note: For detailed information, see the online help.

UNIXCMD

Indicates that a command or program is executed. This action applies only to UNIX platforms and is the same as COMMAND.

The Text field specifies the UNIX command to be issued.

UNIXSH

Indicates that a UNIX shell script is executed or that you want to create a pipeline (for example, cmdI | grep xx | yy). This action applies only to UNIX platforms.

The Text field specifies the UNIX commands or shell script to be executed.

WAITOPER

Sends the specified message to the CCS console and waits for a reply.

The Text field specifies the text to display. You can use the careply command to reply to the message.

Return Code:

Zero

OK

Nonzero

System error

WAKEUP

Waits until the specified time before executing the next action.

The Text field specifies the wake-up time.

Example: hh:mm:ss

WORLDVPOP

(Windows only) Populates the WorldView Common Database with objects.

Note: For detailed information, see the online help.