Describing Action Specification fields

Actions Specifications are shown on two panels for each event type: Action Specification(s) I - event type and Action Specification(s) II - event type.

Not every action specification field can be used for every event type. The second column of the following table shows which event types can use an action specification field. For any event type for which you create a Rule, an action specification panel for that event type appears and contains a subset of the actions listed in the following table.

Action Specification fields and event types

Action Specification field	Event type	Description
Audit reject	IMP	Specify whether to issue Audit message to the Journal if this Rule rejects OM (IMSplex) command with Reject cmd ===> YES. Valid values are YES and NO. NO is the default. YES causes the following Journal message to be issued if this Rule fires and has Reject cmd ===> YES: DX0642I RULE rrrrrrrr RULESET ssssssss REJECTED OM cmd: cccccccc
Automation Token	MSG	Specifies to turn automation on or off for a WTO or to pass an automation token to the other automaters in the system. This is similar to the AUTO( ) parameter in the MPF for a message. This token is only valid for automating a single line WTO. Valid values are: BMC AMI Ops Automation-supplied variable values (up to 8 characters long) or SHARED variables YES: causes downstream automation and if it is not turned on, will turn it on. The automation token will be set to null values. NO: causes downstream automation to be turn off. The automation token will be set to null values. 1 to 8-character user-specified token: the token is sent to other automators and will require automation for the WTO.
Aux Log	All event types	Specifies that the event message is captured and displayed in the AuxLog logspace in the Logger. For more information about how to set up the AuxLog logspace and how to use BMC AMI Ops Logger, see Customizing-BMC-AMI-Ops-Automation-after-installation. For more information about viewing event messages written to AuxLog by using the AUXLOG windows-mode view, see Using-BMC-AMI-Ops-Automation-basic-applications.
Cancel Job	EOS	Specify whether to cancel the job. If you leave this field blank, the Job is not canceled.
Color	MSG	Specify a color for the WTO message; valid values are as follows: RED, GREEN, BLUE, YELLOW, TURQUOISE, PINK, WHITE Default value is none.
Console Name	MSG	Specify a message’s new destination console name. This field is 33 characters long. SHARED variables are valid. Only one console name can be specified. Console names are 1-8 characters long. Named consoles are available only on MVS/SP4.
Cmd (Type xxx)	All event types	Refer to Select-Command-Type-panel.
CTM Force Job	All event types	Specifies that the FORCEJOB request is sent to all subscribing Control-O or CMEM regions in the local LPAR. From there it can be sent to other INCONTROL products in the sysplex by using INCONTROL resources and facilities. For complete details and samples of the subfields for this action, please see the Control-O User Guide. The sub-fields are: Table: (required field) name of Control-M scheduling table Job: (optional field) job name If this field is blank, all jobs in the specified table are forced. Date: scheduling date for the jobs; valid values can be: spec_date: a specific date, in mmddyy, ddmmyy or yymmdd format, depending on the site standard ODAT: (default value) resolves to the Control-M installation working date DATE: resolves to the system date Library: (required field) name of the Control-M scheduling library containing the specified table
CTM Set Condition	All event types	Specifies to set a condition. The request to set a condition is sent to all subscribing Control-O or CMEM regions in the local LPAR. From there it can be sent to other INCONTROL products in the sysplex by using INCONTROL resources and facilities. For complete details and samples of the subfields for this action, please see the Control-O User Guide. The sub-fields are: Name: descriptive name of from 1 through 20 characters. Only trailing blanks are permitted. Date: (optional field) 4-character date reference; valid values can be: Date: a specific date in either mmdd or ddmm format, depending on the site standard ODAT: resolves to the current installation working date (default) DATE: resolves to the system date STAT: indicates that the condition, such as IMS-ACTIVE, is not date dependent Action: (required field) valid values are ADD and DEL
Descriptor codes	MSG	Specify new MVS descriptor codes or replace the original MVS descriptor codes of the message (38-character maximum). Separate each descriptor code entered with a blank. This field must be used in conjunction the Update Rout/Desc Codes field to specify either replacement or addition of new codes. Variables cannot be used in this field.
Display at dest.	ALRT CICS DB2 IMS JRNL MSG	Specify whether the message will be displayed at the destination it was originally sent to. Valid values are YES and NO. YES is the default. If you specify NO, the message is suppressed. Variables cannot be used in this field; in addition: if you journal the message, the entire message (including the reply ID) is written to the journal if you use IMFTEXT, the reply ID is stripped from the message WORD1 is the first word after the reply ID TEXT ID is the first word after the reply ID TEXT STRING does not include the reply ID For CICS events, When any line of a multiline message is suppressed in the TDQ (XTDOUT) exit, all subsequent lines of the multiline message are discarded (not presented to the XTDOUT exit). If a Rule fires that handles a CICS message and has NO specified in this field, all remaining lines of the multiline message will be discarded (not presented to the Rule Processor). This restriction is due to the design of the CICS exit. Given this CICS behavior, you cannot suppress a part of any multiline CICS message and still receive the rest of the multiline message in a Rule. Note When you specify the selection criteria MLWTO Minor = ALL or MLWTO Minor = SINGLE for a MSG-initiated Rule, the Rule cannot take the action of suppressing the message. Therefore, the action field Display at dest. (which normally appears for MSG-initiated Rules on the Action Specification panel), does not appear when you specify MLWTO Minor = ALL or MLWTO Minor = SINGLE.
DOM ID	All event types	Specify the name of a SHARED variable that contains the delete-operator-message ID of a previously issued WTO.
DOM MSG	MSG	Specify that BMC AMI OpsA will issue message DX9505I when the action message which caused this Rule to fire is deleted.
EXEC name/Parms	All event types	Refer to REXX-Exec-or-CLIST-panel.
Extend Time	TLM	Specify a value in seconds to extend the CPU or WAIT time for a Job, Started Task or TSO User. If the Rule is firing for Step CPU, the Step CPU is extended. If the Rule is firing for a Job, the Job CPU is extended. If the Rule is firing for Wait time, the wait time is extended. Valid values are as follows: blank - Do not extend the job. numeric value from 1 to 255. Event or SHARED variables are supported.
Hilite	MSG	Specify a highlighting value for the WTO message; valid values are as follows: NO specifies that the Rule does not change the highlight attribute. BLINK causes the message to blink when it appears. UNDER changes the message to appear with an underscore. REVERSE changes the message to appear with reverse video highlighting. You cannot specify more than one value. Default value is none.
Intensity	MSG	Specify an intensity value for the WTO message; valid values are as follows: HIGH causes the message to appear with high intensity. NORMAL causes the message to appear with normal intensity. The message intensity setting is ignored for multicolored consoles. Default value is none.
Issue Msg (WTO, JRN, or WJ)	All event types	Refer to Issue-Message-panel.
Journal	ALRT CICS CMD DB2 EXT IMP IMS MSG TIME VAR	Specify whether the message will be recorded in the BBI-SS PAS Journal. Valid values are YES, NO, and REW. The default is NO. A value of REW copies a reworded message to the BBI-SS PAS Journal. Use REW with the Reword Msg field. For event type MSG: if you journal the message, the entire message (including the reply ID) is written to the journal if you use IMFTEXT, the reply ID is stripped from the message WORD1 is the first word after the reply ID TEXT ID is the first word after the reply ID TEXT STRING does not include the reply ID
POST Target	All event types	Specify the SSID of the target BBI-SS PAS that will execute the POST action of an EXEC. If this field is not specified, the target is the local BBI-SS PAS that fires the Rule. The target name can be 1-32 characters in length and can be a variable name.
POST ID	All event types	Specify the matching name information that is specified in the WAIT parameter of the EXEC that causes a waiting EXEC to be posted to run The POST ID can be 1-32 characters long and may be a variable name. For example, to post an EXEC that is waiting for a name of BACKUP, enter BACKUP in this field.
POST Parms	All event types	When you are using the POST function in a Rule, you can specify optional parameter information that is passed in the IMFPOST variable to the waiting EXEC. The POST Parms value can be 1-56 characters and special characters and imbedded blanks are supported. One or more variable names are allowed in this field.
Reject Command	CMD	Specify whether command will be issued or rejected.
Reject Command	IMP	Specify whether the command is rejected. Valid values are YES and NO. NO is the default. YES means the command will not be executed. Note When you specify YES, the OM command is still passed to all matching Rules in all eligible BMC AMI OpsA address spaces for automation. After all matching Rules fire, the OM command is rejected and is not passed to any other IMS OM input user exits.
Reword ALERT	ALRT	Use this field to change the ALERT text to be sent to its destination. Note that the reworded text is used for all subsequent Rule matching comparisons. The length of the reworded text cannot exceed 255 characters. EVENT and SHARED variables are valid in this field. The reworded text is used in subsequent Rule Selection Criteria comparisons.
Reword CMD	CMD	Enter a new command that replaces the original command. All attributes associated with the command are retained. The maximum length of a command replacement is 126 characters.
Reword CMD	IMP	Enter the command text to be sent to its destination. Note that the reworded command text is used for all subsequent Rule matching comparisons. The length of the reworded text cannot exceed the length of the original command plus 80 characters up to a maximum of 255 characters.
Reword Msg	IMS JRNL MSG CICS	Use this field to change the message text to be sent to its destination. Note that the reworded text is used for all subsequent Rule matching comparisons. For the IMS event type, the length of the reworded text cannot exceed the length of the original message plus 20 characters. For example, if the length of the original text is 40 characters long, the reworded text cannot exceed 60 characters. For the JRNL event type, the length of the reworded text cannot exceed the length of the original message. For the MSG event type, the length of the reworded text cannot exceed 126 characters. For CICS Transient Data messages, the maximum length of the reworded message is limited to 212 characters. If variables are used, the maximum length is 512 characters (after the contents of the variables are resolved). Any resolved value greater than 512 characters will be truncated to 512 at the time the Rule fires. EVENT and SHARED variables are valid in this field. The reworded message text is used in subsequent Rule Selection Criteria comparisons.
Route codes	MSG	Specify new MVS route codes or replace the original MVS route codes of the message (61 characters maximum). Separate each route code entered with a blank. This field must be used in conjunction the Update Rout/Desc Codes field to specify either replacement or addition of new codes. Variables cannot be used in this field.
Send (TSO)	All event types	Send a copy of the message using the MVS SEND command to 1-5 TSO user IDs. Separate each TSO user ID by a blank. This field is 40 characters long. EVENT and SHARED variables are valid in this field.
Set IOA Variable	All event types	Set the value of any global IOA variable. The request to set an IOA variable is sent to all subscribing Control-O or CMEM regions in the local LPAR. From there it can be sent to other INCONTROL products in the sysplex by using INCONTROL resources and facilities. You can use this set of fields to assign a new variable value by using a BMC AMI OpsA variable, character string, or an unsigned constant in the second field. Valid values are as follows: blank: no variable is modified First Set IOA Variable field: can be up to 33 characters and contain any IOA variable name Second Set IOA Variable field: can be 43 characters and contain a valid value for the specified variable.
SYSLOG Display	MSG	Specify whether the message will be recorded in the MVS SYSLOG. Valid values are YES and NO. YES is the default. Note When you specify the selection criteria MLWTO Minor = ALL or MLWTO Minor = SINGLE for a MSG-initiated Rule, the Rule cannot take the action of preventing it from being recorded in the MVS SYSLOG. Therefore, the action field SYSLOG Display (which normally appears for MSG-initiated Rules on the Action Specification panel), does not appear when you specify MLWTO Minor = ALL or MLWTO Minor = SINGLE.
Update Rout/Desc Codes	MSG	Add or replace the route and descriptor codes that are specified in the Route Codes or Desc Codes fields. Valid values are ADD (to add new codes) or REPL (to replace old codes with new ones specified). Variables cannot be used in this field.

Describing Action Specification fields

On this page