Rule Actions
Rule actions define what happens whenever an alert is raised by the triggering of rule criteria. The action types available for use are dependent on the rule to which they are being applied.
Action Schedule action
Selecting the Action Schedule action selects a user-defined schedule that then performs the actions listed within the Action Schedule.
Action schedule
Use F4=Prompt to display a list of Action Schedules (these must have already been created) from which a selection can be made.
Close action
Selecting the Close action closes the alert, without further action.
Alert to close
Specifies the alert that is closed when with action is invoked.
| *CURRENT | The Close action is performed on the alert that triggered the action |
| *REF | The Close action is performed on the alert specified by the entries in the subsequent qualifier parameters that are displayed when Enter is pressed |
Condition
Specifies the alert condition required in order for the Close action to be performed.
| *NONE | When the Close action is performed, the alert is closed and any pending actions are canceled |
| *COMP | When the Close action is performed, the alert is not actually closed until all pending actions have been performed. The actions do not have to complete successfully |
| *COMPNOERR | When the Close action is performed, the alert is not closed until all the actions have completed successfully.If one or more actions fail, the alert is never closed by this action. In this case, the alert must be manually closed by some other action |
When a Close action runs and *NONE is specified, the status of the Close action changes to ‘Complete’.
When a Close action runs and *COMP or *COMPNOERR is specified, the status of the Close action goes to ‘Cnd-Wait’. When the conditions are met, the Close action status changes to ‘Complete’ and the alert is then closed. In the Display Message Detail display (available from within the Message Log), the close method for the alert is shown as reason code ‘B’.
Delay
Specifies the time delay in seconds before the action is invoked. If the alert is manually closed before the specified time elapses, the action is not performed.
Command action
Select the Command action to perform a command on the alert.
Command
Specifies the command to run. You can specify any command that is allowed to run in the *EXEC environment (in most cases, these are the same as the commands that can be run at a command line). The command may include substitution variables.
CCSID
Specifies whether to run the command using a specific coded character set identifier (CCSID). The text entered within the command/message is evaluated for the CCSID specified. If not valid, an error message is shown.
| *SYSVAL | The Action Monitor runs the command using the CCSID defined in the IBM system value QCCSID |
| 1-65533 | The command is run using the specified CCSID |
System
Specifies the name of the system, as listed on the Work with Remote Locations display, on which to perform the Command action.
| *LOCAL | The action is performed on the current system and in the current environment |
| system | The action is performed on the system and environment defined by the specified location name |
Time-out
If a remote system has been specified in the ‘System’ parameter, the entry in this parameter specifies the maximum time allowed for this action to be sent to the remote system. If the time elapses without the action being sent, the send is aborted and the action fails.
| *DFT | The Batch mode time-out period specified on the Work with Remote Locations display is used |
| 1-600 | Enter a specific time-out period (in seconds) |
Delay
Specifies the time delay in seconds before the action is invoked. If the alert is manually closed before the specified time elapses, the action is not performed.
Console action
Selecting the Console action results in any triggered alert being sent to the Message Console.
Alert text
Specifies the message used when reporting the alert. This message may include substitution variables. If &PRBTXT is specified, the Alert text is compiled from the information on the IBM Problem rather than the message that triggered the Rule. If no corresponding IBM Problem exists then &PRBTXT is treated as &ALERT.
System
Specifies the name of the system, as listed on the Work with Remote Locations display, on which to perform the action. If messages are sent to *LOCAL, they can be viewed using Message Console from the Halcyon main menu. Messages sent to other systems can be viewed using the Halcyon Enterprise Console.
Use F4=Prompt to display a list of alternative systems. The entries in this list must have been previously identified using Configuration - Work with Remote Locations.
| *LOCAL | The action is performed on the current system and in the current environment |
| system | The action is performed on the system and environment defined by the specified location name |
Time-out
If a remote system has been specified in the ‘System’ parameter, the entry in this parameter specifies the maximum time allowed for this action to be sent to the remote system. If the time elapses without the action being sent, the send is aborted and the action fails.
| *DFT | The Batch mode time-out period specified on the Work with Remote Locations display is used |
| 1-600 | Enter a specific time-out period (in seconds) |
Alert Type
Specifies the type of alert.
| *AUTO | The alert type is automatically set from the message severity |
| 0 | *INFO |
| 1-29 | *WARN |
| 30-49 | *ERROR |
| 50-99 | *CRITICAL |
| *INFO | Information |
| *COMP | Completion |
| *WARN | Warning |
| *ERROR | Error |
| *CRITICAL | Critical |
Severity
Specifies the console severity of the alert.
| *SAME | If the alert is caused by Message Manager, the message severity is used as the console severity. Otherwise, the console severity is 0 |
| 0-99 | Specifies the specific console severity to use |
Delay
Specifies the time delay in seconds before the action is invoked. If the alert is manually closed before the specified time elapses, the action is not performed.
Delete action
The Delete Alert action is used to delete the alert and remove the entry from the Alert Log. Deleting an open alert causes it to close first.
Alert to delete
Specify the alert on which to perform the Delete action.
| *CURRENT | The Delete action is performed on the current rule or alert that invoked this action |
| *REF | The Delete action is performed on the rule or alert specified by the qualifier parameters |
Condition
Specifies the alert condition required for the Delete action to be performed.
| *NONE | When the Delete action is performed, the alert is closed and any pending actions are canceled |
| *COMP | When the Delete action is performed, the alert is not actually closed until all pending actions have been performed. The actions do not have to complete successfully |
| *COMPNOERR | When the Delete action is performed, the alert is not closed until all the actions have completed successfully. If one or more actions fail, the alert is never closed by this action. In this case, the alert must be manually closed by some other action |
Delay
Specifies the delay before the action is invoked. If the alert is closed before the specified time elapses, the action is not performed. Specify a value in the range 0-9999 seconds.
Email Active Jobs action
The Email Active Jobs action can be used to email a list of all the currently active jobs on your system. This is useful if, for example, you have a rule that breaks a CPU usage threshold as it provides you with information that may determine the cause of the overload.
Command
When EMLACTJOB has either been entered as the Action type or selected using F4=Prompt, press Enter to display a command line with the SNDEMLMSG command and substitution variables ready for completion. Use F16=List substitution variables to view a list of alternative entries for this command.
CCSID
Specifies whether to run the command using a specific coded character set identifier (CCSID). The text entered within the command/message is evaluated for the CCSID specified. If not valid, an error message is shown.
| *SYSVAL | The Action Monitor runs the command using the CCSID defined in the IBM system value QCCSID |
| 1-65533 | The command is run using the specified CCSID |
System
Specifies the name of the system, as listed on the Work with Remote Locations display, on which to perform the action. Use F4=Prompt to display a list of alternative systems. The entries in this list must have been previously identified using Configuration - Work with Remote Locations.
| *LOCAL | The action is performed on the current system and in the current environment |
| system | The action is performed on the system and environment defined by the specified location name |
Time-out
If a remote system has been specified in the ‘System’ parameter, the entry in this ‘parameter’ specifies the maximum time allowed for this action to be sent to the remote system. If the time elapses without the action being sent, the send is aborted and the action fails.
| *DFT | The Batch mode time-out period specified on the Work with Remote Locations display is used |
| 1-600 | Enter a specific time-out period (in seconds) |
Delay
Specifies the time delay in seconds before the action is invoked. If the alert is manually closed before the specified time elapses, the action is not performed.
Email Job Information action
The Email Job Information action can be used to email a list of job information (as available using the DSPJOB command).
Command
When EMLJOBINF has either been entered as the Action type or selected using F4=Prompt, press Enter to display a command line with the SNDEMLMSG command and substitution variables ready for completion. Use F16=List substitution variables to view a list of alternative entries for this command.
CCSID
Specifies whether to run the command using a specific coded character set identifier (CCSID). The text entered within the command/message is evaluated for the CCSID specified. If not valid, an error message is shown.
| *SYSVAL | The Action Monitor runs the command using the CCSID defined in the IBM system value QCCSID |
| 1-65533 | The command is run using the specified CCSID |
System
Specifies the name of the system, as listed on the Work with Remote Locations display, on which to perform the action. Use F4=Prompt to display a list of alternative systems. The entries in this list must have been previously identified using Configuration - Work with Remote Locations.
| *LOCAL | The action is performed on the current system and in the current environment |
| system | The action is performed on the system and environment defined by the specified location name |
Time-out
If a remote system has been specified in the ‘System’ parameter, the entry in this ‘parameter’ specifies the maximum time allowed for this action to be sent to the remote system. If the time elapses without the action being sent, the send is aborted and the action fails.
| *DFT | The Batch mode time-out period specified on the Work with Remote Locations display is used |
| 1-600 | Enter a specific time-out period (in seconds) |
Delay
Specifies the time delay in seconds before the action is invoked. If the alert is manually closed before the specified time elapses, the action is not performed.
Email Job Log action
The Email Job Log action can be used to email the job log (as available using the WRKJOBLOG command).
Command
When EMLJOBLOG has either been entered as the Action type or selected using F4=Prompt, press Enter to display a command line with the SNDEMLMSG command and substitution variables ready for completion. Use F16=List substitution variables to view a list of alternative entries for this command.
CCSID
Specifies whether to run the command using a specific coded character set identifier (CCSID). The text entered within the command/message is evaluated for the CCSID specified. If not valid, an error message is shown.
| *SYSVAL | The Action Monitor runs the command using the CCSID defined in the IBM system value QCCSID |
| 1-65533 | The command is run using the specified CCSID |
System
Specifies the name of the system, as listed on the Work with Remote Locations display, on which to perform the action. Use F4=Prompt to display a list of alternative systems. The entries in this list must have been previously identified using Configuration - Work with Remote Locations.
| *LOCAL | The action is performed on the current system and in the current environment |
| system | The action is performed on the system and environment defined by the specified location name |
Time-out
If a remote system has been specified in the ‘System’ parameter, the entry in this ‘parameter’ specifies the maximum time allowed for this action to be sent to the remote system. If the time elapses without the action being sent, the send is aborted and the action fails.
| *DFT | The Batch mode time-out period specified on the Work with Remote Locations display is used |
| 1-600 | Enter a specific time-out period (in seconds) |
Delay
Specifies the time delay in seconds before the action is invoked. If the alert is manually closed before the specified time elapses, the action is not performed.
Email System Status action
The Email System Status action can be used to email the current system status information (as available using the DSPSYSSTS command).
Command
When EMLSYSSTS has either been entered as the Action type or selected using F4=Prompt, press Enter to display a command line with the SNDEMLMSG command and substitution variables ready for completion. Use F16=List substitution variables to view a list of alternative entries for this command.
CCSID
Specifies whether to run the command using a specific coded character set identifier (CCSID). The text entered within the command/message is evaluated for the CCSID specified. If not valid, an error message is shown.
| *SYSVAL | The Action Monitor runs the command using the CCSID defined in the IBM system value QCCSID |
| 1-65533 | The command is run using the specified CCSID |
System
Specifies the name of the system, as listed on the Work with Remote Locationsdisplay, on which to perform the action. Use F4=Prompt to display a list of alternative systems. The entries in this list must have been previously identified using Configuration - Work with Remote Locations.
| *LOCAL | The action is performed on the current system and in the current environment |
| system | The action is performed on the system and environment defined by the specified location name |
Time-out
If a remote system has been specified in the ‘System’ parameter, the entry in this ‘parameter’ specifies the maximum time allowed for this action to be sent to the remote system. If the time elapses without the action being sent, the send is aborted and the action fails.
| *DFT | The Batch mode time-out period specified on the Work with Remote Locations display is used |
| 1-600 | Enter a specific time-out period (in seconds) |
Delay
Specifies the time delay in seconds before the action is invoked. If the alert is manually closed before the specified time elapses, the action is not performed.
External Log action
The External Log action can be used to send the details of the alert to a physical file. If the specified file does not already exist, it is automatically created.
There are two levels of detail that can be specified for the External Log action:
-
Basic (*FMT1)
-
Detailed (*FMT2)
External log file/library
Specifies the qualified name of the external log file and library to which the alert information is added. If the file does not already exist, it is automatically created.
Log format
Specifies the level of detail to be used for the external log.
| *FMT1 | This format is the same as that used by Halcyon Message Manager v5.3 and earlier. To check the details for this format, use the command; DSPFFD FILE(HALxxx/HALEL1) where xxx is the name of your environment |
| *FMT2 | This format records more information than *FMT1 and uses longer but variable length parameters. To check the format details run command; DSPFFD FILE(HALxxx/HALEL2) where xxx is the name of your environment |
Delay
Specifies the time delay in seconds before the action is invoked. If the alert is manually closed before the specified time elapses, the action is not performed.
Hold Rule action
Selecting the Hold Rule action allows you to hold either the current or a referenced rule if an alert is triggered by this rule.
Rule to hold
Specifies on which rule the Hold Rule action is performed.
| *CURRENT | The rule that invoked this action is held |
| *REF | The Hold Rule action is performed on the rule specified by the entries in the subsequent qualifier parameters that are displayed when Enter is pressed |
Re-Release
Specifies whether the rule being held should be automatically released.
| *NO | The rule is not automatically released |
| *AFTER | The rule is automatically released after the specified period of time has elapsed |
| *AT | The rule is automatically released when the specified date and time are reached. A future date and time must be specified |
Delay
Specifies the time delay in seconds before the action is invoked. If the alert is manually closed before the specified time elapses, the action is not performed.
Release Rule action
Selecting the Release Rule action allows you to release either the current or a referenced rule if an alert is triggered by this rule.
Rule to release
Specifies on which rule the Release Rule action is performed.
| *CURRENT | The rule that invoked this action is released |
| *REF | The Release Rule action is performed on the rule specified by the entries in the subsequent qualifier parameters that are displayed when Enter is pressed |
Delay
Specifies the time delay in seconds before the action is invoked. If the alert is manually closed before the specified time elapses, the action is not performed.
Send Message action
Selecting the Send Message action allows you to send a message to a specified message queue for any alert triggered by this rule.
Message ID
Specifies the Message ID of the pre-defined message to be sent.
| *NONE | No Message ID is sent as part of the message. This indicates that an impromptu message is being sent |
| Msg ID | Specify the message ID to be sent as part of this message |
Message file/Library
When the ‘Message ID’ parameter is entered as a specific message ID, these parameters specify the message file and library that contains the message to be sent. The message file must exist on the system to which the message is being sent.
Alert text
Specifies the message used when reporting the alert. This message may include substitution variables. If &PRBTXT is specified, the Alert text is compiled from the information on the IBM Problem rather than the message that triggered the Rule. If no corresponding IBM Problem exists then &PRBTXT is treated as &ALERT.
System
Specifies the name of the system, as listed on the Work with Remote Locations display, on which to perform the action.
| *LOCAL | The action is performed on the current system and in the current environment |
| system | The action is performed on the system and environment defined by the specified location name |
Time-out
If a remote system has been specified in the ‘System’ parameter, this entry specifies the maximum time allowed for this action to be sent to the remote system. If the time elapses without the action being sent, the send is aborted and the action fails.
| *DFT | The Batch mode time-out period specified on the Work with Remote Locations display is used |
| 1-600 | Enter a specific time-out period (in seconds) |
Message queue
Specifies the name of the message queue to which the message is sent.
Library
Specify the library (or select using F4=Prompt) in which library the chosen message queue resides.
Delay
Specifies the time delay in seconds before the action is invoked. If the alert is manually closed before the specified time elapses, the action is not performed.
Send Text Message action
Selecting the Send Text Message action allows you to send a text message to an email address, cell phone/pager or defined call structure for any alert triggered by this rule. When sending the message as an email, the Send Text Message action uses the user specified in the system default for the User Monitor that triggered the alert.
If you route the email via another environment or IBM i, the default sender is not used and the user running the Primary Communications Monitor on the other environment or IBM i is used, typically QSYSOPR.
The user profile does not exist.
The user profile has been disabled.
The user profile has an expired password (Password *NONE is acceptable).
The user profile is not in the system distribution directory.
In any of the previously specified scenarios, Message Communicator logs the relevant messages and then sends the email using it’s own user profile.
Subject, if email
This specifies the subject text of the email being sent. If the message being sent is not an email then this parameter is ignored.
| *AUTO | The first sentence of the message text is used as the subject. Specifically this can be up to the first occurrence of a period followed by a space or a maximum of 44 characters |
| text | Enter the text that you want to use as the email subject. Substitution variables can be used in this parameter (see Using Substitution Variablesfor more information) |
Alert text
Specifies the message used when reporting the alert. This message may include substitution variables. If &PRBTXT is specified, the Alert text is compiled from the information on the IBM Problem rather than the message that triggered the Rule. If no corresponding IBM Problem exists then &PRBTXT is treated as &ALERT.
System
Specifies the name of the system, as listed on the Work with Remote Locations display, on which to perform the action.
| *LOCAL | The action is performed on the current system and in the current environment |
| system | The action is performed on the system and environment defined by the specified location name |
Time-out
If a remote system has been specified in the ‘System’ parameter, this entry specifies the maximum time allowed for this action to be sent to the remote system. If the time elapses without the action being sent, the send is aborted and the action fails.
| *DFT | The Batch mode time-out period specified on the Work with Remote Locations display is used |
| 1-600 | Enter a specific time-out period (in seconds) |
Message device
Specifies the name of the message device to which the message is sent. The message device can be one of:
-
Cell phone
-
Pager
-
Email address
Specify the required email address. Substitution variables can be used in the ‘Address’ parameter, for example; &JOBUSER@halcyonsofware.com.
-
Call schedule
-
Call rota
-
Broadcast group
-
Escalation list
Message priority
Specifies the priority used to send the message to the message device.
When a message is sent to a cell phone or pager and there is a queue of messages waiting to be sent, the priority setting is used to determine in which order the messages are sent.
When a message is sent as an email, this setting specifies which distribution queue is used and also specifies the message importance.
| *AUTO |
The system decides the priority to use as follows:
|
||||||
| *HIGH | The message is sent with High priority | ||||||
| *NORMAL | The message is sent with Normal priority | ||||||
| *LOW | The message is sent with Low priority |
Times to send & interval
Specifies the number of times to send this message. The message is repeated at each interval for the number of times specifies or until the alert is closed. If a broadcast group, call schedule, call rota or escalation list is specified, this parameter applies to all selected phones and pagers. This parameter is ignored if the message is sent as an email.
Alarm tones, if phone
If the message is being sent to a cell phone, the entry in this parameter specifies whether a voice call is sent to the phone prior to the message being sent and which tone to use. If the message is being sent to any device other than a mobile phone, the entry in this parameter has no effect. In order to work, the %TONES functionality must be present in the Communications Script, otherwise this parameter has no effect.
The tones played for *TONE1 through *TONE4 are defined within the TC35SND script. Therefore, if you want to change these you must manually update the script.The maximum number of tones that can be played within a tone set is 21.
When the Call-Before functionality is enabled, the script performs a voice call to the cell phone prior to sending the SMS. If the call is answered, a series of tones are played, the call hangs up and then the SMS message is sent. If the call is not answered, an error is returned and the SMS message is not sent. However, if retries are enabled, further attempts may be made later.
| *NONE | %TONES is set to 0. Call-Before functionality is not required |
| *TONE 1-4 | %TONES is set at a value between 1 and 4. Any of these values indicate that Call-Before is active. The script uses the different values to determine which series of tones to send |
Delay
Specifies the time delay in seconds before the action is invoked. If the alert is manually closed before the specified time elapses, the action is not performed.
Send SNMP Trap action
The Send SNMP Trap action is used to send the alert as an SNMP Trap via an SNMP manager.
Alert text
Specifies the message used when reporting the alert. This message may include substitution variables. See Using Substitution Variables for more information. If &PRBTXT is specified, the Alert text is compiled from the information on the IBM Problem rather than the message that triggered the Rule. If no corresponding IBM Problem exists then &PRBTXT is treated as &ALERT.
SNMP manager
Specifies the SNMP to which the message is sent. The SNMP trap is sent using TCP/UDP. Because of the behavior of this protocol, the successful completion of this action does not guarantee that the message was received by the trap manager.
| *DFT | The SNMP tap is sent using the manger specified in the system default HAL/SNMPMANAGER |
| *LOCAL | The message is sent to an SNMP manager on the local IBM i system |
| host or ip | Enter the host name or IP Address of the default SNMP trap manager. If a host name is used, the entry must be defined within either the TCP/IP Host table or via a domain name server |
Alert type
Specifies the type of alert that is generated.
| *AUTO |
If this alert is being defined within an action schedule, the alert type defined for the action schedule is used, unless the Alert type defined for the action schedule is *AUTO. If this is the case or this is an independent action, the Alert type depends on the message severity as follows:
|
||||||||
| INFO | Information | ||||||||
| COMP | Completion | ||||||||
| CRITICAL | Critical | ||||||||
| ERROR | Error | ||||||||
| WARN | Warning |
Severity
Specifies the console severity of the alert, i.e. the level of importance given to the SNMP Trap message when it arrives at the console.
| *SAME | If the alert is caused by a message detected by Message Manager, the message severity is used as the severity. Otherwise, the severity level is zero |
| COMP | Enter the console severity to use |
Delay
Specifies the time delay in seconds before the action is invoked. If the alert is manually closed before the specified time elapses, the action is not performed.
Syslog Action
The Syslog action allows the sending of the message to a syslog.
Select the Syslog Action and press Enter to automatically change the Action Type to COMMAND. The Command Line is pre-defined with the Syslog (SNDSYSLOG) command, pre-populated with substitution variables for this action. Use F16=Substitution Variables to amend these variables if required.
CCSID
Specifies whether to run the command using a specific coded character set identifier (CCSID). The text entered within the command/message is evaluated for the CCSID specified. If not valid, an error message is shown.
| *SYSVAL | The action monitor runs the command using the CCSID defined in the IBM system value QCCSID |
| 1-65533 | The command is run using the specified CCSID |
System
Specifies the name of the system, as defined on the Work with Remote Locations display, on which to perform the action.
| *LOCAL | The action is performed on the current system and in the current environment |
| system | The action is performed on the system and environment defined by the specified location name |
Time-Out
If a remote system has been specified in the System parameter, the entry in this field specifies the maximum time allowed for this action to be sent to the remote system. If the time elapses without the action being sent, the send is aborted and the action fails.
| *DFT | The Batch mode time-out period specified on the Work with Remote Locations display is used |
| 1-600 | Enter a specific time-out period (in seconds) |
Delay
Specifies the delay before the action is invoked. If the alert is closed before the specified time elapses, the action is not performed. Specify a value in the range 0-9999 seconds.