SAP ABAP Class CL_ESH_EX_FU_ADMIN (Real-Time Indexing Administration)
Hierarchy
SAP_BASIS (Software Component) SAP Basis Component
   BC-EIM-ESH (Application Component) NetWeaver Enterprise Search
     S_ESH_ENG_EXTRACTION (Package) Extraction
Properties
Class CL_ESH_EX_FU_ADMIN  
Short Description Real-Time Indexing Administration    
Super Class    
Instantiability of a Class 2  Public 
Final    
General Data
Message Class    
Program status     
Category 0   
Package S_ESH_ENG_EXTRACTION   Extraction 
Created 20081209   SAP 
Last change 20130531   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_EX_FU_ADMIN has no interface implemented.
Friends
# Friend Modeled only Created on Description
1 CL_ESH_EX_EXTRACTOR_USER 20090507 Generation / Mainenance of Generic User for ESH Data Extract
Attributes
# Attribute Level Visibility Read only Typing Associated Type Initial Value Description Created on
1 GC_DEFAULT_CP_BLOCKSIZE Constant Public Type reference (TYPE) ESH_E_EX_CP_BLOCKSIZE 10000 Change pointer default block size 20090119
2 GC_DEFAULT_CP_BLOCKSIZE_SEND Constant Public Type reference (TYPE) ESH_E_EX_CP_BLOCKSIZE 1000 CP default send block size: Send data if more records 20090119
3 GC_DEFAULT_CP_MAX_N_OF_BLOCKS Constant Public Type reference (TYPE) ESH_E_EX_CP_BLOCKSIZE 5 Max # of blocks per package 20090604
4 GC_DEFAULT_CP_MAX_N_OF_PACKGS Constant Public Type reference (TYPE) ESH_E_EX_CP_BLOCKSIZE 10 Max # of packages per object type 20120926
5 GC_DEFAULT_FU_BLOCKSIZE Constant Public Type reference (TYPE) ESH_E_EX_FU_BLOCKSIZE 10000 Default value for fast update block size 20090115
6 GC_DEFAULT_FU_FREQUENCY Constant Public Type reference (TYPE) ESH_E_EX_FU_EXTRACT_FREQ 2 Default value for fast update frequency (secs) 20090115
7 GC_DEFAULT_FU_MAX_IDLE_TIME Constant Public Type reference (TYPE) ESH_E_EX_FU_MAX_IDLE_TIME 10 Default value for max. idle time: 600 sec (10 min) 20090122
8 GC_DEFAULT_FU_MAX_RUNTIME Constant Public Type reference (TYPE) ESH_E_EX_FU_MAX_RUNTIME 86400 Default value for max. runtime: 86400 sec (24 h) 20090122
9 GC_DEMON_DB_STATUS_ACTIVE Constant Public Type reference (TYPE) ESH_E_EX_FU_DEMON_ADM_STATUS 'R' Daemon DB status: Active (-> refer to RT status) 20090116
10 GC_DEMON_DB_STATUS_AUTORESTART Constant Public Type reference (TYPE) ESH_E_EX_FU_DEMON_ADM_STATUS 'A' Daemon DB status: Auto-restarted 20090116
11 GC_DEMON_DB_STATUS_IDLE_TM_EXC Constant Public Type reference (TYPE) ESH_E_EX_FU_DEMON_ADM_STATUS 'Y' Daemon DB status: Idle time exceeded 20090116
12 GC_DEMON_DB_STATUS_INITIAL Constant Public Type reference (TYPE) ESH_E_EX_FU_DEMON_ADM_STATUS SPACE Daemon DB status: Initial (-> refer to RT status) 20090116
13 GC_DEMON_DB_STATUS_ON_HOLD Constant Public Type reference (TYPE) ESH_E_EX_FU_DEMON_ADM_STATUS 'X' Daemon DB status: On hold 20090116
14 GC_DEMON_DB_STATUS_STARTED Constant Public Type reference (TYPE) ESH_E_EX_FU_DEMON_ADM_STATUS 'I' Daemon DB status: Started 20090116
15 GC_DEMON_DB_STATUS_TECH_ERROR Constant Public Type reference (TYPE) ESH_E_EX_FU_DEMON_ADM_STATUS 'F' Daemon DB status: Technical error 20090116
16 GC_DEMON_DB_STATUS_TEMP_ERROR Constant Public Type reference (TYPE) ESH_E_EX_FU_DEMON_ADM_STATUS 'E' Daemon DB status: Temporary error (e.g. connection error) 20090220
17 GC_DEMON_RT_STATUS_AUTORESTART Constant Public Type reference (TYPE) ESH_E_EX_FU_DEMON_RT_STATUS 'A' Daemon runtime status: Auto-restarting 20090116
18 GC_DEMON_RT_STATUS_COMMFAIL Constant Public Type reference (TYPE) ESH_E_EX_FU_DEMON_RT_STATUS 'C' Daemon runtime status: Communication failure 20090203
19 GC_DEMON_RT_STATUS_DEBUG_MODE Constant Public Type reference (TYPE) ESH_E_EX_FU_DEMON_RT_STATUS 'D' Daemon runtime status: Debug mode 20090209
20 GC_DEMON_RT_STATUS_FAILED Constant Public Type reference (TYPE) ESH_E_EX_FU_DEMON_RT_STATUS 'F' Daemon runtime status: Technical error 20090116
21 GC_DEMON_RT_STATUS_GLOBALHOLD Constant Public Type reference (TYPE) ESH_E_EX_FU_DEMON_RT_STATUS 'G' Daemon runtime status: Global hold (indexing suspended) 20121016
22 GC_DEMON_RT_STATUS_IDLE_TM_EXC Constant Public Type reference (TYPE) ESH_E_EX_FU_DEMON_RT_STATUS 'Y' Daemon runtime status: Idle time exceeded (temp. stopped) 20090203
23 GC_DEMON_RT_STATUS_NOT_RUNNING Constant Public Type reference (TYPE) ESH_E_EX_FU_DEMON_RT_STATUS SPACE Daemon runtime status: Not running 20090116
24 GC_DEMON_RT_STATUS_NOT_SUPPRTD Constant Public Type reference (TYPE) ESH_E_EX_FU_DEMON_RT_STATUS 'N' Daemon runtime status: Not supported 20090203
25 GC_DEMON_RT_STATUS_ON_HOLD Constant Public Type reference (TYPE) ESH_E_EX_FU_DEMON_RT_STATUS 'H' Daemon runtime status: On hold 20090203
26 GC_DEMON_RT_STATUS_RUNNING Constant Public Type reference (TYPE) ESH_E_EX_FU_DEMON_RT_STATUS 'R' Daemon runtime status: Running 20090116
27 GC_DEMON_RT_STATUS_SINGLE_EXEC Constant Public Type reference (TYPE) ESH_E_EX_FU_DEMON_RT_STATUS 'S' Fast update daemon runtime status 20090209
28 GC_DEMON_RT_STATUS_STARTING Constant Public Type reference (TYPE) ESH_E_EX_FU_DEMON_RT_STATUS 'I' Daemon runtime status: Starting 20090116
29 GC_DEMON_RT_STATUS_STOPPING Constant Public Type reference (TYPE) ESH_E_EX_FU_DEMON_RT_STATUS 'P' Daemon runtime status: Stopping (last run being executed) 20090116
30 GC_DEMON_RT_STATUS_TEMP_ERROR Constant Public Type reference (TYPE) ESH_E_EX_FU_DEMON_RT_STATUS 'E' Daemon runtime status: Temporary error 20090220
31 GC_MSGCL_ESH_EX Constant Public Type reference (TYPE) SYMSGID 'ESH_EX' Message class ESH_EX 20090223
32 GC_REG_FOR_CP_ONLY Constant Public Type reference (TYPE) ESH_E_EX_REGISTERED_FOR 'C' Registered for change pointer handling only 20090119
33 GC_REG_FOR_FU_AND_CP Constant Public Type reference (TYPE) ESH_E_EX_REGISTERED_FOR 'F' Registered for fast update and change pointer handling 20090119
34 GC_SUSPEND_MODE_ACTIVE Constant Public Type reference (TYPE) ESH_E_EX_FU_SUSPENDED_MODE SPACE Active 20090116
35 GC_SUSPEND_MODE_SUSP_FU Constant Public Type reference (TYPE) ESH_E_EX_FU_SUSPENDED_MODE 'S' Fast update suspended 20090116
36 GC_SUSPEND_MODE_SUSP_FU_AND_CP Constant Public Type reference (TYPE) ESH_E_EX_FU_SUSPENDED_MODE 'X' Fast update and change pointers suspended 20090116
37 GT_MSG_HANDLE_ALL Static Attribute Private Type reference (TYPE) BAL_T_MSGH Application log: Message handles 20090225
Methods
# Method Level Visibility Method type Description Created on
1 CHECK_JOB_RUNNING Static method Private Method Check job running 20081210
2 CHECK_OBJECTS_REGISTERED Static method Public Method Check objects registered for real-time indexing 20090225
3 CHECK_OBJECT_REGISTERED Static method Public Method Check object registered for real-time indexing 20100622
4 CHECK_OBJECT_SUPPORTS_RTI Static method Public Method Check object supports real-time indexing 20100624
5 CHECK_ON_HOLD Static method Public Method Check whether real-time indexing is on hold 20121016
6 GET_PROCESS_ADMIN_DATA Static method Public Method Get real-time indexing administration data 20090114
7 GET_PROCESS_FEEDBACK Static method Public Method Get real-time indexing feedback 20090116
8 GET_PROCESS_JOBLOG Static method Public Method Get real-time indexing process logs 20090202
9 GET_PROCESS_QUEUE_STATUS Static method Public Method Get real-time indexing queue status 20090113
10 GET_PROCESS_STATUS Static method Public Method Get real-time indexing process status 20090113
11 GET_REGISTERED_OBJECT_TYPES Static method Public Method Get connectors registered for real-time indexing 20090112
12 GET_SUSPEND_MODE Static method Public Method Get suspend mode 20090119
13 REGISTER_OBJECT_TYPES Static method Public Method Register object type for real-time indexing 20090112
14 REORG_PROCESS_FEEDBACK Static method Public Method Reorganize process feedback 20090226
15 SET_PROCESS_PARAMETERS Static method Public Method Set process parameters 20090119
16 SET_SUSPEND_MODE Static method Public Method Set suspend mode 20090119
17 START_JOB Static method Private Method Start job 20081210
18 START_PROCESS Static method Public Method Start real-time indexing process 20081210
19 STOP_JOB Static method Private Method Stop job 20081210
20 STOP_PROCESS Static method Public Method Stop real-time indexing process 20081210
Events
Class CL_ESH_EX_FU_ADMIN has no event.
Types
Class CL_ESH_EX_FU_ADMIN has no local type.
Method Signatures

Method CHECK_JOB_RUNNING Signature

# Type Parameter Pass Value Optional Typing Method Associated Type Default value Description Created on
1 Returning RV_RUNNING Value transfer Type reference (TYPE) ABAP_BOOL 20081210

Method CHECK_JOB_RUNNING on class CL_ESH_EX_FU_ADMIN has no exception.

Method CHECK_OBJECTS_REGISTERED Signature

# Type Parameter Pass Value Optional Typing Method Associated Type Default value Description Created on
1 Returning RV_TRUE Value transfer Type reference (TYPE) CHAR01 Objects registered 20090225

Method CHECK_OBJECTS_REGISTERED on class CL_ESH_EX_FU_ADMIN has no exception.

Method CHECK_OBJECT_REGISTERED Signature

# Type Parameter Pass Value Optional Typing Method Associated Type Default value Description Created on
1 Importing IV_HOME_SOFTWARE_COMPONENT Call by reference Type reference (TYPE) ESH_E_OM_SYSREL Software Component 20100622
2 Importing IV_OBJECT_TYPE Call by reference Type reference (TYPE) ESH_E_OM_OBJECT_TYPE Object Type 20100622
3 Returning RV_REGISTERED_FOR Value transfer Type reference (TYPE) ESH_E_EX_REGISTERED_FOR Is Registered For 20100622

Method CHECK_OBJECT_REGISTERED on class CL_ESH_EX_FU_ADMIN has no exception.

Method CHECK_OBJECT_SUPPORTS_RTI Signature

# Type Parameter Pass Value Optional Typing Method Associated Type Default value Description Created on
1 Importing IV_CONNECTION_GUID Call by reference Type reference (TYPE) ESH_E_ADM_CONNECTION_GUID Connection GUID 20100624
2 Importing IV_HOME_SOFTWARE_COMPONENT Call by reference Type reference (TYPE) ESH_E_OM_SYSREL Software Component 20100624
3 Importing IV_OBJECT_TYPE Call by reference Type reference (TYPE) ESH_E_OM_OBJECT_TYPE Object Type 20100624
4 Returning RV_SUPPORTS_RTI Value transfer Type reference (TYPE) CHAR01 Supports Real-Time Indexing 20100624

Method CHECK_OBJECT_SUPPORTS_RTI on class CL_ESH_EX_FU_ADMIN has no exception.

Method CHECK_ON_HOLD Signature

# Type Parameter Pass Value Optional Typing Method Associated Type Default value Description Created on
1 Returning RV_ON_HOLD Value transfer Type reference (TYPE) CHAR01 Real-time indexing is on hold 20121016

Method CHECK_ON_HOLD on class CL_ESH_EX_FU_ADMIN has no exception.

Method GET_PROCESS_ADMIN_DATA Signature

# Type Parameter Pass Value Optional Typing Method Associated Type Default value Description Created on
1 Importing IV_SET_IF_MISSING Call by reference Type reference (TYPE) CHAR01 'X' Det Default Admin Date Entry if Missing 20090115
2 Returning RS_EX_FU_ADM Value transfer Type reference (TYPE) ESH_S_EX_FU_DEMON_ADM Fast Update Administration Data 20090114

Method GET_PROCESS_ADMIN_DATA on class CL_ESH_EX_FU_ADMIN has no exception.

Method GET_PROCESS_FEEDBACK Signature

# Type Parameter Pass Value Optional Typing Method Associated Type Default value Description Created on
1 Returning RS_EX_FU_FBK Value transfer Type reference (TYPE) ESH_S_EX_FU_DEMON_FBK Fast Update Demon Feedback 20090116

Method GET_PROCESS_FEEDBACK on class CL_ESH_EX_FU_ADMIN has no exception.

Method GET_PROCESS_JOBLOG Signature

# Type Parameter Pass Value Optional Typing Method Associated Type Default value Description Created on
1 Exporting ET_LOGS Call by reference Type reference (TYPE) BAPIRETTAB Process Logs 20090202
2 Importing IV_FROM_TIMESTAMP Call by reference Type reference (TYPE) TIMESTAMP From Timestamp 20090202

Method GET_PROCESS_JOBLOG on class CL_ESH_EX_FU_ADMIN has no exception.

Method GET_PROCESS_QUEUE_STATUS Signature

# Type Parameter Pass Value Optional Typing Method Associated Type Default value Description Created on
1 Exporting ET_FU_QUEUE_STATUS Call by reference Type reference (TYPE) ESH_T_EX_FU_CO_STATUS Fast Update Queue Status 20090113
2 Importing IV_GET_FAILED_COUNT Call by reference Type reference (TYPE) CHAR01 Get Error/Failed/Rejected Count 20090528
3 Importing IV_GET_PROCESSING_COUNT Call by reference Type reference (TYPE) CHAR01 Get Processing Count 20090528
4 Importing IV_GET_QUEUESIZES Call by reference Type reference (TYPE) CHAR01 Get Queue Sizes 20090121
5 Importing IV_OBJECT_TYPE Call by reference Type reference (TYPE) ESH_E_OM_OBJECT_TYPE Object Type 20090113
6 Importing IV_SOFTWARE_COMP Call by reference Type reference (TYPE) ESH_E_OM_SYSREL Software Component ID 20090121

Method GET_PROCESS_QUEUE_STATUS on class CL_ESH_EX_FU_ADMIN has no exception.

Method GET_PROCESS_STATUS Signature

# Type Parameter Pass Value Optional Typing Method Associated Type Default value Description Created on
1 Exporting ES_EXTRACTION_STATUS Call by reference Type reference (TYPE) ESH_S_EX_FU_EXTRACT_STATUSINFO Fast Update / CP Extraction Status Info 20090116
2 Exporting ES_PROCESS_ADMIN_DATA Call by reference Type reference (TYPE) ESH_S_EX_FU_DEMON_ADM Fast Update Demon Admin Data 20090116
3 Exporting ES_PROCESS_FEEDBACK Call by reference Type reference (TYPE) ESH_S_EX_FU_DEMON_FBK Fast Update Demon Feedback 20090116
4 Exporting ES_PROCESS_STATUS Call by reference Type reference (TYPE) ESH_S_EX_FU_DEMON_STATUSINFO Fast Update Demon Status Info 20090116
5 Importing IV_GET_EXTRACTION_STATUS Call by reference Type reference (TYPE) CHAR01 Character Field Length 1 20090116
6 Importing IV_GET_PROCESS_STATUS Call by reference Type reference (TYPE) CHAR01 Character Field Length 1 20090116
7 Importing IV_GET_PROCESS_STATUS_TXT Call by reference Type reference (TYPE) CHAR01 Character Field Length 1 20090203

Method GET_PROCESS_STATUS on class CL_ESH_EX_FU_ADMIN has no exception.

Method GET_REGISTERED_OBJECT_TYPES Signature

# Type Parameter Pass Value Optional Typing Method Associated Type Default value Description Created on
1 Exporting ET_OBJECT_TYPES_CP Call by reference Type reference (TYPE) ESH_T_EX_FU_CONN Object Types registered for CP Processing 20090119
2 Exporting ET_OBJECT_TYPES_FU Call by reference Type reference (TYPE) ESH_T_EX_FU_CONN Object Types registered for FU Processing 20090119

Method GET_REGISTERED_OBJECT_TYPES on class CL_ESH_EX_FU_ADMIN has no exception.

Method GET_SUSPEND_MODE Signature

# Type Parameter Pass Value Optional Typing Method Associated Type Default value Description Created on
1 Returning RV_SUSPEND_MODE Value transfer Type reference (TYPE) ESH_E_EX_FU_SUSPENDED_MODE Suspend Mode 20090119

Method GET_SUSPEND_MODE on class CL_ESH_EX_FU_ADMIN has no exception.

Method REGISTER_OBJECT_TYPES 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 20110204
2 Importing IT_REGISTER Call by reference Type reference (TYPE) ESH_T_FU_CO_REG Register Object Types for CP or CP&FU 20090112
3 Importing IT_UNREGISTER Call by reference Type reference (TYPE) ESH_T_FU_CO_REG Unregister Object Types 20090112
4 Importing IV_AUTO_RESTART Call by reference Type reference (TYPE) CHAR01 ABAP_TRUE Auto-Restart Process if it is not running and not on Hold 20090209
# Exception Resumable Description Created on
1 CX_ESH_EX_PROCESS Extraction: Connection error 20090112

Method REORG_PROCESS_FEEDBACK Signature

# Type Parameter Pass Value Optional Typing Method Associated Type Default value Description Created on
1 Importing IV_KEEPING_DAYS Call by reference Type reference (TYPE) INT4 30 Keep for... (days) 20090226

Method REORG_PROCESS_FEEDBACK on class CL_ESH_EX_FU_ADMIN has no exception.

Method SET_PROCESS_PARAMETERS Signature

# Type Parameter Pass Value Optional Typing Method Associated Type Default value Description Created on
1 Importing IV_BLOCKSIZE Call by reference Type reference (TYPE) ESH_E_EX_FU_BLOCKSIZE GC_DEFAULT_FU_BLOCKSIZE Fast Update Extraction Blocksize 20090119
2 Importing IV_DO_COMMIT Call by reference Type reference (TYPE) CHAR01 ABAP_TRUE Do Commit 20090209
3 Importing IV_EXTRACT_FREQ Call by reference Type reference (TYPE) ESH_E_EX_FU_EXTRACT_FREQ GC_DEFAULT_FU_FREQUENCY Extract Frequency (secs) 20090119
4 Importing IV_MAX_IDLE_TIME Call by reference Type reference (TYPE) ESH_E_EX_FU_MAX_IDLE_TIME GC_DEFAULT_FU_MAX_IDLE_TIME Process will be stopped if idle for MAX_IDLE_TIME 20090119
5 Importing IV_MAX_RUNTIME Call by reference Type reference (TYPE) ESH_E_EX_FU_MAX_RUNTIME GC_DEFAULT_FU_MAX_RUNTIME Process will be stopped and restarted after MAX_RUNTIME 20090119
6 Importing IV_SUSPENDED_MODE Call by reference Type reference (TYPE) ESH_E_EX_FU_SUSPENDED_MODE SPACE Fast Update Suspended Mode 20090119
7 Importing IV_UNAME Call by reference Type reference (TYPE) SYUNAME User Name (if called via RFC) 20090205

Method SET_PROCESS_PARAMETERS on class CL_ESH_EX_FU_ADMIN has no exception.

Method SET_SUSPEND_MODE Signature

# Type Parameter Pass Value Optional Typing Method Associated Type Default value Description Created on
1 Importing IV_RESET Call by reference Type reference (TYPE) CHAR01 Reset 20090119
2 Importing IV_SUSPEND_FU Call by reference Type reference (TYPE) CHAR01 Suspend Fast Update 20090119
3 Importing IV_SUSPEND_FU_AND_CP Call by reference Type reference (TYPE) CHAR01 Suspend Fast Update and Change Pointer Processing 20090119

Method SET_SUSPEND_MODE on class CL_ESH_EX_FU_ADMIN has no exception.

Method START_JOB Signature

# Type Parameter Pass Value Optional 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 20081212
2 Importing IV_JOBSTART_STATUS Call by reference Type reference (TYPE) ESH_E_EX_FU_DEMON_RT_STATUS Runtime Status prior to Job Start 20090209
3 Importing IV_UNAME Call by reference Type reference (TYPE) SY-UNAME User Name 20090203
# Exception Resumable Description Created on
1 CX_ESH_EX_PROCESS Extraction: Connection error 20081210

Method START_PROCESS Signature

# Type Parameter Pass Value Optional 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 20081212
2 Importing IV_UNAME Call by reference Type reference (TYPE) SY-UNAME User Name 20090202
# Exception Resumable Description Created on
1 CX_ESH_EX_PROCESS Extraction: Connection error 20081210

Method STOP_JOB Signature

# Type Parameter Pass Value Optional 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 20081212
# Exception Resumable Description Created on
1 CX_ESH_EX_PROCESS Extraction: Connection error 20081210

Method STOP_PROCESS Signature

# Type Parameter Pass Value Optional 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 20081212
2 Importing IV_COMMIT_WORK Call by reference Type reference (TYPE) CHAR01 ABAP_TRUE Commit Work 20121016
3 Importing IV_UNAME Call by reference Type reference (TYPE) SY-UNAME User Name 20090202
# Exception Resumable Description Created on
1 CX_ESH_EX_PROCESS Extraction: Connection error 20081210
History
Last changed by/on SAP  20130531 
SAP Release Created in 720