SAP ABAP Class CL_ESH_TREX_STOP_START (Services to stop or restart indexing)

Hierarchy

☛

SAP_BASIS (Software Component) SAP Basis Component
⤷

BC-EIM-ESH (Application Component) NetWeaver Enterprise Search
⤷

S_ESH_ENG_TREX (Package) TREX handling for Enterprise Search

Properties

Class	CL_ESH_TREX_STOP_START
Short Description	Services to stop or restart indexing
Super Class
Instantiability of a Class	2	Public
Final

General Data

Message Class
Program status
Category	0
Package	S_ESH_ENG_TREX	TREX handling for Enterprise Search
Created	20121016	SAP
Last change	20140121	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

Class CL_ESH_TREX_STOP_START has no interface implemented.

Friends

Class CL_ESH_TREX_STOP_START has no friend class.

Attributes

#	Attribute	Level	Visibility	Typing	Associated Type	Initial Value	Description	Created on
1	GC_EXCL_AUTORESTART_ON_RESUME	Constant	Public	Type reference (TYPE)	ESH_E_ADM_VALUE	'EXCL_AUTORESTART_ON_RESUME'	Restart Request ID	20130626
2	GC_EXCL_LIST_PREFIX	Constant	Public	Type reference (TYPE)	ESH_E_TREX_FEATURE	'EXCL%'	Entry Key Prefix 'EXCL%'	20130626
3	GC_STOP_START_ACTION_START	Constant	Public	Type reference (TYPE)	CHAR10	'START'	Suspend Mode: Stop/Start Action "Start Indexing"	20121016
4	GC_STOP_START_ACTION_STOP	Constant	Public	Type reference (TYPE)	CHAR10	'STOP'	Suspend Mode: Stop/Start Action "Stop Indexing"	20121016
5	GC_STOP_START_JOBPREFIX_START	Constant	Public	Type reference (TYPE)	TBTCJOB-JOBNAME	'ESH_RESUME_I_'	Job name prefix	20121016
6	GC_STOP_START_JOBPREFIX_STOP	Constant	Public	Type reference (TYPE)	TBTCJOB-JOBNAME	'ESH_SUSPND_I_'	Job name prefix	20121016
7	GC_STOP_START_LOCK_HEADER	Constant	Public	Type reference (TYPE)	RSTABLE-TABNAME	'ESH_IDX_STOP_START'	Lock Header for STOP/START INDEXING Process	20121016
8	GC_STOP_START_STATUS_ACTIVE	Constant	Public	Type reference (TYPE)	CHAR01	'1'	Suspend Mode: Stop/Start Status "Active (Not on Hold)"	20121016
9	GC_STOP_START_STATUS_HOLD	Constant	Public	Type reference (TYPE)	CHAR01	'0'	Suspend Mode: Stop/Start Status "Indexing on Hold"	20121016
10	GC_STOP_START_STATUS_STARTING	Constant	Public	Type reference (TYPE)	CHAR01	'+'	Suspend Mode: Stop/Start Status "Indexing Starting"	20121016
11	GC_STOP_START_STATUS_STOPPING	Constant	Public	Type reference (TYPE)	CHAR01	'-'	Suspend Mode: Stop/Start Status "Indexing Stopping"	20121016
12	GC_TREX_GLOBALHOLD	Constant	Public	Type reference (TYPE)	ESH_E_TREX_FEATURE	'GLOBALHOLD'	Entry Key 'GLOBALHOLD'	20121016
13	GC_TREX_RESTARTKEY_PREFIX	Constant	Public	Type reference (TYPE)	ESH_E_TREX_FEATURE	'RESTART%'	Entry Key Prefix 'RESTART%'	20121016
14	GC_TREX_RESTARTREQUEST_ID_INI	Constant	Public	Type reference (TYPE)	ESH_E_ADM_VALUE	'INITIAL_INDEXING'	Restart Request ID: 'Initial Indexing'Restart Request ID: 'I	20121016
15	GC_TREX_RESTARTREQUEST_ID_RTI	Constant	Public	Type reference (TYPE)	ESH_E_ADM_VALUE	'RTI'	Restart Request ID: 'Initial Real-Time Indexing'	20121016
16	MR_APPLOG	Instance attribute	Private	Object reference (TYPE REF TO)	IF_ESH_OM_APPLOG		Application Log	20121016
17	MT_LOCKTAB	Instance attribute	Private	Type reference (TYPE)	ESH_T_CO_LOCKTAB		Lock administration table (lock references per lock arg.)	20121016
18	MV_EXCL_COUNTER	Instance attribute	Private	Type reference (TYPE)	INT4		Exclusion Counter	20130626
19	MV_RESTART_COUNTER	Instance attribute	Private	Type reference (TYPE)	INT4		Restart Conter	20121016

Methods

#	Method	Level	Visibility	Method type	Description	Created on
1	APPLOG_ADD_CURRENT_STATUS_INFO	Instance method	Private	Method	Applog: Add current status info	20121016
2	CHECK_INDEXING_SUSPENDED	Static method	Public	Method	Check Indexing Suspended	20121016
3	CHECK_JOBS_STILL_RUNNING	Instance method	Private	Method	Check Jobs Still Running	20121016
4	COMPLETED_JOBS_MERGE	Instance method	Private	Method	Completed Jobs: Merge Indices	20121016
5	COMPLETED_JOBS_OPTIMIZE	Instance method	Private	Method	Completed Jobs: Optimize Indices	20121016
6	COMPOSE_JOBNAME	Static method	Private	Method	Compose Jobname	20121016
7	EXCLUSION_LIST_ADD_OBJECTS	Instance method	Public	Method	Exclusion List: Add Objects	20130626
8	EXCLUSION_LIST_DEL_OBJECTS	Instance method	Public	Method	Exclusion List: Del Objects	20130626
9	GET_CURRENT_JOBS	Instance method	Private	Method	Get Current Jobs	20121016
10	GET_CURRENT_STATUS	Static method	Public	Method	Get Current Status (Not Suspended, Stopping, Suspended)	20121016
11	GET_EXCLUSION_LIST	Instance method	Public	Method	Get Exclusion List: Objects not considered for auto-restart	20130626
12	GET_INSTANCE	Static method	Public	Method	Get Instance	20121016
13	GET_NEXT_EXCL_ID	Instance method	Private	Method	Get Next Exclusion ID	20130626
14	GET_NEXT_RESTART_ID	Instance method	Private	Method	Get Next Restart ID	20121016
15	GET_STATUS_TEXTS	Static method	Private	Method	Get Status Texts	20121016
16	GET_SUSPEND_MODE_ADMIN_DATA	Static method	Public	Method	Get Suspend Mode Admin Data	20121016
17	IS_RUNNING	Static method	Public	Method	Is running	20121016
18	JOBS_GET_INDEX_LIST	Instance method	Private	Method	Running Jobs: Get Index List	20121016
19	LOCK	Instance method	Private	Method	Lock	20121016
20	RESTART_INDEXING	Instance method	Public	Method	Restart Indexing	20121016
21	SCHEDULE_EXECUTION	Static method	Public	Method	Schedule Execution	20121016
22	STOP_INDEXING	Instance method	Public	Method	Stop Indexing	20121016
23	UNLOCK	Instance method	Private	Method	Unlock	20121016

Events

Class CL_ESH_TREX_STOP_START has no event.

Types

#	Type	Visibility	Typing	Description	Created on	Type Source
1	GTY_S_EXCL_OBJECTS	Private	See coding	Excluded Objects	20130627	`BEGIN OF gty_s_excl_objects, logsys TYPE logsys, object_type TYPE esh_e_om_object_type, END OF gty_s_excl_objects`
2	GTY_S_INDEX_IDS_BY_LOGSYS	Private	See coding	Index IDs by Logsys	20130828	`BEGIN OF gty_s_index_ids_by_logsys, logsys TYPE logsys, index_ids TYPE esh_t_if_index_id, END OF gty_s_index_ids_by_logsys`
3	GTY_S_LOGSYS_OBJECTS	Private	See coding	Objects to Analyze (Aggregated by Logical System)	20121016	`BEGIN OF gty_s_logsys_objects, logsys TYPE logsys, objects TYPE gty_t_object_to_analyze, END OF gty_s_logsys_objects`
4	GTY_S_OBJECT_TO_ANALYZE	Private	See coding	Objects to Analyze	20121016	`BEGIN OF gty_s_object_to_analyze, object_type TYPE esh_e_om_object_type, template_type TYPE esh_e_om_template_type, ext_sys_id TYPE esh_e_adm_external_system_id, jobtype TYPE char01, " 'I' Ini, 'D' Delta, 'R' RTI END OF gty_s_object_to_analyze`
5	GTY_S_RUNNING_JOBS	Private	See coding	Running Jobs	20121016	`BEGIN OF gty_s_running_jobs, logsys TYPE logsys, object_type TYPE esh_e_om_object_type, initial_indexing TYPE esh_e_adm_tstmp_initial_index, delta_indexing TYPE esh_e_adm_tstmp_delta_indexing, last_object_id TYPE esh_e_if_general_id, jobname TYPE btcjob, jobcount_ii TYPE btcjobcnt, jobcount_di TYPE btcjobcnt, variant_index TYPE raldb_vari, * REGISTER_FOR_RTI type CHAR01, "will be read from variant END OF gty_s_running_jobs`
6	GTY_T_EXCL_OBJECTS	Private	See coding	Excluded Objects	20130627	`gty_t_excl_objects TYPE STANDARD TABLE OF gty_s_excl_objects WITH NON-UNIQUE KEY logsys object_type`
7	GTY_T_INDEX_IDS_BY_LOGSYS	Private	See coding	Index IDs By Logsys	20130828	`gty_t_index_ids_by_logsys TYPE SORTED TABLE OF gty_s_index_ids_by_logsys WITH UNIQUE KEY logsys`
8	GTY_T_LOGSYS_OBJECTS	Private	See coding	Objects to Analyze (Aggregated by Logical System)	20121016	`gty_t_logsys_objects TYPE STANDARD TABLE OF gty_s_logsys_objects WITH NON-UNIQUE KEY logsys`
9	GTY_T_OBJECT_TO_ANALYZE	Private	See coding	Objects to Analyze	20121016	`gty_t_object_to_analyze TYPE STANDARD TABLE OF gty_s_object_to_analyze WITH NON-UNIQUE KEY object_type`
10	GTY_T_RUNNING_JOBS	Private	See coding	Running Jobs	20121016	`gty_t_running_jobs TYPE STANDARD TABLE OF gty_s_running_jobs WITH NON-UNIQUE KEY logsys object_type`

Method Signatures

Method APPLOG_ADD_CURRENT_STATUS_INFO Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	IV_STATUS	Call by reference		Type reference (TYPE)	CHAR01		Indexing Status (0 Hold, 1 Active, '+' Starting, '-' Stoppg)	20121016

Method APPLOG_ADD_CURRENT_STATUS_INFO on class CL_ESH_TREX_STOP_START has no exception.

Method CHECK_INDEXING_SUSPENDED Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Returning	RV_INDEXING_SUSPENDED	Value transfer		Type reference (TYPE)	CHAR01		Indexing is currently suspended	20121016

Method CHECK_INDEXING_SUSPENDED on class CL_ESH_TREX_STOP_START has no exception.

Method CHECK_JOBS_STILL_RUNNING Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Changing	CT_COMPLETED_JOBS	Call by reference		Type reference (TYPE)	GTY_T_RUNNING_JOBS		Completed Jobs	20121016
2	Changing	CT_RUNNING_JOBS	Call by reference		Type reference (TYPE)	GTY_T_RUNNING_JOBS		Running Jobs	20121016

Method CHECK_JOBS_STILL_RUNNING on class CL_ESH_TREX_STOP_START has no exception.

Method COMPLETED_JOBS_MERGE Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	IT_INDEX_IDS	Call by reference		Type reference (TYPE)	GTY_T_INDEX_IDS_BY_LOGSYS		Index IDs	20121016

Method COMPLETED_JOBS_MERGE on class CL_ESH_TREX_STOP_START has no exception.

Method COMPLETED_JOBS_OPTIMIZE Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	IT_INDEX_IDS	Call by reference		Type reference (TYPE)	GTY_T_INDEX_IDS_BY_LOGSYS		Index IDs	20121016

Method COMPLETED_JOBS_OPTIMIZE on class CL_ESH_TREX_STOP_START has no exception.

Method COMPOSE_JOBNAME Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	IV_ACTION	Call by reference		Type reference (TYPE)	CHAR10		Action (STOP/START)	20121016
2	Returning	RV_JOBNAME	Value transfer		Type reference (TYPE)	TBTCJOB-JOBNAME		Background job name	20121016

Method COMPOSE_JOBNAME on class CL_ESH_TREX_STOP_START has no exception.

Method EXCLUSION_LIST_ADD_OBJECTS Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	IT_EXCLUSION_LIST_ADD	Call by reference		Type reference (TYPE)	ESH_T_ADM_SC_INFO		Exclusion List: Add	20130626
2	Importing	IV_COMMIT_WORK	Call by reference		Type reference (TYPE)	CHAR01		Commit Work	20130626

Method EXCLUSION_LIST_ADD_OBJECTS on class CL_ESH_TREX_STOP_START has no exception.

Method EXCLUSION_LIST_DEL_OBJECTS Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	IT_EXCLUSION_LIST_DEL	Call by reference		Type reference (TYPE)	ESH_T_ADM_SC_INFO		Exclusion List: Del	20130626
2	Importing	IV_COMMIT_WORK	Call by reference		Type reference (TYPE)	CHAR01		Commit Work	20130626

Method EXCLUSION_LIST_DEL_OBJECTS on class CL_ESH_TREX_STOP_START has no exception.

Method GET_CURRENT_JOBS Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Exporting	ET_RUNNING_JOBS	Call by reference		Type reference (TYPE)	GTY_T_RUNNING_JOBS		Running indexing jobs (initial/delta)	20121016

Method GET_CURRENT_JOBS on class CL_ESH_TREX_STOP_START has no exception.

Method GET_CURRENT_STATUS Signature

#	Type	Parameter	Pass Value	Typing Method	Associated Type	Description	Created on
1	Exporting	EV_ADDITIONAL_INFO_01	Call by reference	Type reference (TYPE)	BAPI_MSG	Additional Info 01	20121016
2	Exporting	EV_ADDITIONAL_INFO_02	Call by reference	Type reference (TYPE)	BAPI_MSG	Additional Info 02	20121016
3	Exporting	EV_ADDITIONAL_INFO_03	Call by reference	Type reference (TYPE)	BAPI_MSG	Additional Info 03	20121016
4	Exporting	EV_STATUS	Call by reference	Type reference (TYPE)	CHAR01	Indexing Status (0 Hold, 1 Active, '+' Starting, '-' Stoppg)	20121016
5	Exporting	EV_STATUS_DISPLAYTEXT	Call by reference	Type reference (TYPE)	BAPI_MSG	Status Displaytext	20121016

Method GET_CURRENT_STATUS on class CL_ESH_TREX_STOP_START has no exception.

Method GET_EXCLUSION_LIST Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Exporting	ET_EXCLUSION_LIST	Call by reference		Type reference (TYPE)	ESH_T_ADM_SC_INFO		Exclusion List: Objects not considered for auto-restart	20130626

Method GET_EXCLUSION_LIST on class CL_ESH_TREX_STOP_START has no exception.

Method GET_INSTANCE Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	IR_APPLOG	Call by reference		Object reference (TYPE REF TO)	IF_ESH_OM_APPLOG		Application Log	20121016
2	Returning	RR_STOP_START	Value transfer		Object reference (TYPE REF TO)	CL_ESH_TREX_STOP_START		Services to stop or restart indexing	20121016

Method GET_INSTANCE on class CL_ESH_TREX_STOP_START has no exception.

Method GET_NEXT_EXCL_ID Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Returning	RV_NEXT_EXCL_ID	Value transfer		Type reference (TYPE)	ESH_E_TREX_FEATURE		Next Exclusion Request ID	20130626

Method GET_NEXT_EXCL_ID on class CL_ESH_TREX_STOP_START has no exception.

Method GET_NEXT_RESTART_ID Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Returning	RV_NEXT_RESTART_ID	Value transfer		Type reference (TYPE)	ESH_E_TREX_FEATURE		Next Restart Request ID	20121016

Method GET_NEXT_RESTART_ID on class CL_ESH_TREX_STOP_START has no exception.

Method GET_STATUS_TEXTS Signature

#	Type	Parameter	Pass Value	Typing Method	Associated Type	Description	Created on
1	Exporting	EV_ADDITIONAL_INFO_01	Call by reference	Type reference (TYPE)	BAPI_MSG	Additional Info 01	20121016
2	Exporting	EV_ADDITIONAL_INFO_02	Call by reference	Type reference (TYPE)	BAPI_MSG	Additional Info 02	20121016
3	Exporting	EV_ADDITIONAL_INFO_03	Call by reference	Type reference (TYPE)	BAPI_MSG	Additional Info 03	20121016
4	Exporting	EV_STATUS_DISPLAYTEXT	Call by reference	Type reference (TYPE)	BAPI_MSG	Status Displaytext	20121016
5	Importing	IV_STATUS	Call by reference	Type reference (TYPE)	CHAR01	Indexing Status (0 Hold, 1 Active, '+' Starting, '-' Stoppg)	20121016

Method GET_STATUS_TEXTS on class CL_ESH_TREX_STOP_START has no exception.

Method GET_SUSPEND_MODE_ADMIN_DATA Signature

#	Type	Parameter	Pass Value	Typing Method	Associated Type	Description	Created on
1	Exporting	EV_INI_RESTART_COUNT	Call by reference	Type reference (TYPE)	INT4	Count of Initial Indexing Jobs	20121016
2	Exporting	EV_SUSPEND_TIMESTAMP	Call by reference	Type reference (TYPE)	TIMESTAMP	Timestamp	20121016
3	Exporting	EV_SUSPEND_USER	Call by reference	Type reference (TYPE)	USERNAME	User Name	20121016

Method GET_SUSPEND_MODE_ADMIN_DATA on class CL_ESH_TREX_STOP_START has no exception.

Method IS_RUNNING Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Exporting	EV_ACTION	Call by reference		Type reference (TYPE)	CHAR10		'STOP' / 'START'	20121016
2	Exporting	EV_IS_RUNNING	Call by reference		Type reference (TYPE)	CHAR01		Is Running	20121016

Method IS_RUNNING on class CL_ESH_TREX_STOP_START has no exception.

Method JOBS_GET_INDEX_LIST Signature

#	Type	Parameter	Pass Value	Typing Method	Associated Type	Description	Created on
1	Exporting	ET_INDEX_IDS	Call by reference	Type reference (TYPE)	GTY_T_INDEX_IDS_BY_LOGSYS	Index IDs	20121016
2	Importing	IT_RUNNING_JOBS	Call by reference	Type reference (TYPE)	GTY_T_RUNNING_JOBS	Running Jobs	20121016
3	Importing	IV_INCLUDE_ANY_OBJECTS	Call by reference	Type reference (TYPE)	CHAR01	Include Any Further Objects of Type CR	20121026
4	Importing	IV_INCLUDE_RTI_OBJECTS	Call by reference	Type reference (TYPE)	CHAR01	Include Real-Time Indexing Objects	20121016

Method JOBS_GET_INDEX_LIST on class CL_ESH_TREX_STOP_START has no exception.

Method LOCK Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	IV_ACTION	Call by reference		Type reference (TYPE)	CHAR10		'START' / 'STOP'	20121016

#	Exception	Resumable	Description	Created on
1	CX_ESH_CO_LOCKED			20121016

Method RESTART_INDEXING Signature

Method RESTART_INDEXING on class CL_ESH_TREX_STOP_START has no parameter.

#	Exception	Resumable	Description	Created on
1	CX_ESH_CO_LOCKED			20121016

Method SCHEDULE_EXECUTION Signature

#	Type	Parameter	Pass Value	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	IR_APPLICATION_LOG	Call by reference	Object reference (TYPE REF TO)	IF_ESH_OM_APPLOG		Application Log	20121016
2	Importing	IV_ACTION	Call by reference	Type reference (TYPE)	CHAR10		Action (STOP/START)	20121016
3	Importing	IV_DELAY	Call by reference	Type reference (TYPE)	INT4	0	Delay	20121016
4	Importing	IV_EXEC_UNAME	Call by reference	Type reference (TYPE)	SYUNAME		Exec User (Default: ESH Extraction User)	20121016
5	Importing	IV_JOBNAME	Call by reference	Type reference (TYPE)	TBTCJOB-JOBNAME		Jobname (Default: ESH_SUSPEND../ESH_RESUME..)	20121016

#	Exception	Resumable	Description	Created on
1	CX_ESH_ADM_GENERAL_ERROR			20121016

Method STOP_INDEXING Signature

#	Type	Parameter	Pass Value	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	IV_MAX_WAITTIME	Call by reference	Type reference (TYPE)	INT4	1800	Maximum wait-time for jobs to terminate (default: 1800 s)	20121016
2	Importing	IV_MERGE_INDICES_AT_END	Call by reference	Type reference (TYPE)	CHAR01	ABAP_TRUE	Merge Indices at End of Processes	20121016
3	Importing	IV_OPTIMIZE_INDICES_AT_END	Call by reference	Type reference (TYPE)	CHAR01	ABAP_TRUE	Optimize Indices at End of Process	20121016
4	Importing	IV_WAIT_FOR_COMPLETION	Call by reference	Type reference (TYPE)	CHAR01	ABAP_TRUE	Wait for Completion	20121016

#	Exception	Resumable	Description	Created on
1	CX_ESH_CO_LOCKED			20121016

Method UNLOCK Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	IV_ACTION	Call by reference		Type reference (TYPE)	CHAR10		'START' / 'STOP'	20121016

Method UNLOCK on class CL_ESH_TREX_STOP_START has no exception.

History

Last changed by/on	SAP	20140121
SAP Release Created in	740

Object Hierarchy

Using

Used by

Advertise Links