SET-COMMUNICATION-TRACE: Control DCM-DIAG

You use the SET-COMMUNICATION-TRACE command to control the diagnostic tool DCM-DIAG, provided the DCM-DIAG subsystem has already been successfully started.

For more information on the DCM-DIAG diagnostic tool and trace file, see "The DCM-DIAG diagnostic tool" and "The DCM-DIAG diagnostic tool".

SET-COMMUNICATION-TRACE is not a console command.

SET-COMMUNICATION-TRACE Controlling DCM-DIAG

SELECT = *TSN(...) / *UID(...)
	*TSN(...)
		|	TSN = *OWN / *ALL / <alphanum-name 1 .. 4>
	*UID(...)
		|	UID = *OWN / <alphanum-name 1 .. 8>
,CMX = *UNCHANGED / *NONE / *ALL / list-poss(6): *ATTACH-DETACH / *NAME-ADDRESS / *CONNECT /
			*TRANSPORT / *OTHERS / *INTERN
,EXTERNAL-USER = *NONE / *USER-ATTRIBUTES(...)
	*USER-ATTRIBUTES(...)
		|	NAME-OF-USER = <alphanum-name 1 .. 8>
		|	,TRACE-INFORMATION = <c-string 1 .. 30> / <x-string 1 .. 60>

SELECT=*TSN(...) / *UID(...)
Specifies the selection criterion

*TSN(TSN=...)
The selection criterion is the TSN. Users only have access to their own TSNs. The administrator may access a foreign (or external) TSN, provided he or she has TSOS or NET-ADMINISTRATION privileges.

TSN=*OWN
*OWN means that the trace is performed for the user ́s own task (default value).

TSN=*ALL
*ALL is primarily intended for system administrators. It selects all TSN's and the event is distributed to all BCAM users.

TSN=<alphanum-name 1..4>
Specifies the TSN of the task for which the trace criteria of one or more communication components are modified.

*UID(UID=...)
The selection criterion is the User ID. Users may only specify their own User IDs.

*UID=*OWN
The trace criteria for one or more communication components running under the own user ID are modified.

UID=<alphanum-name 1..8>
The trace criteria for one or more communication components running under the specified user ID are modified. If the specified user ID is a foreign user ID, TSOS or NET-ADMINISTRATION privileges are required.

CMX=...
Defines the trace criteria for the CMX component.
Changes in the trace setting only take effect after the next action of the corresponding applications.

CMX=*UNCHANGED
The trace settings are not changed (default value).

CMX=*NONE
No further trace records are output; the trace file is closed.

CMX=*ALL
All traces are generated.

CMX=*ATTACH-DETACH
Functions related to attaching/detaching CMX.

CMX=*NAME-ADDRESS
Calls to name and address management.

CMX=*CONNECT
Functions that set up, clear, or redirect connections.

CMX=*TRANSPORT
Calls to send and receive normal and priority data.

CMX=*OTHERS
Functions not belonging to one of the above groups.

CMX=*INTERN
The calls to BS2000 functions are output with the passed parameters and return code as trace records.

EXTERNAL-USER=...
Settings of the trace information for external users.

EXTERNAL-USER=*NONE
No trace settings for external users are specified.

EXTERNAL-USER=*USER-ATTRIBUTES (...)
Trace settings for external users are specified.

NAME-OF-USER=<alphanum-name 1..8>
In this field, the external user specifies a name comprising up to 8 alphanumeric characters. This name is used to construct the file name for the trace file. It is also used as the TRACE name for TEDDY (LIST / TRACE). In addition, the name specified here is used to verify whether the component involved was actually intended.

TRACE-INFORMATION=<c-string 1..30> / <x-string 1..60>
In this 30-character area, the external user enters his or her trace information. Any arbitrary information can be entered by the user here, since the /SET-COMMUNICATION-TRACE command only forwards the information without evaluating it.

List of messages

YDT0000  SET-COMM-TRACE EXECUTED SUCCESSFULLY FOR (&&00)
YDT0001  SET-COMM-TRACE HAS NO EFFECT
YDT0002  TRACE CRITERIA FOR COMPONENT (&&00) MODIFIED
YDT0003  TRACE CRITERIA FOR EXTERNAL USER (&&00) MODIFIED
YDT1001  BCAM ERROR: (&&00) ON T-DIAGDATA-SEND
YDT1002  ERROR ON PARAMETER (&&00)
YDT1003  IT IS NOT POSSIBLE TO SPECIFY A FOREIGN TSN ((&&00))
YDT1004  IT IS NOT POSSIBLE TO SPECIFY A FOREIGN UID ((&&00))
YDT1005  ONLY KEYWORD (&&00) IS ALLOWED
YDT1006  NO EVENT GROUP FOR (&&00) FOUND
YDT1007  NO TASK FOR TSN (&&00) FOUND
YDT1008  USERID (&&00) DOES NOT EXIST

Command return codes

(SC2)      SC1	Maincode	Meaning
0        0	CMD0001	NO ERROR
0        1	CMD0202	Error in command
0       32	YDT1001	See message YDT1001
0        1	YDT1002	See message YDT1002
0       64	YDT1003	See message YDT1003
0       64	YDT1004	See message YDT1004
0        1	YDT1005	See message YDT1005
0        1	YDT1006	See message YDT1006
0        1	YDT1007	See message YDT1007
0        1	YDT1008	See message YDT1008