Take Action commands

The Take Action feature lets your interactive Tivoli Enterprise Portal users enter a command or stop or start a process at any CICS region in your network where one or more Tivoli Enterprise Monitoring Agents are running. OMEGAMON XE for CICS on z/OS provides several predefined Take Actions that you can invoke to respond to unusual situations occurring within your CICS regions or to pass commands to CICS. All of these commands can be used in the Take Action response when a situation fires. For example, you might write a situation that checks whether a temporary storage queue contains more then 32500 entries and, if it does, deletes it. In that case the situation passes a CP:TSQD command to the Take Action command.

For more information about creating and using Take Action commands, see the Tivoli Enterprise Portal online help.

This section covers these predefined OMEGAMON XE for CICS on z/OS Take Action commands:

Note:
Security for the native OMEGAMON XE for CICS on z/OS commands (those prefixed by CP:) is determined by its own set of security profiles; for detailed information, including implementation instructions and guidelines, see the IBM Tivoli OMEGAMON XE for CICS on z/OS: Configuration Guide. However, security for z/OS console commands (for example, the CEKL command passed to CICS via the Modify command) is controlled by the general Take Action security your site set up that interfaces with NetView.

AID Purge

The AID Purge predefined Take Action command terminates one or more CICS Automatic Initiate Descriptors (AIDs).

Formula:

CP:AIDK ADDRESS=&CICSplex_AID_Analysis.AID_Address KILL

This command kills the AID using the AID address attribute from the CICSplex AID Analysis attribute group.

Security considerations

Your ability to invoke the AID purge command is determined by a separate set of security profiles that apply only to the OMEGAMON XE for CICS on z/OS Take Action commands.

CEKL Purge

The CEKL Purge predefined Take Action command requests the cancellation of a user task.

Formula:

F &CICSplex_Transaction_Analysis.CICS_Name,CEKL
 SET TASK(&CICSplex_Transaction_Analysis.Task_Number) PURGE

This command issues a z/OS CEKL console command to purge the task identified by the Task Number attribute from the CICS region identified by the CICS Name attribute; both attributes are from the CICSplex Transaction Analysis attribute group.

Security considerations

Your ability to invoke the CEKL purge command is determined by the general Take Action security environment your site set up via Netview.

ICE Cancel

The ICE Cancel predefined Take Action command terminates one or more CICS Interval Control Elements (ICEs).

Formula:

CP:ICEK ADDRESS=&CICSplex_ICE_Analysis.ICE_Address KILL

This command kills the ICE identified by the ICE Address attribute from the CICSplex AID Analysis attribute group.

Security considerations

Your ability to invoke the ICE cancel command is determined by a separate set of security profiles that apply only to the OMEGAMON XE for CICS on z/OS Take Action commands.

Sample CEMT SET command

The Sample CEMT SET predefined Take Action command illustrates how you can pass commands to your CICS regions using the CEMT SET command; in this particular case, the Take Action command uses the CEMT interface to open a VSAM file.

Formula:

CP:SET FILE(&CICSplex_VSAM_Analysis.DDNAME) OPEN

This command invokes the CEMT SET command to open a VSAM file identified by the DDNAME attribute from the CICSplex VSAM Analysis attribute group.

Note:
You can use this command to issue any CEMT SET command by overtyping the FILE(filename) OPEN clause with the command you want to execute. Example:
CP:SET TD(JTD1) ENABLE

Security considerations

Your ability to invoke the sample CEMT SET command is determined by a separate set of security profiles that apply only to the OMEGAMON XE for CICS on z/OS Take Action commands.

Sample TD queue purge command

The Sample TD queue purge predefined Take Action command illustrates how you can invoke TDDL commands to manipulate your CICS transient data queues; in this particular case, the Take Action command deletes all entries on a particular transient data queue.

Formula:

CP:TDDL ID=&CICSPlex_Transient_Data_Queues.Dest_ID

This command invokes the TDDL command to clear the transient data queue identified by the Dest ID attribute from the CICSplex Transient Data Queues attribute group.

Security considerations

Your ability to invoke the sample TD queue purge command is determined by a separate set of security profiles that apply only to the OMEGAMON XE for CICS on z/OS Take Action commands.

Sample TS queue delete command

The Sample TS queue delete predefined Take Action command illustrates how you can invoke TSQD commands to manipulate your CICS transient storage queues; in this particular case, the Take Action command deletes a named temporary storage queue.

Formula:

CP:TSQD ID=&CICSPlex_Temporary_Storage_Detail.Queue_ID

This command invokes the TSQD command to delete the transient storage queue identified by the Queue ID attribute from the CICSplex Transaction TSQUEUE Details attribute group.

Security considerations

Your ability to invoke the sample TS queue delete command is determined by a separate set of security profiles that apply only to the OMEGAMON XE for CICS on z/OS Take Action commands.

Sample TS queue delete command using the hex queue ID

The Sample TS queue delete using the hex queue ID predefined Take Action command illustrates how you can invoke TSQD commands to manipulate your CICS transient storage queues; in this particular case, the Take Action command deletes a named temporary storage queue using the hexadecimal form of the queue name. (Some temporary storage queues have hexadecimal characters in their names; these do not display correctly in Tivoli Enterprise Portal.)

Formula:

CP:TSQD ID=&CICSPlex_Temporary_Storage_Detail.Hex_Queue_ID HEX

This command invokes the TSQD command to delete the transient storage queue identified by the Hex Queue ID attribute from the CICSplex Transaction TSQUEUE Details attribute group.

Security considerations

Your ability to invoke the sample TS queue delete command is determined by a separate set of security profiles that apply only to the OMEGAMON XE for CICS on z/OS Take Action commands.

Sample WTO message issued by a command or situation

The Sample WTO message issued by a command or situation predefined Take Action command allows you to send mixed-case WTO commands to the z/OS operator's console.

Formula:

CP:WTO can be issued by a command or a TRUE situation

This command invokes the WTO command to display a console message; it can be invoked either directly or from a situation that has evaluated as TRUE. The text string passed can be any valid WTO string, in both upper- and lowercase and up to 62 characters long. A message whose length exceeds the 62-character limit is truncated.

Your message text can include variables from a OMEGAMON XE for CICS on z/OS table view, in this format: &{attribute_group:attribute_name}. Thus your text can include any supported attribute name provided the 62-character limit is not exceeded when the attribute value is substituted.

Security considerations

Your ability to invoke the sample WTO message command is determined by a separate set of security profiles that apply only to the OMEGAMON XE for CICS on z/OS Take Action commands.