SAP ABAP Class CL_ESH_TST_HIL_LOG_HIERARCHY (Hierarchical Logging)

Hierarchy

☛ SAP_BASIS (Software Component) SAP Basis Component
   ⤷ BC-EIM-ESH (Application Component) NetWeaver Enterprise Search
     ⤷ S_ESH_TST_HIERARCHY_LOG (Package) Hierarchy log

Meta Relationship - Using

#	Relationship type	Using	Short Description	Created on
1	Inheritance (c INHERITING FROM c_ref)	CL_ESH_CO_LOGGING	Logging	20100218

Properties

Class	CL_ESH_TST_HIL_LOG_HIERARCHY
Short Description	Hierarchical Logging
Super Class	CL_ESH_CO_LOGGING	Logging
Instantiability of a Class	2	Public
Final	☑

General Data

Message Class
Program status
Category	0
Package	S_ESH_TST_HIERARCHY_LOG	Hierarchy log
Created	20100218	SAP
Last change	20110908	SAP
Shared Memory-enabled	☐
Fixed point arithmetic	☑
Unicode checks active	☑

Forward declarations

Class CL_ESH_TST_HIL_LOG_HIERARCHY has no forward declaration.

Interfaces

Class CL_ESH_TST_HIL_LOG_HIERARCHY has no interface implemented.

Friends

Class CL_ESH_TST_HIL_LOG_HIERARCHY has no friend class.

Attributes

#	Attribute	Level	Visibility	Read only	Typing	Associated Type	Initial Value	Description	Created on
1	SC_MSG_ADD_SAP_NOTE	Constant	Public	☐	Type reference (TYPE)	MSGNR	'012'	Message add SAP Note	20100420
2	SC_MSG_ENTER_SIMPLE_TASK	Constant	Public	☐	Type reference (TYPE)	MSGNR	'015'	Message enter simple task	20100527
3	SC_MSG_ENTER_TASK	Constant	Public	☐	Type reference (TYPE)	MSGNR	'002'	Message enter task	20100218
4	SC_MSG_ENTER_TEMPLATE_TASK	Constant	Public	☐	Type reference (TYPE)	MSGNR	'004'	Message enter template task	20100218
5	SC_MSG_ID_HIERARCHY_LOG	Constant	Public	☐	Type reference (TYPE)	MSGID	'ESH_TST_HIL_LOG_MSG'	Application area	20100218
6	SC_MSG_LEAVE_SIMPLE_TASK	Constant	Public	☐	Type reference (TYPE)	MSGNR	'016'	Message leave simple task	20100527
7	SC_MSG_LEAVE_TASK	Constant	Public	☐	Type reference (TYPE)	MSGNR	'003'	Message leave task	20100218
8	SC_MSG_LEAVE_TEMPLATE_TASK	Constant	Public	☐	Type reference (TYPE)	MSGNR	'005'	Message leave template task	20100218
9	SC_MSG_MULTILINE_END	Constant	Public	☐	Type reference (TYPE)	MSGNR	'042'	Message end multiline string	20100420
10	SC_MSG_MULTILINE_LINE	Constant	Public	☐	Type reference (TYPE)	MSGNR	'041'	Message multiline line	20100420
11	SC_MSG_MULTILINE_START	Constant	Public	☐	Type reference (TYPE)	MSGNR	'040'	Message start multiline string	20100420
12	SC_MSG_PARAMETER	Constant	Public	☐	Type reference (TYPE)	MSGNR	'008'	Message for logging a parameter	20100219
13	SC_MSG_SET_SEVERITY	Constant	Public	☐	Type reference (TYPE)	MSGNR	'007'	Message set severity	20100218
14	SC_MSG_SET_TASK_NAME	Constant	Public	☐	Type reference (TYPE)	MSGNR	'006'	Message set task name	20100218
15	SC_MSG_SEVERITY_EXPLICITELY	Constant	Public	☐	Type reference (TYPE)	MSGNR	'009'	Message set severity explicitely	20100420
16	SC_PARAMETER_TASKNAME	Constant	Public	☐	Type reference (TYPE)	STRING	'TASKNAME'	Parameter task name	20100420
17	SC_PARSE_ROOT_KEY	Constant	Public	☐	Type reference (TYPE)	ESH_E_TST_FWK_KEY	'PARSE_ROOT'	Key of artificial root object	20100218
18	SC_SEVERITY_ERROR	Constant	Public	☐	Type reference (TYPE)	ESH_E_TST_FWK_SEVERITY	'E'	Severity error	20100218
19	SC_SEVERITY_INIT	Constant	Public	☐	Type reference (TYPE)	ESH_E_TST_FWK_SEVERITY	'I'	Severity init	20100505
20	SC_SEVERITY_SKIPPED	Constant	Public	☐	Type reference (TYPE)	ESH_E_TST_FWK_SEVERITY	'K'	Severity skipped	20100505
21	SC_SEVERITY_SUCCESS	Constant	Public	☐	Type reference (TYPE)	ESH_E_TST_FWK_SEVERITY	'S'	Severity success/info	20100218
22	SC_SEVERITY_WARNING	Constant	Public	☐	Type reference (TYPE)	ESH_E_TST_FWK_SEVERITY	'W'	Severity warning	20100218
23	SC_STATUS_ABORTED	Constant	Public	☐	Type reference (TYPE)	ESH_E_TST_FWK_STATUS	'A'	Status aborted	20100219
24	SC_STATUS_FINISHED	Constant	Public	☐	Type reference (TYPE)	ESH_E_TST_FWK_STATUS	'F'	Status finished	20100218
25	SC_STATUS_NOT_STARTED	Constant	Public	☐	Type reference (TYPE)	ESH_E_TST_FWK_STATUS	'X'	Status not started	20100218
26	SC_STATUS_RUNNING	Constant	Public	☐	Type reference (TYPE)	ESH_E_TST_FWK_STATUS	'R'	Status running	20100218
27	ST_LOG_DATA	Static Attribute	Protected	☐	Type reference (TYPE)	TT_LOG_DATA		Table log data	20100218

Methods

#	Method	Level	Visibility	Method type	Description	Created on
1	ADD_SAP_NOTE	Instance method	Public	Method	Add SAP Note	20100420
2	ADD_STRING	Instance method	Public	Method	Add string to log (string is split into multiple lines)	20100420
3	ENTER_SIMPLE_TASK	Instance method	Public	Method	Enter simple task	20100527
4	ENTER_TASK	Instance method	Public	Method	Enter task	20100218
5	ENTER_TEMPLATE_TASK	Instance method	Public	Method	Enter template task	20100218
6	GET_HIERARCHY_LOG	Static method	Public	Method	Get instance	20100218
7	GET_LOG_DATA	Static method	Public	Method	Get log data	20100218
8	GET_LOG_DATA_FROM_DB	Static method	Protected	Method	Get log data from DB	20100218
9	LEAVE_SIMPLE_TASK	Instance method	Public	Method	Leave task	20100527
10	LEAVE_TASK	Instance method	Public	Method	Leave task	20100218
11	LEAVE_TEMPLATE_TASK	Instance method	Public	Method	Leave template task	20100218
12	READ_MULTILINE_STRING	Static method	Protected	Method	Read multiline string	20100420
13	SAVE_HIL_APPLICATION_LOG	Instance method	Public	Method	Save the application log with no parameter in messages	20100709
14	SET_PARAMETER	Instance method	Public	Method	Set parameter (parameter is persisted in log)	20100219
15	WRITE_MULTILINE_LINE	Instance method	Protected	Method	Write single line of multiline string to log	20100420
16	WRITE_MULTILINE_STRING	Instance method	Protected	Method	Write multiline string to log	20100420

Events

Class CL_ESH_TST_HIL_LOG_HIERARCHY has no event.

Types

#	Type	Visibility	Typing	Associated Type	Description	Created on	Type Source
1	TS_LOG_DATA	Public	See coding		Log data	20100218	BEGIN OF ts_log_data, log_handle TYPE balloghndl, log_header type BAL_S_LOG, root_log_entry TYPE REF TO CL_ESH_TST_HIL_LOG_ENTRY_TASK, tasks TYPE tt_task_data, END OF ts_log_data
2	TS_TASK_DATA	Public	See coding		Task data	20100218	BEGIN OF ts_task_data, task_key TYPE ESH_E_TST_FWK_KEY, task_log_entry TYPE REF TO CL_ESH_TST_HIL_LOG_ENTRY_TASK, END OF ts_task_data
3	TT_LOG_DATA	Public	See coding		Table log data	20100218	tt_log_data TYPE SORTED TABLE OF ts_log_data WITH UNIQUE KEY log_handle
4	TT_TASK_DATA	Public	See coding		Table task data	20100218	tt_task_data TYPE SORTED TABLE OF ts_task_data WITH UNIQUE KEY task_key

Method Signatures

Method ADD_SAP_NOTE Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	IV_NOTE_NUMBER	Call by reference	☐	Type reference (TYPE)	I		Note number	20100420

Method ADD_SAP_NOTE on class CL_ESH_TST_HIL_LOG_HIERARCHY has no exception.

Method ADD_STRING Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	IV_MSGTY	Call by reference	☐	Type reference (TYPE)	SYMSGTY		Message Type	20100420
2	Importing	IV_STRING	Call by reference	☐	Type reference (TYPE)	STRING		String	20100420

Method ADD_STRING on class CL_ESH_TST_HIL_LOG_HIERARCHY has no exception.

Method ENTER_SIMPLE_TASK Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	IV_SEVERITY_SET_EXPLICITELY	Call by reference	☑	Type reference (TYPE)	FLAG		Severity has to be set explicitely when leaving task	20100527
2	Importing	IV_TASK_KEY	Call by reference	☐	Type reference (TYPE)	ESH_E_TST_FWK_KEY		Task key	20100527
3	Importing	IV_TASK_NAME	Call by reference	☑	Type reference (TYPE)	ESH_E_TST_FWK_NAME		Task name	20100527

Method ENTER_SIMPLE_TASK on class CL_ESH_TST_HIL_LOG_HIERARCHY has no exception.

Method ENTER_TASK Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	IV_SEVERITY_SET_EXPLICITELY	Call by reference	☑	Type reference (TYPE)	FLAG		Severity has to be set explicitely when leaving task	20100420
2	Importing	IV_TASK_KEY	Call by reference	☐	Type reference (TYPE)	ESH_E_TST_FWK_KEY		Task key	20100218
3	Importing	IV_TASK_NAME	Call by reference	☑	Type reference (TYPE)	ESH_E_TST_FWK_NAME		Task name	20100218

Method ENTER_TASK on class CL_ESH_TST_HIL_LOG_HIERARCHY has no exception.

Method ENTER_TEMPLATE_TASK Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	IV_TASK_KEY	Call by reference	☐	Type reference (TYPE)	ESH_E_TST_FWK_KEY		Task key	20100218
2	Importing	IV_TASK_NAME	Call by reference	☑	Type reference (TYPE)	ESH_E_TST_FWK_NAME		Task name	20100218

Method ENTER_TEMPLATE_TASK on class CL_ESH_TST_HIL_LOG_HIERARCHY has no exception.

Method GET_HIERARCHY_LOG Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	IV_APPLICATION_LOG_HANDLE	Call by reference	☑	Type reference (TYPE)	BALLOGHNDL		Application Log: Log Handle	20100218
2	Importing	IV_APPLICATION_LOG_SUBOBJECT	Call by reference	☑	Type reference (TYPE)	BALSUBOBJ		Application Log: Subobject	20100218
3	Importing	IV_EXTNUMBER	Call by reference	☑	Type reference (TYPE)	BALNREXT		Application Log: External ID	20100218
4	Returning	RR_LOG	Value transfer	☐	Object reference (TYPE REF TO)	CL_ESH_TST_HIL_LOG_HIERARCHY		Hierarchical logging	20100218

#	Exception	Resumable	Description	Created on
1	CX_ESH_CO_INVALID_PARAMETER	☐	Invalid Parameter	20100218

Method GET_LOG_DATA Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Exporting	ER_LOG_DATA	Call by reference	☐	Object reference (TYPE REF TO)	TS_LOG_DATA		Log data	20100218
2	Importing	IV_FLG_FORCE_DB_READ	Call by reference	☑	Type reference (TYPE)	ESH_E_TST_FWK_FORCE_DB_READ		Force read from DB	20100218
3	Importing	IV_LOG_HANDLE	Call by reference	☐	Type reference (TYPE)	BALLOGHNDL		Application Log: Log Handle	20100218

Method GET_LOG_DATA on class CL_ESH_TST_HIL_LOG_HIERARCHY has no exception.

Method GET_LOG_DATA_FROM_DB Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	IR_LOG_DATA	Call by reference	☐	Object reference (TYPE REF TO)	TS_LOG_DATA		Log data	20100218
2	Importing	IV_LOG_HANDLE	Call by reference	☐	Type reference (TYPE)	BALLOGHNDL		Application Log: Log Handle	20100218

Method GET_LOG_DATA_FROM_DB on class CL_ESH_TST_HIL_LOG_HIERARCHY has no exception.

Method LEAVE_SIMPLE_TASK Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	IV_SEVERITY	Call by reference	☑	Type reference (TYPE)	CHAR1		Severity	20100527
2	Importing	IV_TASK_KEY	Call by reference	☐	Type reference (TYPE)	ESH_E_TST_FWK_KEY		Task key	20100527

Method LEAVE_SIMPLE_TASK on class CL_ESH_TST_HIL_LOG_HIERARCHY has no exception.

Method LEAVE_TASK Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	IV_SEVERITY	Call by reference	☑	Type reference (TYPE)	CHAR1		Severity	20100218
2	Importing	IV_TASK_KEY	Call by reference	☐	Type reference (TYPE)	ESH_E_TST_FWK_KEY		Task key	20100218

Method LEAVE_TASK on class CL_ESH_TST_HIL_LOG_HIERARCHY has no exception.

Method LEAVE_TEMPLATE_TASK Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	IV_TASK_KEY	Call by reference	☐	Type reference (TYPE)	ESH_E_TST_FWK_KEY		Task key	20100218

Method LEAVE_TEMPLATE_TASK on class CL_ESH_TST_HIL_LOG_HIERARCHY has no exception.

Method READ_MULTILINE_STRING Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Exporting	EV_STRING	Call by reference	☐	Type reference (TYPE)	STRING		Multiline string	20100420
2	Exporting	EV_STRING_NAME	Call by reference	☐	Type reference (TYPE)	STRING		Name of multiline string	20100420
3	Importing	IT_MSG_HANDLES	Call by reference	☐	Type reference (TYPE)	BAL_T_MSGH		Application Log: Message Handle Table	20100420
4	Importing	IV_LOG_HANDLE	Call by reference	☐	Type reference (TYPE)	BALLOGHNDL		Application Log: Log Handle	20100420

Method READ_MULTILINE_STRING on class CL_ESH_TST_HIL_LOG_HIERARCHY has no exception.

Method SAVE_HIL_APPLICATION_LOG Signature

Method SAVE_HIL_APPLICATION_LOG on class CL_ESH_TST_HIL_LOG_HIERARCHY has no parameter.
Method SAVE_HIL_APPLICATION_LOG on class CL_ESH_TST_HIL_LOG_HIERARCHY has no exception.

Method SET_PARAMETER Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	IV_PARAMETER	Call by reference	☐	Type reference (TYPE)	ESH_S_TST_FWK_PARAMETER		Parameter	20100219

Method SET_PARAMETER on class CL_ESH_TST_HIL_LOG_HIERARCHY has no exception.

Method WRITE_MULTILINE_LINE Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	IV_LINE	Call by reference	☐	Type reference (TYPE)	STRING		Line of multiline string	20100420

Method WRITE_MULTILINE_LINE on class CL_ESH_TST_HIL_LOG_HIERARCHY has no exception.

Method WRITE_MULTILINE_STRING Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	IV_STRING	Call by reference	☐	Type reference (TYPE)	STRING		String	20100420
2	Importing	IV_STRING_NAME	Call by reference	☐	Type reference (TYPE)	STRING		Name of string	20100420

Method WRITE_MULTILINE_STRING on class CL_ESH_TST_HIL_LOG_HIERARCHY has no exception.

History

Last changed by/on	SAP	20110908
SAP Release Created in	730