Declare an ASE element
Component: | ASE |
Functional area: | Error logging |
Domain: | ERROR-LOGGING |
Privileges: | TSOS |
Function
The ADD-ASE-ELEMENT command defines, for a particular set of SERSLOG events, monitoring which triggers specific actions when a defined threshold value for the occurrence of these events is reached. The set of events (RECORD-ID operand) can be defined as a
selection of all messages, with the option of excluding message classes or messages,
selection of one or more specified messages,
selection of a message class, with the option of specifying limitation to one message range and/or of excluding messages.
The defined set of SERSLOG events forms an ASE element within the ASE (Auxiliary SERSLOG Extensions) subsystem for which particular criteria for monitoring and triggering actions are defined in the declaration:
For monitoring purposes, a threshold value (THRESHOLD operand) defines the number of events which can occur before a renewed occurrence will trigger actions. It is also possible to define whether and how the repeated occurrence of the same events is to be handled (SUPPRESS-DUPLICATES, AFTER and SLEEP-TIME operands).
The actions to be triggered (ACTION operand) which can be defined are the logging of the event in the internal buffer, output of a console message or triggering of a Teleservice call. Multiple actions can be combined.
Monitoring can take place for all tasks or be limited to one particular task (TASK operand).
After the declaration has been made, ASE assigns a unique element ID for the ASE element. This ID enables the ASE element to be specified for deletion or for information output.
Information on ASE elements can be requested using the SHOW-ASE-ELEMENT command.
Format
ADD-ASE-ELEMENT | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Operands
RECORD-ID = *ALL(...) / *CLASS(...) / list-poss(10): <alphanum-name 7..7>
Determines the set of SERSLOG events which is to be monitored.
RECORD-ID = *ALL(...)
All SERSLOG events are to be monitored. Entire message classes or individual messages can then be excluded.
EXCLUDE-CLASS = *NONE / list-poss(10): <alphanum-name 3..3>
Specifies message classes which are to be excluded from monitoring. The default *NONE means that no message classes are excluded.
EXCLUDE-RECORD = *NONE / list-poss(10): <alphanum-name 7..7>
Specifies individual messages which are to be excluded from monitoring. The default *NONE means that no messages are excluded.
RECORD-ID = *CLASS(...)
One or all message ranges of a particular message class are to be monitored.
RECORD-CLASS = <alphanum-name 3..3>
Message class which is to be monitored.
FROM = *FIRST /<alphanum-name 4..4>
Specifies the lower limit of the range. The default *FIRST means that the range begins with the first message of the specified message class.
TO = *LAST / <alphanum-name 4..4>
Specifies the upper limit of the range. The default *LAST means that the range ends with the last message of the specified message class.
EXCLUDE-RECORD = *NONE / list-poss(10): <alphanum-name 4..4> / <alphanum-name 7..7>
Specifies individual messages of the specified range which are to be excluded from monitoring. The specification <alphanum-name 4..4> contains the message code which ends with this character string. The default *NONE means that no messages of the range are excluded.
THRESHOLD = *NONE / <integer 2..255>
Specifies a threshold value which, when it is reached, causes the actions specified in the ACTION operand to be executed.
THRESHOLD = *NONE
The first occurrence of a SERSLOG event from the set of record types specified in the RECORD-ID operand triggers actions.
THRESHOLD = <integer 2..255>
The specified number of SERSLOG events from the set specified in the RECORD-ID operand must have occurred in order to trigger actions.
SUPPRESS-DUPLICATES = *NO / *YES(...)
Defines how the repetition of SERSLOG events after the threshold value specified in the THRESHOLD operand has been reached is to be handled.
SUPPRESS-DUPLICATES = *NO
Repeated events trigger actions.
SUPPRESS-DUPLICATES = *YES(...)
Repeated events only trigger actions conditionally.
AFTER = 1 / <integer 1..9>
Determines the number of repetitions as of which the actions are to be suppressed. The default value 1 means that actions are suppressed from the first repetition on.
SLEEP-TIME = *UNLIMITED / <integer 1..999 hours > / <time>
Specifies how long actions are to be suppressed. After the specified period has elapsed, the count associated with the AFTER operand is reinitialized.
ACTION = list-poss(3): *INTERNAL-LOGGING / *CONSOLE-MSG / *TELESERVICE-CALL
Determines the actions which are to be executed when the specified trigger criteria are met. Up to three actions can be specified in a list.
ACTION = *INTERNAL-LOGGING
The event is logged in an internal buffer whose content can be displayed using the SHOW-ASE-LOGGING command.
ACTION = *CONSOLE-MSG
Console message ASE0815 is output.
ACTION = *TELESERVICE-CALL
A Teleservice call is triggered (message ASE0888).
TASK = *ALL / <alphanum-name 4..4> / <c-string 4..4>
Specifies the TSN of the task which is to be monitored. The default *ALL means that all tasks are monitored.
Return codes
(SC2) | SC1 | Maincode | Meaning/Guaranteed messages |
|---|---|---|---|
0 | CMD0001 | Command executed without error | |
1 | ASE0010 | Syntax error | |
32 | CMD0221 | System error | |
64 | ASE0011 | Semantic error |