Define filter settings for message output
Component: | BS2000 |
Functional area: | Operator terminal control |
Domain: | CONSOLE-MANAGEMENT |
Privileges: | OPERATING |
Routing code: | @ |
Function
The ADD-CONSOLE-FILTER command allows operators to define filter settings (combinations of routing codes and filter levels) for some or all routing codes to control message output at operator terminals (consoles) or from authorized user programs. Filter settings the command does not refer to stay as they are. Messages which expect a reply (response messages) and messages sent to a specific recipient (typically command result messages) cannot be suppressed. The ADD-CONSOLE-FILTER command appreciably reduces the volume of message output. It applies only to the operator terminal or authorized user program at or from which it was issued.
Running the command in a user task with the OPERATING privilege
Like any operator terminal, the user task can set filter levels exclusively for itself. The filter levels are effective only when the task is reading from the input stream. When the user task terminates, all the filter levels that it has set are returned to their previous settings.
This function is available regardless of system parameters.
Format
ADD-CONSOLE-FILTER |
FILTER = *ALL / list-poss(5): <integer 1..5> ,ROUTING-CODE = *ALL / list-poss(40): <alphanum-name 1..1> / * |
Operands
FILTER = *ALL / list-poss(5): <integer 1..5>
Defines which filter levels are to be set.
FILTER = *ALL
Sets all filter levels. All command-independent messages which do not expect a reply are suppressed.
FILTER = list-poss(5): <integer 1..5>
Sets the specified filter levels.
ROUTING-CODE = *ALL / list-poss(40): <alphanum-name 1..1> / *
There are 40 routing codes. The filter levels specified in the FILTER operand are set for the routing codes specified here.
ROUTING-CODE = *ALL
All 40 routing codes are affected by the change.
ROUTING-CODE = list-poss(40): <alphanum-name 1..1> / *
The routing codes explicitly specified here are affected by the change.
Return codes
(SC2) | SC1 | Maincode | Meaning |
|---|---|---|---|
0 | CMD0001 | Command executed successfully | |
1 | CMD0202 | Syntax error in the command | |
2 | CMD0198 | Shutdown in progress | |
64 | CMD0216 | User does not have the necessary privilege | |
130 | NBR1042 | Not enough class 5 memory; cannot set filter levels |
Note
Using the OPR parameter service, filter levels for routing codes can be defined for operator terminals and authorized user programs with generated authorization names. If this has not been done, all messages generated between the time the system is initialized and the time the ADD-CONSOLE-FILTER command is issued will be output.
Authorized user programs with dynamic authorization names have no routing codes when first connected. That means that there are no filter levels operative for them at that point.
When an authorized user program with a dynamic authorization name is disconnected, all its filter levels and routing codes are returned to their previous settings.
The REMOVE-CONSOLE-FILTER command can be used to cancel message suppression actions taken with the ADD-CONSOLE-FILTER command.
For further information on routing codes and filter levels see the manual “Introduction to System Administration” [14].