SAP ABAP Class CL_ESH_QL_QUERY_LOG_EXPORT (Query Log Export Tools)

Hierarchy

☛ SAP_BASIS (Software Component) SAP Basis Component
   ⤷ BC-EIM-ESH (Application Component) NetWeaver Enterprise Search
     ⤷ S_ESH_ENG_QUERY_LOGGING (Package) Query Logging

Properties

Class	CL_ESH_QL_QUERY_LOG_EXPORT
Short Description	Query Log Export Tools
Super Class
Instantiability of a Class	2	Public
Final	☑

General Data

Message Class
Program status
Category	0
Package	S_ESH_ENG_QUERY_LOGGING	Query Logging
Created	20091204	SAP
Last change	20110908	SAP
Shared Memory-enabled	☐
Fixed point arithmetic	☑
Unicode checks active	☑

Forward declarations

#	Type group / Object type	Type	Type Description
1	ICON	Type group use (TYPE-POOLS tp)	Type group use (TYPE-POOLS tp)

Interfaces

Class CL_ESH_QL_QUERY_LOG_EXPORT has no interface implemented.

Friends

Class CL_ESH_QL_QUERY_LOG_EXPORT has no friend class.

Attributes

#	Attribute	Level	Visibility	Read only	Typing	Associated Type	Initial Value	Description	Created on
1	LC_DOMA_IF_FOLLOW_UP_QTYPE	Constant	Private	☐	Type reference (TYPE)	DOMNAME	'ESH_D_IF_FOLLOW_UP_QUERY_TYPE'	Domain ESH_D_IF_FOLLOW_UP_QUERY_TYP	20100810
2	LC_DOMA_IF_SEARCH_EXEC_MODE	Constant	Private	☐	Type reference (TYPE)	DOMNAME	'ESH_D_IF_SEARCH_EXEC_MODE'	Domain ESH_D_IF_SEARCH_EXEC_MODE	20100301
3	LC_DOMA_QL_QUERY_TYPE	Constant	Private	☐	Type reference (TYPE)	DOMNAME	'ESH_D_QL_QUERY_TYPE'	Domain ESH_D_QL_QUERY_TYPE	20100301
4	MR_LOG_READER	Instance attribute	Private	☐	Object reference (TYPE REF TO)	CL_ESH_QL_QUERY_LOG_ACCESS_API		ESH Query Log Access API	20091204
5	MT_DOMA_IF_FOLLOW_UP_QTYPE	Instance attribute	Private	☐	Type reference (TYPE)	DD07V_TAB		Value texts ESH_D_IF_FOLLOW_UP_QUERY_TYP	20100810
6	MT_DOMA_IF_SEARCH_EXEC_MODE	Instance attribute	Private	☐	Type reference (TYPE)	DD07V_TAB		Value texts ESH_D_IF_SEARCH_EXEC_MODE	20100301
7	MT_DOMA_QL_QUERY_TYPE	Instance attribute	Private	☐	Type reference (TYPE)	DD07V_TAB		Value texts ESH_D_QL_QUERY_TYPE	20100810
8	MV_TXT_AND_ATTRIB_COND_MULT	Instance attribute	Private	☐	Type reference (TYPE)	CHAR64		Text: 'AND further attribute conditions' (004)	20100813
9	MV_TXT_AND_ATTRIB_COND_ON	Instance attribute	Private	☐	Type reference (TYPE)	CHAR64		Text: 'AND attribute condition on attribute' (003)	20100813
10	MV_TXT_AND_QUERY_PARTS	Instance attribute	Private	☐	Type reference (TYPE)	CHAR64		Text: '(Query using query parts)' (002)	20100813
11	MV_TXT_ATTRIB_COND	Instance attribute	Private	☐	Type reference (TYPE)	CHAR64		Text: 'Attribute condition:' (005)	20100813
12	MV_TXT_ATTRIB_COND_MULT	Instance attribute	Private	☐	Type reference (TYPE)	CHAR64		Text: 'Attribute conditions on multiple attributes' (007)	20100813
13	MV_TXT_ATTRIB_COND_SELOPT	Instance attribute	Private	☐	Type reference (TYPE)	CHAR64		Text: 'Attribute condition: Select Option on Attr' (006)	20100813
14	MV_TXT_ERROR	Instance attribute	Private	☐	Type reference (TYPE)	CHAR64		Text: 'Log Access Error: Cannot retrieve' (011)	20100813
15	MV_TXT_INT_QUERY	Instance attribute	Private	☐	Type reference (TYPE)	CHAR64		Text: 'Query in internal format' (008)	20100813
16	MV_TXT_INT_QUERY_FS	Instance attribute	Private	☐	Type reference (TYPE)	CHAR64		Text: 'Query in internal format (Freestyle Query)' (009)	20100813
17	MV_TXT_NO_QUERY	Instance attribute	Private	☐	Type reference (TYPE)	CHAR64		Text: '' (001)	20100813
18	MV_TXT_QUERY_PARTS	Instance attribute	Private	☐	Type reference (TYPE)	CHAR64		Text: ' (Query using query parts)' (010)	20100813

Methods

#	Method	Level	Visibility	Method type	Description	Created on
1	ACCESS_API	Instance method	Public	Method	Access API	20091204
2	CHECK_STRINGFILTER_MATCHES	Instance method	Private	Method	Check string filter vs. query	20091208
3	DOMA_READ_DISPLAY_TEXTS	Instance method	Private	Method	Get display texts from domain definition	20100301
4	GET_ICON	Instance method	Private	Method	Get icon	20100301
5	GET_INSTANCE	Static method	Public	Method	Get instance	20091204
6	IMPORT_LOG_TO_LOGMONITOR	Instance method	Public	Method	Import log (log-monitor list format)	20091204
7	IMPORT_LOG_TO_LOGMONITOR_BY_ID	Instance method	Public	Method	Import log (log-monitor list format) by ID list	20100218
8	LOG_LIST_EXTRACT_DATA_PROVIDER	Instance method	Private	Method	Extract query details for data provider	20100125
9	LOG_LIST_EXTRACT_QUERY_DETAILS	Instance method	Private	Method	Extract query details for display	20100122
10	PROVIDE_BLOCK_FROM_ID	Instance method	Public	Method	Provide data for NEXT	20100122
11	PROVIDE_BLOCK_FROM_TSP	Instance method	Public	Method	Provide data for NEXT (time-based)	20100122
12	PROVIDE_DATA_BY_ID	Instance method	Public	Method	Provide data for GET_DATA	20100122
13	QUERY_GET_EXCERPT_FOR_DISPLAY	Instance method	Private	Method	Get query excerpt from query, for display	20091204
14	QUERY_GET_TYPE_INFO	Instance method	Private	Method	Get query type information (longtext, display icon)	20100301
15	SET_ACTION_ICON	Instance method	Private	Method	Set action icon	20091207
16	SET_CONNECTOR_DETAILS	Instance method	Private	Method	Set connector details	20091204
17	SET_QUERY_DISPLAY_TEXTS	Instance method	Private	Method	Set display texts for query	20100813
18	SET_STATUS_ITEM	Instance method	Private	Method	Set status item	20091204
19	SET_STATUS_ROOT	Instance method	Private	Method	Set status root	20091204

Events

Class CL_ESH_QL_QUERY_LOG_EXPORT has no event.

Types

Class CL_ESH_QL_QUERY_LOG_EXPORT has no local type.

Method Signatures

Method ACCESS_API Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Returning	RR_ACCESS_API	Value transfer	☐	Object reference (TYPE REF TO)	CL_ESH_QL_QUERY_LOG_ACCESS_API		ESH Query Log Access API	20091204

Method ACCESS_API on class CL_ESH_QL_QUERY_LOG_EXPORT has no exception.

Method CHECK_STRINGFILTER_MATCHES Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	IS_QUERY_DETAILS	Call by reference	☑	Type reference (TYPE)	ESH_S_QL_QUERY_DETAILS		Query Details	20091208
2	Importing	IV_QUERY_LANGU	Call by reference	☑	Type reference (TYPE)	ESH_E_QL_QUERY_LANGU		Logon Language on Query Execution	20091215
3	Importing	IV_QUERY_STRING	Call by reference	☐	Type reference (TYPE)	STRING		Query String	20091208
4	Importing	IV_TERMBASED_ONLY	Call by reference	☑	Type reference (TYPE)	CHAR01		Termbased Queries only	20091215
5	Returning	RV_IS_FOUND	Value transfer	☐	Type reference (TYPE)	CHAR01		Is found	20091208

Method CHECK_STRINGFILTER_MATCHES on class CL_ESH_QL_QUERY_LOG_EXPORT has no exception.

Method DOMA_READ_DISPLAY_TEXTS Signature

Method DOMA_READ_DISPLAY_TEXTS on class CL_ESH_QL_QUERY_LOG_EXPORT has no parameter.
Method DOMA_READ_DISPLAY_TEXTS on class CL_ESH_QL_QUERY_LOG_EXPORT has no exception.

Method GET_ICON Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	IV_ID	Call by reference	☐	Type reference (TYPE)	ICON_D		Icon ID	20100301
2	Importing	IV_INFOTEXT	Call by reference	☑	Type reference (TYPE)	ANY		Icon Infotext	20100301
3	Importing	IV_NAME	Call by reference	☑	Type reference (TYPE)	ANY		Icon Name	20100301
4	Returning	RV_ICON	Value transfer	☐	Type reference (TYPE)	CHAR64		Icon	20100301

Method GET_ICON on class CL_ESH_QL_QUERY_LOG_EXPORT has no exception.

Method GET_INSTANCE Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Returning	RR_EXPORTER	Value transfer	☐	Object reference (TYPE REF TO)	CL_ESH_QL_QUERY_LOG_EXPORT		Log Export	20091204

Method GET_INSTANCE on class CL_ESH_QL_QUERY_LOG_EXPORT has no exception.

Method IMPORT_LOG_TO_LOGMONITOR Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Exporting	ET_QLOG_DISPLAY	Call by reference	☐	Type reference (TYPE)	ESH_T_QL_QLOG_DISPLAY		Query Log Display Structure	20091204
2	Importing	IT_SCOPE	Call by reference	☑	Type reference (TYPE)	ESH_T_FED_SCOPE		Scope	20091204
3	Importing	IV_EXEC_MODE	Call by reference	☑	Type reference (TYPE)	ESH_E_QL_EXEC_MODE		Execution Type	20091204
4	Importing	IV_EXEC_USER	Call by reference	☑	Type reference (TYPE)	USERNAME		User	20091204
5	Importing	IV_FROM_TSP	Call by reference	☑	Type reference (TYPE)	TIMESTAMPL		From	20091204
6	Importing	IV_QUERY_LANGU	Call by reference	☑	Type reference (TYPE)	ESH_E_QL_QUERY_LANGU		Logon Language on Query Execution	20091215
7	Importing	IV_QUERY_STRING	Call by reference	☑	Type reference (TYPE)	STRING		Query Searchstring / Text from Query	20091208
8	Importing	IV_QUERY_TYPE	Call by reference	☑	Type reference (TYPE)	ESH_E_QL_QUERY_TYPE		Query Type	20091204
9	Importing	IV_REFERENCE_QUERY	Call by reference	☑	Type reference (TYPE)	ESH_E_IF_SEARCH_EXEC_ID		Search Connector ID	20091204
10	Importing	IV_RET_MAX_NR_RECORDS	Call by reference	☑	Type reference (TYPE)	I		Max. number of records	20091204
11	Importing	IV_SESSION_ID	Call by reference	☑	Type reference (TYPE)	ESH_E_IF_SEARCH_SESSION_ID		Session ID	20091204
12	Importing	IV_SUCCESSF_QUERIES_ONLY	Call by reference	☑	Type reference (TYPE)	ESH_E_CO_BOOLEAN		Only executions which returned at least 1 result	20091204
13	Importing	IV_TERMBASED_ONLY	Call by reference	☑	Type reference (TYPE)	ESH_E_CO_BOOLEAN		Only termbased queries	20091215
14	Importing	IV_TO_TSP	Call by reference	☑	Type reference (TYPE)	TIMESTAMPL		To	20091204
15	Importing	IV_WITH_ACTIONS_ONLY	Call by reference	☑	Type reference (TYPE)	ESH_E_CO_BOOLEAN		Only executions with User Actions	20091207
16	Importing	IV_WITH_ERRORS_ONLY	Call by reference	☑	Type reference (TYPE)	ESH_E_CO_BOOLEAN		Only executions with Error	20091204

#	Exception	Resumable	Description	Created on
1	CX_ESH_QL_NOT_AUTHORIZED	☐	Log Access Denied - Not Authorized	20100122

Method IMPORT_LOG_TO_LOGMONITOR_BY_ID Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Exporting	ET_QLOG_DISPLAY	Call by reference	☐	Type reference (TYPE)	ESH_T_QL_QLOG_DISPLAY		Query Log Display Structure	20100218
2	Importing	IT_EXEC_ID	Call by reference	☐	Type reference (TYPE)	ESH_T_QL_SEARCH_EXEC_ID		Search Execution ID List	20100218

#	Exception	Resumable	Description	Created on
1	CX_ESH_QL_NOT_AUTHORIZED	☐	Log Access Denied - Not Authorized	20100218

Method LOG_LIST_EXTRACT_DATA_PROVIDER Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Exporting	ET_QLOG_DATA_PROVIDER	Call by reference	☐	Type reference (TYPE)	ESH_T_QL_QLOG_DATA_PROVIDER		Query Log Data provider	20100125
2	Importing	IT_QLOG_HEADERS	Call by reference	☐	Type reference (TYPE)	ESH_T_QL_QLOG		Query Log Header	20100125
3	Importing	IV_TERMBASED_ONLY	Call by reference	☑	Type reference (TYPE)	ESH_E_CO_BOOLEAN		Boolean	20100125

Method LOG_LIST_EXTRACT_DATA_PROVIDER on class CL_ESH_QL_QUERY_LOG_EXPORT has no exception.

Method LOG_LIST_EXTRACT_QUERY_DETAILS Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Exporting	ET_QLOG_DISPLAY	Call by reference	☐	Type reference (TYPE)	ESH_T_QL_QLOG_DISPLAY		Query Log Display Structure	20100122
2	Importing	IT_QLOG_HEADERS	Call by reference	☐	Type reference (TYPE)	ESH_T_QL_QLOG		Query Log Header	20100122
3	Importing	IV_QUERY_LANGU	Call by reference	☑	Type reference (TYPE)	ESH_E_QL_QUERY_LANGU		Logon Language on Query Execution	20100122
4	Importing	IV_QUERY_STRING	Call by reference	☑	Type reference (TYPE)	STRING		Query Searchstring / Text from Query	20100122
5	Importing	IV_TERMBASED_ONLY	Call by reference	☑	Type reference (TYPE)	ESH_E_CO_BOOLEAN		Boolean	20100122
6	Importing	IV_WITH_ACTIONS_ONLY	Call by reference	☑	Type reference (TYPE)	ESH_E_CO_BOOLEAN		Only executions with User Actions	20100122

Method LOG_LIST_EXTRACT_QUERY_DETAILS on class CL_ESH_QL_QUERY_LOG_EXPORT has no exception.

Method PROVIDE_BLOCK_FROM_ID Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Exporting	ET_QLOG_DATA_PROVIDER	Call by reference	☐	Type reference (TYPE)	ESH_T_QL_QLOG_DATA_PROVIDER		Query log data provider	20100125
2	Exporting	EV_LAST_ID_IN_BLOCK	Call by reference	☐	Type reference (TYPE)	ESH_E_IF_SEARCH_EXEC_ID		Last ID in Block	20100125
3	Exporting	EV_NO_MORE_DATA	Call by reference	☐	Type reference (TYPE)	CHAR01		No more data	20100125
4	Importing	IV_FROM_ID	Call by reference	☐	Type reference (TYPE)	ESH_E_IF_SEARCH_EXEC_ID		Search Execution ID	20100125
5	Importing	IV_RET_MAX_NR_RECORDS	Call by reference	☐	Type reference (TYPE)	I		Blocksize	20100125
6	Importing	IV_TERMBASED_ONLY	Call by reference	☑	Type reference (TYPE)	CHAR01		Termbased entries only	20100125

#	Exception	Resumable	Description	Created on
1	CX_ESH_QL_NOT_AUTHORIZED	☐	Log Access Denied - Not Authorized	20100125

Method PROVIDE_BLOCK_FROM_TSP Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Exporting	ET_QLOG_DATA_PROVIDER	Call by reference	☐	Type reference (TYPE)	ESH_T_QL_QLOG_DATA_PROVIDER		Query log data provider	20100125
2	Exporting	EV_LAST_TIMESTAMP	Call by reference	☐	Type reference (TYPE)	TIMESTAMPL		Last timestamp in block	20100125
3	Exporting	EV_NO_MORE_DATA	Call by reference	☐	Type reference (TYPE)	CHAR01		No more data	20100125
4	Importing	IV_FROM_TIMESTAMP	Call by reference	☐	Type reference (TYPE)	TIMESTAMPL		From timestamp	20100125
5	Importing	IV_RET_MAX_NR_RECORDS	Call by reference	☐	Type reference (TYPE)	I		Blocksize	20100125
6	Importing	IV_TERMBASED_ONLY	Call by reference	☑	Type reference (TYPE)	CHAR01		Termbased entries only	20100125

#	Exception	Resumable	Description	Created on
1	CX_ESH_QL_NOT_AUTHORIZED	☐	Log Access Denied - Not Authorized	20100125

Method PROVIDE_DATA_BY_ID Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Exporting	ET_QLOG_DATA_PROVIDER	Call by reference	☐	Type reference (TYPE)	ESH_T_QL_QLOG_DATA_PROVIDER		Query log data provider	20100125
2	Importing	IT_EXEC_ID	Call by reference	☐	Type reference (TYPE)	ESH_T_QL_SEARCH_EXEC_ID		Search Execution ID List	20100125
3	Importing	IV_TERMBASED_ONLY	Call by reference	☐	Type reference (TYPE)	CHAR01		Termbased entries only	20100125

#	Exception	Resumable	Description	Created on
1	CX_ESH_QL_NOT_AUTHORIZED	☐	Log Access Denied - Not Authorized	20100125

Method QUERY_GET_EXCERPT_FOR_DISPLAY Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Exporting	EV_QUERY_EXCERPT	Call by reference	☐	Type reference (TYPE)	ESH_E_QL_QUERY_EXCERPT		Query Text / Query Excerpt	20091204
2	Importing	IS_QUERY_DETAILS	Call by reference	☐	Type reference (TYPE)	ESH_S_QL_QUERY_DETAILS		Query Details	20091204

Method QUERY_GET_EXCERPT_FOR_DISPLAY on class CL_ESH_QL_QUERY_LOG_EXPORT has no exception.

Method QUERY_GET_TYPE_INFO Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Exporting	EV_TYPE_DISPLAYTEXT	Call by reference	☐	Type reference (TYPE)	CHAR64		Query Type: Longtext (for display)	20100301
2	Exporting	EV_TYPE_ICON	Call by reference	☐	Type reference (TYPE)	CHAR64		Query Type: Icon w. Quicktext (for display)	20100301
3	Importing	IV_EXEC_MODE	Call by reference	☑	Type reference (TYPE)	ESH_E_IF_SEARCH_EXEC_MODE		Search Execution Mode (Functional/Special)	20100301
4	Importing	IV_QUERY_TYPE	Call by reference	☑	Type reference (TYPE)	ESH_E_QL_QUERY_TYPE		Internal Query Type (Sync, Async, Bulk, Delegated)	20100301
5	Importing	IV_REF_ID	Call by reference	☑	Type reference (TYPE)	ESH_E_IF_SEARCH_EXEC_ID		Search Execution ID	20100301
6	Importing	IV_REF_TYPE	Call by reference	☑	Type reference (TYPE)	ESH_E_QL_REF_TYPE		Parent Query Reference Type	20100301

Method QUERY_GET_TYPE_INFO on class CL_ESH_QL_QUERY_LOG_EXPORT has no exception.

Method SET_ACTION_ICON Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Changing	CS_LOGITEM	Call by reference	☐	Type reference (TYPE)	ESH_S_QL_QLOG_DISPLAY		Query Log Display Structure	20091207

Method SET_ACTION_ICON on class CL_ESH_QL_QUERY_LOG_EXPORT has no exception.

Method SET_CONNECTOR_DETAILS Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Changing	CS_LOGITEM	Call by reference	☐	Type reference (TYPE)	ESH_S_QL_QLOG_DISPLAY		Query Log Display Structure	20091204

Method SET_CONNECTOR_DETAILS on class CL_ESH_QL_QUERY_LOG_EXPORT has no exception.

Method SET_QUERY_DISPLAY_TEXTS Signature

Method SET_QUERY_DISPLAY_TEXTS on class CL_ESH_QL_QUERY_LOG_EXPORT has no parameter.
Method SET_QUERY_DISPLAY_TEXTS on class CL_ESH_QL_QUERY_LOG_EXPORT has no exception.

Method SET_STATUS_ITEM Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Changing	CT_LOGENTRY_ITEM	Call by reference	☐	Type reference (TYPE)	ESH_T_QL_QLOG_DISPLAY		Query Log Display Structure	20091204
2	Importing	IS_LOGENTRY_ROOT	Call by reference	☐	Type reference (TYPE)	ESH_S_QL_QLOG_DISPLAY		Query Log Display Structure	20091204

Method SET_STATUS_ITEM on class CL_ESH_QL_QUERY_LOG_EXPORT has no exception.

Method SET_STATUS_ROOT Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Changing	CT_LOGENTRY_ROOT	Call by reference	☐	Type reference (TYPE)	ESH_T_QL_QLOG_DISPLAY		Query Log Display Structure	20091204

Method SET_STATUS_ROOT on class CL_ESH_QL_QUERY_LOG_EXPORT has no exception.

History

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