SAP ABAP Class CL_ESH_QL_QUERY_LOG_AGGREGATOR (Query Log Analyzer)

Hierarchy

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

Meta Relationship - Using

#	Relationship type	Using	Short Description	Created on
1	Interface implementation (CLASS c. INTERFACES i_ref)	IF_ESH_CM_SUGGESTION_MANAGER	ESH Content Management: Suggestion Manager	20100414

Properties

Class	CL_ESH_QL_QUERY_LOG_AGGREGATOR
Short Description	Query Log Analyzer
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	20100414	SAP
Last change	20110908	SAP
Shared Memory-enabled	☐
Fixed point arithmetic	☑
Unicode checks active	☑

Forward declarations

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

Interfaces

#	Interface	Abstract	Final	Description	Created on
1	IF_ESH_CM_SUGGESTION_MANAGER	☐	☐	ESH Content Management: Suggestion Manager	20100414

Friends

Class CL_ESH_QL_QUERY_LOG_AGGREGATOR has no friend class.

Attributes

#	Attribute	Level	Visibility	Read only	Typing	Associated Type	Initial Value	Description	Created on
1	GC_AGGREGATION_BLOCKSIZE	Instance attribute	Private	☐	Type reference (TYPE)	INT4	20000	Aggregator block size	20100414
2	GC_QL_AGGREG_JOBNAME_PREFIX	Constant	Public	☐	Type reference (TYPE)	TBTCJOB-JOBNAME	'ESH_QL_AGG_'	Job name prefix	20100722
3	GC_QL_AGGREG_LOCKARG_PREFIX	Constant	Public	☐	Type reference (TYPE)	ESH_S_CO_LOCKTAB-LOCKARG	'ESH_QL_AGGREGATION~'	Lock key for tables	20100414
4	GC_QL_AGGREG_LOCK_HEADER	Constant	Public	☐	Type reference (TYPE)	RSTABLE-TABNAME	'ESH_QL_AGGREGATION'	Lock header: Query Log Aggregation	20100414
5	MR_ACCESS_RECORDER	Instance attribute	Private	☐	Object reference (TYPE REF TO)	CL_ESH_QL_LOG_ACCESS_RECORDER		Log access recorder (security standard compliance)	20100414
6	MR_LOG_PROCESSOR	Instance attribute	Private	☐	Object reference (TYPE REF TO)	CL_ESH_QT_QLOG_PROCESSOR		Evaluate query log queries	20100414
7	MR_LOG_READER	Instance attribute	Private	☐	Object reference (TYPE REF TO)	CL_ESH_QL_QUERY_LOG_ACCESS_API		ESH Query Log Access API	20100414
8	MR_QL_CUST	Instance attribute	Private	☐	Object reference (TYPE REF TO)	CL_ESH_QL_CUST_CONTAINER		Query log customizing container	20100722
9	MT_LOCKTAB	Instance attribute	Private	☐	Type reference (TYPE)	ESH_T_CO_LOCKTAB		Lock administration table	20100414
10	MV_AGGREGATION_STARTED	Instance attribute	Private	☐	Type reference (TYPE)	CHAR01		Aggregation has been started	20100414
11	MV_AGGREGATION_START_SET	Instance attribute	Private	☐	Type reference (TYPE)	CHAR01		Aggregation start has been set by caller (start timestamp)	20100414
12	MV_AGGREGATION_START_TSP	Instance attribute	Private	☐	Type reference (TYPE)	TIMESTAMPL		Aggregation start timestamp	20100414
13	MV_DEBUG	Instance attribute	Private	☐	Type reference (TYPE)	CHAR01		Debug mode	20100726

Methods

#	Method	Level	Visibility	Method type	Description	Created on
1	AGGREGATOR_EXECUTE	Instance method	Protected	Method	Execute search term aggregator	20100414
2	AGGREGATOR_GET_BLOCK	Instance method	Private	Method	Search term aggregator: Get next block	20100414
3	AGGREGATOR_IS_LOCKED	Static method	Protected	Method	Search term aggregator: Is locked	20100414
4	AGGREGATOR_LOCK	Instance method	Protected	Method	Lock aggregator	20100414
5	AGGREGATOR_UNLOCK	Instance method	Protected	Method	Unlock aggregator	20100414
6	CALCULATE_RANK_VALUE_RANGE	Instance method	Protected	Method	Calculate rank value range based on term frequencies	20100414
7	COMPOSE_JOBNAME	Static method	Private	Method	Compose job name	20100722
8	GET_AGGREGATION_METADATA	Instance method	Private	Method	Get aggregation metadata	20100414
9	GET_AGGREGATION_START_TSP	Instance method	Private	Method	Get aggregation start timestamp	20100414
10	GET_INSTANCE	Static method	Public	Method	Get instance	20100414
11	GET_SEARCHTERM_STATISTICS	Instance method	Public	Method	Get search term statistics	20100414
12	IS_RUNNING	Static method	Public	Method	Query log aggregator is running	20100722
13	SCHEDULE_AGGREGATION	Static method	Public	Method	Schedule query log aggregation	20100722
14	SET_AGGREGATION_START	Instance method	Public	Method	Set aggregation start point-of-time	20100414
15	SET_DEBUG_MODE	Instance method	Public	Method	Set debug mode	20100726

Events

Class CL_ESH_QL_QUERY_LOG_AGGREGATOR has no event.

Types

Class CL_ESH_QL_QUERY_LOG_AGGREGATOR has no local type.

Method Signatures

Method AGGREGATOR_EXECUTE Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Exporting	ET_AGGREGATED_TERMS	Call by reference	☐	Type reference (TYPE)	ESH_T_CM_SUGGESTIONS		Aggregated Terms	20100414
2	Importing	IV_AGGREGATION_BLOCKSIZE	Call by reference	☐	Type reference (TYPE)	INT4	20000	Pre-Aggregation Blocksize	20100414
3	Importing	IV_AGGREGATION_START_TSP	Call by reference	☑	Type reference (TYPE)	TIMESTAMPL		Aggregation Start Timestamp	20100414

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

Method AGGREGATOR_GET_BLOCK Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Changing	CT_AGGREGATED_TERMS	Call by reference	☐	Type reference (TYPE)	ESH_T_CM_SUGGESTIONS		Aggregated Terms	20100414
2	Exporting	EV_FINISHED	Call by reference	☐	Type reference (TYPE)	CHAR01		Finished	20100414
3	Exporting	EV_LAST_ENTRY_TSP	Call by reference	☐	Type reference (TYPE)	TIMESTAMPL		Timestamp of last entry in aggregation	20100414
4	Importing	IV_BLOCKSIZE	Call by reference	☐	Type reference (TYPE)	INT4	20000	Get Data Blocksize (Pre-Aggregation Blocksize)	20100414
5	Importing	IV_FROM_TIMESTAMP	Call by reference	☑	Type reference (TYPE)	TIMESTAMPL		From Timestamp	20100414

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

Method AGGREGATOR_IS_LOCKED Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Returning	RV_IS_LOCKED	Value transfer	☐	Type reference (TYPE)	CHAR01		Is Locked	20100414

Method AGGREGATOR_IS_LOCKED on class CL_ESH_QL_QUERY_LOG_AGGREGATOR has no exception.

Method AGGREGATOR_LOCK Signature

Method AGGREGATOR_LOCK on class CL_ESH_QL_QUERY_LOG_AGGREGATOR has no parameter.

#	Exception	Resumable	Description	Created on
1	CX_ESH_CO_ENGINE	☐	Common ESH Engine Exception	20100414
2	CX_ESH_CO_LOCKED	☐	ESH Locking Exception	20100414

Method AGGREGATOR_UNLOCK Signature

Method AGGREGATOR_UNLOCK on class CL_ESH_QL_QUERY_LOG_AGGREGATOR has no parameter.
Method AGGREGATOR_UNLOCK on class CL_ESH_QL_QUERY_LOG_AGGREGATOR has no exception.

Method CALCULATE_RANK_VALUE_RANGE Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Exporting	ES_RANK_VALUE_RANGE	Call by reference	☐	Type reference (TYPE)	ESH_S_CM_RANK_VALUE_RANGE		Rank Value Normalization Range (Low/Top Values)	20100414
2	Exporting	ET_TERM_STATISTICS	Call by reference	☐	Type reference (TYPE)	ESH_T_CM_TERM_STATISTICS		Term Statistics	20100414
3	Importing	IT_AGGREGATED_TERMS	Call by reference	☐	Type reference (TYPE)	ESH_T_CM_SUGGESTIONS		Suggested Terms	20100414
4	Importing	IV_TOPRANK_PERCENTAGE	Call by reference	☐	Type reference (TYPE)	INT4	75	Target rankvalue of most frequent term (0..100)	20100414

Method CALCULATE_RANK_VALUE_RANGE on class CL_ESH_QL_QUERY_LOG_AGGREGATOR has no exception.

Method COMPOSE_JOBNAME Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Returning	RV_JOBNAME	Value transfer	☐	Type reference (TYPE)	TBTCJOB-JOBNAME		Background job name	20100722

Method COMPOSE_JOBNAME on class CL_ESH_QL_QUERY_LOG_AGGREGATOR has no exception.

Method GET_AGGREGATION_METADATA Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Exporting	EV_AGGREGATION_BLOCKSIZE	Call by reference	☐	Type reference (TYPE)	INT4		Aggregation Blocksize	20100414
2	Exporting	EV_USE_ODP	Call by reference	☐	Type reference (TYPE)	CHAR01		Use ODP	20100414

Method GET_AGGREGATION_METADATA on class CL_ESH_QL_QUERY_LOG_AGGREGATOR has no exception.

Method GET_AGGREGATION_START_TSP Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Returning	RV_START_TSP	Value transfer	☐	Type reference (TYPE)	TIMESTAMPL		Aggregation start timestamp	20100414

Method GET_AGGREGATION_START_TSP on class CL_ESH_QL_QUERY_LOG_AGGREGATOR has no exception.

Method GET_INSTANCE Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Returning	RR_LOG_AGGREGATOR	Value transfer	☐	Object reference (TYPE REF TO)	CL_ESH_QL_QUERY_LOG_AGGREGATOR		Query Log Aggregator	20100414

Method GET_INSTANCE on class CL_ESH_QL_QUERY_LOG_AGGREGATOR has no exception.

Method GET_SEARCHTERM_STATISTICS Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Exporting	ET_TERMS	Call by reference	☐	Type reference (TYPE)	ESH_T_QL_SEARCHTERM_STATISTICS		Searchterm Statistics, aggregated per Scope	20100414
2	Exporting	EV_LAST_ENTRY_TSP	Call by reference	☐	Type reference (TYPE)	TIMESTAMPL		Timestamp of last entry in aggregation	20100414
3	Importing	IT_SCOPE_FILTER	Call by reference	☑	Type reference (TYPE)	ESH_T_FED_SCOPE		Search Scope	20100414
4	Importing	IV_BLOCKSIZE	Call by reference	☑	Type reference (TYPE)	INT4		Get Data Blocksize (Pre-Aggregation Blocksize)	20100414
5	Importing	IV_FROM_TIMESTAMP	Call by reference	☑	Type reference (TYPE)	TIMESTAMPL		From Timestamp	20100414
6	Importing	IV_OCCURRENCE_THRESHOLD	Call by reference	☑	Type reference (TYPE)	INT4		Restrict List: Only terms occurring more frequently than val	20100414
7	Importing	IV_SUCCESSF_ONLY	Call by reference	☐	Type reference (TYPE)	CHAR01	ABAP_TRUE	Restrict List: Successful queries only (min. 1 result item)	20100414
8	Importing	IV_TERMBASED_ONLY	Call by reference	☐	Type reference (TYPE)	CHAR01	ABAP_TRUE	Restrict List: Termbased queries only	20100414
9	Importing	IV_TOP_N	Call by reference	☑	Type reference (TYPE)	INT4		Restrict List: Only most frequent terms per scope	20100414
10	Importing	IV_TO_TIMESTAMP	Call by reference	☑	Type reference (TYPE)	TIMESTAMPL		To Timestamp	20100414

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

Method IS_RUNNING Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Returning	RV_IS_RUNNING	Value transfer	☐	Type reference (TYPE)	CHAR01		Query Log Aggregator Is Running	20100722

Method IS_RUNNING on class CL_ESH_QL_QUERY_LOG_AGGREGATOR has no exception.

Method SCHEDULE_AGGREGATION Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	IV_DELAY	Call by reference	☐	Type reference (TYPE)	INT4	0	Delay Time (In Seconds)	20100730
2	Importing	IV_JOBNAME	Call by reference	☑	Type reference (TYPE)	TBTCJOB-JOBNAME		Job name	20100722
3	Importing	IV_USERNAME	Call by reference	☑	Type reference (TYPE)	USERNAME		User name	20100730

#	Exception	Resumable	Description	Created on
1	CX_ESH_QL_ENGINE	☐	ESH Query Logging Engine Exception	20100722

Method SET_AGGREGATION_START Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	IV_FIXED_START_TSP	Call by reference	☑	Type reference (TYPE)	TIMESTAMPL		Start aggregation at a fixed timestamp	20100414
2	Importing	IV_GET_FROM_CUSTOMIZING	Call by reference	☑	Type reference (TYPE)	ABAP_BOOL		Get from customizing	20100722
3	Importing	IV_INTERVAL_DAYS	Call by reference	☑	Type reference (TYPE)	ESH_E_QL_CUST_QL_AGGREG_INTERV		Aggregate over time interval (last days)	20100414
4	Importing	IV_UNLIMITED	Call by reference	☑	Type reference (TYPE)	ABAP_BOOL		Aggregate all	20100414

Method SET_AGGREGATION_START on class CL_ESH_QL_QUERY_LOG_AGGREGATOR has no exception.

Method SET_DEBUG_MODE Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	IV_DEBUG	Call by reference	☐	Type reference (TYPE)	CHAR01		Debug Mode	20100726

Method SET_DEBUG_MODE on class CL_ESH_QL_QUERY_LOG_AGGREGATOR has no exception.

History

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