Syntax
$REDBAPI |
SERVICE=LIST CLASS=cc [RULESET=ruleset-name] [RULEID=message-rule-id] |
Use
Use this call to list EventView rule set or message rule definitions in the knowledge base.
If you make this call from an NCL procedure, ensure that you add the following statement before the call:
&CONTROL SHRVARS=(ZRELST)
Operands
|
Operand |
Description |
|---|---|
|
SERVICE=LIST |
Indicates that selected definitions in the knowledge base are to be listed in &ZRELSTnnnn variables. |
|
CLASS=cc |
Specifies the two digit identifier of the EventView class to which the definitions belong as follows: 93 for rule sets and 94 for message rules. |
|
RULESET=ruleset-name |
Identifies the rule sets to be listed, or specifies the name of the rule set that owns the message rules to be listed. If you are listing rule sets, the value is generic. For example, if RULESET=SUP, then rule sets with names that start with SUP are matched. |
|
RULEID=message-rule-id |
Specifies the IDs of the message rules to list. The ID is the first word of the message text. The value is generic. For example, if RULEID=JBB1, then message rules with a first word that starts with JBB1 are matched. |
Returned Variables
|
Variable |
Description |
|---|---|
|
&ZRELSTnnnn |
Each knowledge base definition entry is returned in an &ZRELSTnnnn variable. |
|
&SYSMSG |
Contains the message returned by $REDBAPI. |
Return Codes
The following return codes indicate the success or failure of the list processing:
|
&RETCODE |
Meaning |
|---|---|
|
0 |
Processing was successful. |
|
8 |
Processing failed. |
|
16 |
Error occurred in call syntax. |
Example
The following example retrieves the list of all rule sets:
&CALL PROC=$REDBAPI + SHARE=(ZRELST>) + PARMS=(SERVICE=LIST,+ CLASS=93)