Show event stream attributes
Component: | BS2000 |
Functional area: | Job processing |
Domain: | CONSOLE-MANAGEMENT |
Privileges: | STD-PROCESSING |
Function
The SHOW-SYSEVENT-LOG-ATTRIBUTES command shows which event streams can be represented under the user’s own ID and their current attributes. Event streams which are already closed (inactive) can be displayed only if they were not deleted upon termination (see the ASSIGN-SYSEVENT-STREAM, CLOSE-MODE operand).
The command supports structured output in S variables (see "Output in S variables").
Privileged functions
Systems support staff (OPERATING privilege) can obtain information on all existing system event streams (operands LOG-ID=*ALL-ACCESSIBLE and TYPE=*ANY/*SYSTEM-LOG).
Format
SHOW-SYSEVENT-LOG-ATTRIBUTES |
Operands
LOG-ID = *BY-OWN-TASK / *ALL-ACCESSIBLE / <alphanum-name 1..4>
Identifies the event streams for which information is required.
LOG-ID = *BY-OWN-TASK
Displays the attributes of all event streams which are assigned to the user task and can still be represented.
LOG-ID = *ALL-ACCESSIBLE
Displays the attributes of all event streams for which the user’s own task has access authorization. These are all the event streams which are assigned to the user’s own task and to tasks with the same user ID.
Only for users with OPERATING privilege:
If this value is specified in combination with TYPE=*SYSTEM-LOG or *ANY (default), information is supplied for all existing system event streams, regardless of user ID.
LOG-ID = <alphanum-name 1..4>
Supplies information on the event stream with the specified name. The name may also begin with numeric characters (if LOG-ID was set to *OWN-TSN when the stream was assigned).
SELECT = *ALL / *BY-ATTRIBUTES(...)
Governs whether the set of event streams selected by the LOG-ID operand is to be restricted by applying further selection criteria.
SELECT = *ALL
Information is required for all the event streams selected by the LOG-ID operand.
SELECT = *BY-ATTRIBUTES(...)
Information is required only for those event streams which meet the following selection criteria.
STATUS = *ANY / *ACTIVE / *CLOSED
Supplies information on event streams which are in the specified status.
STATUS = *ANY
Information is required for all event streams, regardless of status.
STATUS = *ACTIVE
Information is required for all active event streams (currently assigned and not closed).
STATUS = *CLOSED
Information is required for all closed event streams.
TYPE = *ANY / *USER-LOG / *SYSTEM-LOG
Reserved for users with OPERATING privilege.
Supplies information on the specified type of event stream.
TYPE = *ANY
Information is required for all event streams, regardless of type.
TYPE = *USER-LOG
Information is required for user event streams only.
TYPE = *SYSTEM-LOG
Information is required for system event streams only.
Return codes
(SC2) | SC1 | Maincode | Meaning |
|---|---|---|---|
0 | CMD0001 | Command successfully executed | |
1 | 0 | NBR3104 | No event stream matches selection criteria |
1 | 0 | NBR3105 | No event stream being managed |
2 | 0 | OPS0002 | Interrupt (e.g. K2 key) during S variable generation |
1 | CMD0202 | Syntax error | |
32 | NBR3199 | Internal error on command server | |
32 | CMD2009 | Error on output to S variables (e.g. subsystem not available) | |
64 | CMD0216 | User does not have required privilege |
Output formats
Information on event streams is output in a fixed format. The output includes the name of the event stream (Log-Id), the user ID and TSN of the user task, the current status and the type and setting of the event stream being logged. If a number of event streams match the selection criteria, the attributes of that number of event streams are displayed. The output format shown below is output for each matching event stream.
Attribute output for multiple event streams can be aborted with the [K2] key.
Example: Output format for an active system event stream
SHOW-SYSEVENT-LOG-ATTRIBUTES 2012-06-29 16:04:34 ------------------------------------------------------------------------------ LOG-ID: 0LSI USER-ID: USERXY01 TYPE: USER OWNER-TSN: 0LSI STATUS: ACTIVE CLOSE-MODE: DELETE-EVENTS SYNCHRONOUS-EVENTS LOGGED: SYSOUT-MSG: NO CMD: NO STMT: NO ------------------------------------------------------------------------------ SHOW-SYSEVENT-LOG-ATTRIBUTES END OF DISPLAY
Output in S variables
If different operands are specified, the results of the command differ in the number of event streams on which information is output. A set of S variables is supplied with values for each event stream.
Output information | Name of the S variable | T | Contents | Condition |
|---|---|---|---|---|
The event stream is deleted after canceling the assignment | var(*LIST).CLOSE-MODE | S | *DELETE-EVENTS | |
The command inputs from the user task executed via SDF are logged | var(*LIST).CMD | S | *NO | |
Name of the event stream | var(*LIST).LOG-ID | S | <alphan.-name 1..4> | |
Status of the event stream | var(*LIST).STA | S | *ACTIVE | |
The command inputs from statements within a user program in the user task which are executed via SDF are logged | var(*LIST).STMT | S | *NO | |
The messages from command servers and user programs sent to SYSOUT are logged | var(*LIST).SYSOUT-MSG | S | *NO | |
TSN of the dialog task | var(*LIST).TSN | S | <alphan.-name 1..4> | |
Type of the event stream which is assigned to the user task | var(*LIST).TYPE | S | *SYS-LOG | |
User ID of the dialog task | var(*LIST).USER-ID | S | <name 1..8> |