7.4.4 User message trace

You can acquire the following contents as user message trace in messaging infrastructure of HCSC server:

Request for invoking service component received in request reception or response messages
Requests when business process is invoked or response messages
Requests when service components are invoked from service adapter or response results
Messages before and after transformation when data transformation is executed

For the user message traces for normal processing, you can output the information for only specific HCSC components. For details, see (2) Specifying the HCSC components for which user message traces are to be output.

Important note: The user message traces that are output to files include raw message content. Therefore, you must take special care to prevent security problems such as information leakage.

The contents output in user message trace are configured from following three parts:

User message trace start
User message trace data
User message trace end

The description of each part is as follows:

This section describes how to view the user message traces that have been collected. For details about how to collect user message traces, see 7.3.2(4) Collecting user message traces.

Organization of this subsection

(1) Output destination of user message traces
(2) Specifying the HCSC components for which user message traces are to be output
(3) Output format and output content of user message trace start
(4) Output format and output contents of user message trace data
(5) Output format and output contents of user message trace end
(6) Timing of user message trace output
(7) Collection point of user message trace

(1) Output destination of user message traces

The following shows the output destination of user message traces:

Path specified for the telegramtrace-filepath property in the HCSC server runtime definition file

If the specified path does not exist or is invalid, traces are output to the default output destination.

The following table shows user message trace file names.

Table 7‒39: User message trace file names
Trace file output mode	Trace file name
In wraparound mode	`csctelegram_HCSC-server-name_N.log`
In shift mode	`csctelegram_HCSC-server-name_.log`

For details about the number of files and maximum file size, see 7.3.2(4) Collecting user message traces.

To Page Top

(2) Specifying the HCSC components for which user message traces are to be output

To output the user message traces for normal processing, specify the target HCSC components by using either of the following properties in the HCSC server runtime definition file:

telegramtrace-component-type-filepath (specification by the HCSC component type)
telegramtrace-component-id-filepath (specification by the HCSC component ID)

For details about the HCSC server runtime definition file, see 6.5.6 HCSC server runtime definition file in the Service Platform Reference Guide.

To Page Top

(3) Output format and output content of user message trace start

(a) Output format

The following figure shows the output format of user message trace start:

Figure 7‒20: Output format of user message trace start

(b) Output content

The following table lists and describes contents output to user message trace start.

Table 7‒40: Contents output to user message trace start
Item		Content
Number		The request identification information (parent ID) is displayed.
Date		The trace record collection date (yyyy/mm/dd format) is output.
Time		The trace record collection time (hh:mm:ss.sss format) in milliseconds in local time is output.
Product ID		An identifier to identify the product is output. CSCMSG: Messaging infrastructure CSCBP: Business process
pid		The ID to identify the process is output.
tid		The ID to identify the thread is output.
ID		Not displayed.
Message trace start collection point identification information	Message trace start	The character string "telegramtrace started" indicating the user message trace start is output.
	Collection location	The trace collection point (collection location) is output: RCP:Standard reception URCP:User-defined reception BPRCP:Business process request reception BPREQ:Invoking a business process SVC: Invoking Service components (within the service adapter) CNVST:Data transformation of service adapter BPCNV:Data transformation activity of business process BPASG:Assign activity of business process BPJAV:Invoke Java activity of business process BPSVC:Invoke service activity of business process BPVLD:Validation activity of business process BPFLT:Throw activity of business process BPRPL:Reply activity of business process BPSWT:Switch activity of business process
	Protocol type	The trace collection point information (protocol type) is output. SOAP: Web Services EJB: SessionBean WSR:MDB (WS-R) DBQ:MDB (DB queue) CUSTM:Protocols other than those mentioned above Blank: If the collection location is: BPRCP or BPREQ Business process
	Detailed location	Outputs the trace collection point information (detailed location): IN:Reception OUT: Response ERR: After error detection CAL: Invocation (Invoking business process or service) RET: Receiving response (Response for business process or invoking service) RQB:Before data transformation when the request is from service adapter RSA:After data transformation when the response is from service adapter CVB:Before data transformation activity of business process CVA:After data transformation activity of business process ASB:Before assign activity of business process ASA:After assign activity of business process RQA:After the data transformation when the request is from User-defined reception RSB: Before the data transformation when the response is from User-defined reception
	Message common ID	The request identification information (parent ID) is output.
Additional information		The following additional information is output: (a) For request reception or service adapter Service request ID Service name (service name) Client correlation ID(Client ID) PRF root application information (RootApInfo) (b) For business process Process instance ID Business process name (Process Definition Name) Activity name (Activity Definition Name) Variable definition name (Variable Name) PRFroot application information (RootApInfo) (c) For fault messages of request reception Service request ID Service name (service name) Client correlation ID(Client ID) PRFroot application information (RootApInfo) Fault name (fault name) (d) For fault message of business process Process instance ID Business process name (Process Definition Name) Activity name (Activity Definition Name) PRFroot application information (RootApInfo) Fault name (fault name)
CRLF		Record end code is output.

To Page Top

(4) Output format and output contents of user message trace data

(a) Output format

The following figure shows the output format of the user message trace data:

Figure 7‒21: Output format of user message trace data

(b) Output contents

The following table lists and describes the information that is output to the user message trace data.

Table 7‒41: Contents output to user message trace data
Item		Content
Number		The request identification information (parent ID) is displayed.
Date		The trace record collection date (yyyy/mm/dd format) is output.
Time		The trace record collection time (hh:mm:ss.sss format) in milliseconds in local time is output.
Product ID		An identifier to specify the product is output. CSCMSG: Messaging infrastructure CSCBP: Business process
pid		The ID to identify the process is output.
tid		The ID to identify the thread is output.
ID		Not displayed.
Message trace data information	Output position (Hexadecimal format)	Offset value (Hexadecimal format) from the beginning of the user message is output.
	Data (Hexadecimal format)	Contents (Hexadecimal format) of user message are output.
	Data (ASCII format)	Contents (ASCII format) of user message are output. ASCII characters are output when the range is 0x20~0x7E. Period (.) is output if out of range.
CRLF		Record end code is output.

Note

For SOAP messages, the following information included in the user message is output in the user message trace data:

[Figure] Multiple child elements including soap:Header element

[Figure] One child element of soap:Body element

If the soap:Header element does not exist, only child element of soap: Body element is output as information.

To Page Top

(5) Output format and output contents of user message trace end

(a) Output format

The following figure shows the output format of user message trace end:

Figure 7‒22: Output format of user message trace end

(b) Output content

The following table lists and describes contents output to user message trace end:

Table 7‒42: Contents output to user message trace end
Item		Output
Number		The request identification information (parent ID) is displayed.
Date		The trace record collection date (yyyy/mm/dd format) is output.
Time		The trace record collection time (hh:mm:ss.sss format) in milliseconds in local time is output.
Product ID		An identifier to specify the product is output. CSCMSG:Messaging infrastructure CSCBP:Business process
Pid		The ID to identify the process is output.
Tid		The ID to identify the thread is output.
ID		Not displayed.
Message trace end collection point identification information	Message trace end	The character string "telegramtrace ended" indicating user message trace end is output.
	Collection location	The trace collection point (collection location) is output: RCP:Standard reception URCP:User-defined reception BPRCP:Business process request reception BPREQ:Invoking a business process SVC: Invoking Service components (within the service adapter) CNVST:Data transformation of service adapter BPCNV:Data transformation activity of business process BPASG:Assign activity of business process BPJAV:Invoke Java activity of business process BPSVC:Invoke service activity of business process BPVLD:Validation activity of business process BPFLT:Throw activity of business process BPRPL:Reply activity of business process BPSWT:Switch activity of business process
	Protocol type	The trace collection point information (protocol type) is output. SOAP: Web Services EJB: SessionBean WSR:MDB (WS-R) DBQ:MDB (DB queue) CUSTM:Protocols other than those mentioned above Blank: If the collection location is: BPRCP or BPREQ Business process
	Detailed location	Outputs the trace collection point information (detailed location): IN: Reception OUT: Response ERR: After error detection CAL: Invocation (Invoking business process or service) RET: Receiving response (Response for business process or invoking service) RQB:Before data transformation when the request is from service adapter RSA:After data transformation when the response is from service adapter CVB:Before data transformation activity of business process CVA:After data transformation activity of business process ASB:Before assign activity of business process ASA:After assign activity of business process
	Message common ID	The request identification information (parent ID) is output.
Additional information		The length (decimal format) of user message is output as additional information. When there is no user message, "0"or "null" is output.
CRLF		Record end code is output.

To Page Top

(6) Timing of user message trace output

Specify the timing of user message trace output in the telegramtrace-trigger property of the HCSC server runtime definition file. The following table lists and describes the output timings and combination with messages that can be specified with the telegramtrace-trigger property. Default timing in property is "NORMAL".

Table 7‒43: Output timings and combination with messages that can be specified in the telegramtrace-trigger property
Property value	Timing	Message type
Property value	Timing	Request message	Response message	Fault message
NORMAL	At the time of normal processing	Y	Y	N
	At the time of detecting system exceptions	N	N	N
	At the time of detecting faults (without catch)	N	N	N
	At the time of detecting faults (with catch)	N	N	N
SYSERR	At the time of normal processing	N	N	N
	At the time of detecting system exceptions	Y	N	N
	At the time of detecting faults (without catch)	Y	N	N
	At the time of detecting faults (with catch)	N	N	N
FAULT	At the time of normal processing	N	N	N
	At the time of detecting system exceptions	N	N	N
	At the time of detecting faults (without catch)	Y	N	Y
	At the time of detecting faults (with catch)	Y	N	Y

Legend:

Y: Output

N: Not output

To Page Top

(7) Collection point of user message trace

The collection point differs depending on the trigger to output a user message trace as follows:

NORMAL (Executing individual services (when there is no data transformation))
NORMAL (Executing individual services (when there is data transformation))
NORMAL(when invoking a business process)
NORMAL(when executing business process services)
NORMAL (when the HCSC component specified by the user ends normally)
SYSERR (at the time of detecting system exceptions)
FAULT(at the time of detecting faults)

(a) NORMAL (Executing individual services (when there is no data transformation))

The following figure shows the collection point of user message trace when executing individual services (when there is no data transformation):

Figure 7‒23: Collection point of user message trace (Executing individual services (when there is no data transformation))

The following table lists trace collection points. The "Number in figure" in this table corresponds to the numbers in "Figure 7-23 Collection point of user message trace (Executing individual services (when there is no data transformation))".

Table 7‒44: User message trace collection point (Executing individual services (when there is no data transformation))
Number in figure	Trace collection point
1	Entry to standard reception (Web Services)
2	Exit from standard reception (Web Services)
1	Entry to standard reception (SessionBean)
2	Exit from standard reception (SessionBean)
1	Entry to standard reception (MDB(WS-R))
2	Exit from standard reception (MDB(WS-R))
1	Entry to standard reception (MDB(DB queue))
2	Exit from standard reception (MDB(DB queue))
3	Invocation of service components of SOAP adapter
4	Point for receiving response from service components of SOAP adapter
3	Invocation of service components of SessionBean adapter
4	Point for receiving response from service components of SessionBean adapter
3	Invocation of service components of MDB (WS-R) adapter
4	Point for receiving response from service components of MDB (WS-R) adapter
3	Invocation of service components of MDB (DB queue) adapter
4	Point for receiving response from service components of MDB (DB queue) adapter
3	Invocation of service components of service adapters(CUSTOM) other than those mentioned above
4	Point for receiving response from service components of service adapters(CUSTOM) other than those mentioned above

(b) NORMAL (Executing individual services(in case of data transformation))

The following figure shows the trace collection point of user message trace when executing individual services (in case of data transformation):

Figure 7‒24: Collection point of user message trace (Executing individual services (in case of data transformation))

The following table lists trace collection points. The "Number in figure" in this table corresponds to the numbers in "Figure 7-24 Collection point of user message trace (Executing individual services (in case of data transformation))".

Table 7‒45: User message trace collection point (executing individual services (in case of data transformation))
Number in figure	Trace collection point
1	Entry to standard reception (Web Services)
2	Exit from standard reception (Web Services)
1	Entry to standard reception (SessionBean)
2	Exit from standard reception (SessionBean)
1	Entry to standard reception (MDB(WS-R))
2	Exit from standard reception (MDB(WS-R))
1	Entry to standard reception (MDB(DB queue))
2	Exit from standard reception (MDB(DB queue))
3	Before data transformation when defining the standard message definition of SOAP adapter
4	After data transformation when defining the standard message definition of SOAP adapter
3	Before data transformation when defining the standard message definition of SessionBean adapter
4	After data transformation when defining the standard message definition of SessionBean adapter
3	Before data transformation when defining the standard message definition of MDB (WS-R) adapter
4	After data transformation when defining the standard message definition of MDB (WS-R) adapter
3	Before data transformation when defining the standard message definition of MDB (DB queue)
4	After data transformation when defining the standard message definition of MDB (DB queue)
3	Before data transformation when defining the standard message definition of service adapter (CUSTOM) other than those mentioned above
4	After data transformation when defining the standard message definition of service adapter (CUSTOM) other than those mentioned above
5	Invocation of service components of SOAP adapter
6	Point for receiving response from service components of SOAP adapter
5	Invocation of service components of SessionBean adapter
6	Point for receiving response from service components of SessionBean adapter
5	Invocation of service components of MDB (WS-R) adapter
6	Point for receiving response from service components of MDB (WS-R) adapter
5	Invocation of service components of MDB (DB queue) adapter
6	Point for receiving response from service components of MDB (DB queue) adapter
5	Invocation of service components of service adapters(CUSTOM) other than those mentioned above
6	Point for receiving response from service components of service adapters(CUSTOM) other than those mentioned above

(c) NORMAL (when invoking a business process)

The following figure shows the trace collection point of the user message trace when invoking business process:

Figure 7‒25: Collection point of user message trace (when invoking a business process)

The following table lists trace collection points. The "Number in figure" in this table corresponds to the numbers in "Figure 7-25 Collection point of user message trace (when invoking a business process)".

Table 7‒46: User message trace collection point (when invoking a business process)
Number in figure	Trace collection point
1	Entry to standard reception (Web Services)
2	Exit from standard reception (Web Services)
1	Entry to standard reception (SessionBean)
2	Exit from standard reception (SessionBean)
1	Entry to standard reception (MDB(WS-R))
2	Exit from standard reception (MDB(WS-R))
1	Entry to standard reception (MDB(DB queue))
2	Exit from standard reception (MDB(DB queue))
1	Entry to user-defined reception
2	Exit from user-defined reception
3	Invocation of business process services
4	Point for receiving response from business process services

(d) NORMAL(when executing business process services)

The following figure shows the trace collection point of the user message trace when executing business process services:

Figure 7‒26: Collection point of user message trace (when executing business process services)

The following table lists trace collection points. The "Number in figure" in this table corresponds to the numbers in "Figure 7-26 Collection point of user message trace (when executing business process services)".

Table 7‒47: User message trace collection point (when executing business process services)
Number in figure	Trace collection point
1	Entry to standard reception (Web Services)
2	Exit from standard reception (Web Services)
1	Entry to standard reception (SessionBean)
2	Exit from standard reception (SessionBean)
1	Entry to standard reception (MDB (WS-R))
2	Exit from standard reception (MDB (WS-R))
1	Entry to standard reception (MDB (DB queue))
2	Exit from standard reception (MDB (DB queue))
1	Entry to user-defined reception
2	Exit from user-defined reception
7	Invocation of service components of SOAP adapter
8	Point for receiving response from service components of SOAP adapter
7	Invocation of service components of SessionBean adapter
8	Point for receiving response from service components of SessionBean adapter
7	Invocation of service components of MDB (WS-R) adapter
8	Point for receiving response from service components of MDB (WS-R) adapter
7	Invocation of service components of MDB (DB queue) adapter
8	Point for receiving response from service components of MDB (DB queue) adapter
7	Invocation of service components of service adapters (CUSTOM) other than those mentioned above
8	Point for receiving response from service components of service adapters(CUSTOM) other than those mentioned above
3	Invocation of business process services
4	Point for receiving response from business process services
5	Entry to business process reception
6	Exit from business process reception
9	Transformation source of data transformation activity^#1
10	Transformation destination of data transformation activity
11	Copy source of assign activity^#2^,^#3
12	Copy destination of assign activity

Note#1: When multiple transformation source variables are defined, user message traces for the number of variables defined are output.
Note#2: When there are no messages (character strings, numeric values, or authentic value), the character string expression of variable is output as binary data encoded in UTF-8 as a user message.
Note#3: The user message trace is not output when you specify format (Xpath) or a constant in copy source.

(e) NORMAL (when the HCSC component specified by the user ends normally)

The following figure shows the trace collection points that are used in the case where the target HCSC component for the user message trace is specified. No traces are output within the message delivery control and business process.

The target HCSC component is specified by using the telegramtrace-component-type-filepath or telegramtrace-component-id-filepath property in the HCSC server runtime definition file.

Figure 7‒27: User message trace collection points (when the HCSC component specified by the user ends normally)

The following table lists trace collection points. The numbers in the Number in figure column correspond to the circled numbers in Figure 7-27 User message trace collection points (when the HCSC component specified by the user ends normally).

Table 7‒48: User message trace collection points (when the HCSC component specified by the user ends normally)
Number in figure	Trace collection point
1	Entry to the standard reception (web service)
2	Exit from the standard reception (web service)
1	Entry to the standard reception (Session Bean)
2	Exit from the standard reception (Session Bean)
1	Entry to the standard reception (MDB (WS-R))
2	Exit from the standard reception (MDB (WS-R))
1	Entry to the standard reception (MDB (DB queue))
2	Exit from the standard reception (MDB (DB queue))
1	Entry to a user-defined reception
2	Exit from a user-defined reception
3	Point for receiving a response from data transformation (request message)
4	Point for invoking data transformation (response message)
5	Point for invoking JSON-XML transformation in the custom reception framework (request message)
6	Point for receiving a response from JSON-XML transformation in the custom reception framework (response message)
7	Point for invoking a service component of the SOAP adapter
8	Point for receiving a response from a service component of the SOAP adapter
7	Point for invoking a service component of the Session Bean adapter
8	Point for receiving a response from a service component of the Session Bean adapter
7	Point for invoking a service component of the MDB (WS-R) adapter
8	Point for receiving a response from a service component of the MDB (WS-R) adapter
7	Point for invoking a service component of the MDB (DB queue) adapter
8	Point for receiving a response from a service component of the MDB (DB queue) adapter
7	Point for invoking a service component of a service adapter other than the preceding ones (custom adapter)
8	Point for receiving a response from a service component of a service adapter other than the preceding ones (custom adapter)
9	Point for invoking data transformation (request message)
10	Point for receiving a response from data transformation (response message)
11	Point for invoking JSON-XML transformation in the custom adapter development framework
12	Point for receiving a response from JSON-XML transformation in the custom adapter development framework

(f) SYSERR (At the time of detecting system exceptions)

The following figure shows the trace collection point of the user message trace when a system exception (does not include system error such as OutOfMemoryError) is detected:

Figure 7‒28: Collection point of user message trace (At the time of detecting system exceptions)

The following table describes the trace collection point. The "Number in figure" in this table corresponds to the numbers in Figure 7-28.Furthermore, standby activity, switch activity, while activity, and link connection is output.

Table 7‒49: User message trace collection point (At the time of detecting system exceptions)
Number in figure	Output point	Output message	Details of user message trace start
Number in figure	Output point	Output message	Collection point	Protocol type	Detailed location
1	Request reception (when invoking a service)	Requester side message	RCP/URCP	SOAP/EJB/ WSR/DBQ/ CUSTM	ERR
2	Invoke Java activity	Argument when invoking Java program^#1#2	BPJAV	-
3	Invoke service activity	Request message when invoking services	BPSVC
4	Data transformation activity	Transformation source variable^#2	BPCNV
5	Assign activity	Copy source variable^#3	BPASG
6	Validation activity	Variable to be validated^#2	BPVLD
7	Reply activity	Response message to requester	BPRPL
8	Throw activity	Variable that throws faults	BPFLT

Legend:

-:Not applicable.

Note#1

When there are no messages (character strings, numeric values, or authentic value), the character string expression of variable is output as binary data encoded in UTF-8 as a user message.

Note#2

When multiple transformation source variables are defined, user message traces for the number of variables defined are output.

Note#3

The user message trace is not output in the following cases:

When you specify format (Xpath) in copy source

When you specify a constant in copy source

(g) FAULT (at the time of detecting faults)

The following figure shows the trace collection point of the user message trace when a fault is detected:

Figure 7‒29: Collection point of user message trace (at the time of detecting faults)

The following table describes the trace collection point. The "Number in figure" in this table corresponds to the numbers in Figure 7-29.

Table 7‒50: User message trace collection point (at the time of detecting faults)
Number in figure	Output point	Output message	Details of user message trace start
Number in figure	Output point	Output message	Collection point	Protocol type	Detailed location
1	Request reception (when invoking a service)	Request message	RCP/URCP	SOAP/EJB/ WSR/DBQ	ERR
1	Request reception (when invoking a service)	Fault message	RCP/URCP	-
2	Invoke Java activity	Argument when invoking Java program^#1#2	BPJAV
2	Invoke Java activity	Fault message	BPJAV
3	Invoke service activity	Request message when invoking services	BPSVC
3	Invoke service activity	Fault message	BPSVC
4	Validation activity	Variable to be validated^#2	BPVLD
4	Validation activity	Fault message	BPVLD
5	Throw activity	Variable that throws faults^#3	BPFLT
6	Data transformation activity	Transformation source variable^#2	BPCNV
6	Data transformation activity	Fault message	BPCNV
7	Assign activity	Copy source variable^#4	BPASG
7	Assign activity	Fault message	BPASG
8	Switch activity	Fault message	BPSWT

Legend:

-:Not applicable.

Note#1

When there are no messages (character strings, numeric values, or authentic value), the character string expression of variable is output as binary data encoded in UTF-8 as a user message.

Note#2

When multiple transformation source variables are defined, user message traces for the number of variables defined are output.

Note#3

Since the variable information and fault message match, fault message is not output.

Note#4

When a fault exception occurs in a state when multiple copy source variables are defined, the copy source variable that caused to occur the fault is output in the log.

The user message trace is not output in the following cases:

When you specify format (Xpath) in copy source

When you specify constant in copy source

To Page Top