SAP ABAP Class CL_ESH_INT_FU_ADMIN (Backend Integration: Fast Update)
Hierarchy
SAP_BASIS (Software Component) SAP Basis Component
   BC-EIM-ESH (Application Component) NetWeaver Enterprise Search
     S_ESH_ENG_INTEGRATION (Package) Backend Integration Services
Properties
Class CL_ESH_INT_FU_ADMIN  
Short Description Backend Integration: Fast Update    
Super Class    
Instantiability of a Class 2  Public 
Final    
General Data
Message Class    
Program status     
Category 0   
Package S_ESH_ENG_INTEGRATION   Backend Integration Services 
Created 20081211   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)
2 CL_ESH_EX_FU_ADMIN Forward declaration class (CLASS c DEFINITION DEFERRED)  Forward declaration class (CLASS c DEFINITION DEFERRED)
Interfaces
Class CL_ESH_INT_FU_ADMIN has no interface implemented.
Friends
Class CL_ESH_INT_FU_ADMIN has no friend class.
Attributes
# Attribute Level Visibility Read only Typing Associated Type Initial Value Description Created on
1 MR_APPLICATION_LOG Instance attribute Private Object reference (TYPE REF TO) IF_ESH_OM_APPLOG Application log 20090121
2 MR_INT_FU_ADMIN Static Attribute Private Object reference (TYPE REF TO) CL_ESH_INT_FU_ADMIN Back-end integration: Fast update 20090121
3 MR_METADATA_PROVIDER Instance attribute Private Object reference (TYPE REF TO) CL_ESH_SE_METADATA Metadata provider 20090526
4 ST_STATUS_TEXT Static Attribute Private Type reference (TYPE) LTY_T_STATUS_TEXT Status text buffer 20090526
Methods
# Method Level Visibility Method type Description Created on
1 ADD_MESSAGES_TO_LOG Instance method Private Method Add BAPI return messages to log 20090121
2 CHECK_BACKEND_CALL_SUPPORTED Instance method Private Method Check for appliance/back end scenario 20090121
3 GET_EXTRACTION_QUEUE Instance method Public Method Get queue status 20090122
4 GET_HOME_SOFTWARE_COMPONENT Instance method Private Method Get home software component 20090518
5 GET_INSTANCE Static method Public Method Get instance 20090121
6 GET_PROCESS_JOBLOG Instance method Public Method Get fast update process status 20090202
7 GET_PROCESS_STATUS Instance method Public Method Get fast update process status 20081211
8 GET_REGISTERED_OBJECT_TYPES Instance method Public Method Get registered object types for fast update 20090121
9 INI_INDEXING_DEL_CPOINTERS Instance method Public Method Cleanup old change pointers prior to Initial Indexing 20120711
10 INI_INDEXING_SET_CPSTATUS_T Instance method Public Method Set change pointer processing status "T" on Initial Indexing 20120711
11 REGISTER_OBJECT_TYPES Instance method Public Method (Un)Register object types for fast update 20090121
12 RESET_RTI_REGISTRATIONS Instance method Public Method Reset registrations on 'delete connector' 20090518
13 RFC_PING Static method Public Method Check validity of RFC destination 20090126
14 SET_PROCESS_PARAMETERS Instance method Public Method Set fast update process status 20090122
15 START_PROCESS Instance method Public Method Start daemon process 20090121
16 STATUS_GET_STATUS_TEXT Static method Public Method Get status text for status 20090526
17 STOP_PROCESS Instance method Public Method Stop daemon process 20090121
Events
Class CL_ESH_INT_FU_ADMIN has no event.
Types
# Type Visibility Typing Associated Type Description Created on Type Source
1 LTY_S_STATUS_TEXT Private See coding Status Text Buffer 20090526 BEGIN OF lty_s_status_text, rt_status TYPE esh_e_ex_fu_demon_rt_status, langu TYPE sy-langu, status_text TYPE val_text, END OF lty_s_status_text
2 LTY_T_STATUS_TEXT Private See coding Status Text Buffer (Sorted Table) 20090526 lty_t_status_text TYPE SORTED TABLE OF lty_s_status_text WITH UNIQUE KEY rt_status langu
Method Signatures

Method ADD_MESSAGES_TO_LOG Signature

# Type Parameter Pass Value Optional Typing Method Associated Type Default value Description Created on
1 Exporting ET_RETURN_CODES Call by reference Type reference (TYPE) BAPIRETTAB BAPI Return Messages 20110210
2 Exporting EV_ERROR_INCLUDED Call by reference Type reference (TYPE) ABAP_BOOL Error Included 20120711
3 Importing IR_APPLICATION_LOG Call by reference Object reference (TYPE REF TO) IF_ESH_OM_APPLOG Application Log 20110210
4 Importing IT_RETURN_CODES Call by reference Type reference (TYPE) BAPIRETTAB BAPI Return Messages 20090121
5 Importing IV_BAPIRETTAB_REQUESTED Call by reference Type reference (TYPE) CHAR01 Return Tab Requested 20110210
6 Importing IV_COMM_FAILURE_MSG Call by reference Type reference (TYPE) BAPI_MSG Log RFC Communication Failure 20090121
7 Importing IV_SYS_FAILURE_MSG Call by reference Type reference (TYPE) BAPI_MSG Log RFC System Failure 20090121

Method ADD_MESSAGES_TO_LOG on class CL_ESH_INT_FU_ADMIN has no exception.

Method CHECK_BACKEND_CALL_SUPPORTED Signature

# Type Parameter Pass Value Optional Typing Method Associated Type Default value Description Created on
1 Returning RV_SUPPORTED Value transfer Type reference (TYPE) CHAR01 Call to Backend Allowed 20090121

Method CHECK_BACKEND_CALL_SUPPORTED on class CL_ESH_INT_FU_ADMIN has no exception.

Method GET_EXTRACTION_QUEUE 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 20090122
2 Exporting ET_EXTRACTION_QUEUE Call by reference Type reference (TYPE) ESH_T_INT_FU_QUEUE Fast Update Queue with Status Information 20090122
3 Importing IV_GET_EXTRACTION_QUEUE Call by reference Type reference (TYPE) CHAR01 ABAP_TRUE Get Extraction Queue 20090122
4 Importing IV_GET_EXTRACTION_STATUS Call by reference Type reference (TYPE) CHAR01 ABAP_TRUE Get Extraction Status 20090122
5 Importing IV_OBJECT_TYPE Call by reference Type reference (TYPE) ESH_E_OM_OBJECT_TYPE Get Extraction Queue for: Object Type 20090122
6 Importing IV_RFC_DESTINATION Call by reference Type reference (TYPE) RFCDEST Logical Destination (Specified in Function Call) 20090122
7 Importing IV_SOFTWARE_COMP Call by reference Type reference (TYPE) ESH_E_OM_SYSREL Get Extraction Queue for: SW Comp 20090122
# Exception Resumable Description Created on
1 CX_ESH_INT_ENGINE ESH Integration Exception 20090122

Method GET_HOME_SOFTWARE_COMPONENT 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 20090518
2 Importing IV_OBJECT_TYPE Call by reference Type reference (TYPE) ESH_E_OM_OBJECT_TYPE Object Type 20090518
3 Importing IV_ORG_SYSREL_GUID Call by reference Type reference (TYPE) ESH_E_OM_SYSREL_GUID Org Sysrel_Guid 20090518
4 Returning RV_HOME_SOFTWARE_COMPONENT Value transfer Type reference (TYPE) ESH_E_OM_SYSREL Home Software Component 20090518
# Exception Resumable Description Created on
1 CX_ESH_INT_ENGINE ESH Integration Exception 20090518

Method GET_INSTANCE 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 20090121
2 Returning RR_INT_FU_ADMIN Value transfer Object reference (TYPE REF TO) CL_ESH_INT_FU_ADMIN Class instance 20090123

Method GET_INSTANCE on class CL_ESH_INT_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 (Default: 24 hrs) 20090202
3 Importing IV_RFC_DESTINATION Call by reference Type reference (TYPE) RFCDEST RFC Destination 20090202
# Exception Resumable Description Created on
1 CX_ESH_INT_ENGINE ESH Integration Exception 20090202

Method GET_PROCESS_STATUS Signature

# Type Parameter Pass Value Optional Typing Method Associated Type Default value Description Created on
1 Exporting ES_PROCESS_ADMIN_DATA Call by reference Type reference (TYPE) ESH_S_EX_FU_DEMON_ADM Fast Update Demon Admin Data 20090202
2 Exporting ES_PROCESS_FEEDBACK Call by reference Type reference (TYPE) ESH_S_EX_FU_DEMON_FBK Fast Update Demon Feedback 20090202
3 Exporting EV_PROCESS_STATUS Call by reference Type reference (TYPE) ESH_E_EX_FU_DEMON_RT_STATUS Fast Update Demon Runtime Status 20090202
4 Exporting EV_PROCESS_STATUS_MSG Call by reference Type reference (TYPE) BAPI_MSG Status Message (if availbl) 20090203
5 Importing IV_GET_PROCESS_ADMIN_DATA Call by reference Type reference (TYPE) CHAR01 ABAP_TRUE Get Process Admin Data 20090202
6 Importing IV_GET_PROCESS_FEEDBACK Call by reference Type reference (TYPE) CHAR01 ABAP_TRUE Get Process Feedback (Last Execution Timestamps) 20090202
7 Importing IV_GET_PROCESS_STATUS Call by reference Type reference (TYPE) CHAR01 ABAP_TRUE Get Process Runtime Status 20090202
8 Importing IV_RFC_DESTINATION Call by reference Type reference (TYPE) RFCDEST RFC Destination 20090202
# Exception Resumable Description Created on
1 CX_ESH_INT_ENGINE ESH Integration Exception 20090122

Method GET_REGISTERED_OBJECT_TYPES Signature

# Type Parameter Pass Value Optional Typing Method Associated Type Default value Description Created on
1 Exporting ET_REGISTERED_OBJECT_TYPES Call by reference Type reference (TYPE) ESH_T_FU_CO_REG 20090122
2 Importing IV_RFC_DESTINATION Call by reference Type reference (TYPE) RFCDEST 20090121
# Exception Resumable Description Created on
1 CX_ESH_INT_ENGINE ESH Integration Exception 20090122

Method INI_INDEXING_DEL_CPOINTERS Signature

# Type Parameter Pass Value Optional Typing Method Associated Type Default value Description Created on
1 Exporting ET_MESSAGES Call by reference Type reference (TYPE) BAPIRETTAB Table with BAPI Return Information 20120711
2 Importing IV_OBJECT_TYPE Call by reference Type reference (TYPE) ESH_E_OM_OBJECT_TYPE Object Type 20120711
3 Importing IV_RFC_DESTINATION Call by reference Type reference (TYPE) RFCDEST Backend Destination 20120711
4 Importing IV_SOFTWARE_COMPONENT Call by reference Type reference (TYPE) ESH_E_OM_SYSREL Software Component (Object hSWC) 20120711
# Exception Resumable Description Created on
1 CX_ESH_INT_ENGINE ESH Integration Exception 20120711

Method INI_INDEXING_SET_CPSTATUS_T Signature

# Type Parameter Pass Value Optional Typing Method Associated Type Default value Description Created on
1 Exporting ET_MESSAGES Call by reference Type reference (TYPE) BAPIRETTAB Table with BAPI Return Information 20120711
2 Importing IV_OBJECT_TYPE Call by reference Type reference (TYPE) ESH_E_OM_OBJECT_TYPE Object Type 20120711
3 Importing IV_RFC_DESTINATION Call by reference Type reference (TYPE) RFCDEST Backend Destination 20120711
4 Importing IV_SOFTWARE_COMPONENT Call by reference Type reference (TYPE) ESH_E_OM_SYSREL Software Component (Object hSWC) 20120711
5 Importing IV_TIMESTAMP_INI_INDEXING Call by reference Type reference (TYPE) ESH_E_ADM_TSTMP_INITIAL_INDEX Timestamp of Initial Indexing 20120711
# Exception Resumable Description Created on
1 CX_ESH_INT_ENGINE ESH Integration Exception 20120711

Method REGISTER_OBJECT_TYPES Signature

# Type Parameter Pass Value Optional Typing Method Associated Type Default value Description Created on
1 Exporting ET_MESSAGES Call by reference Type reference (TYPE) BAPIRETTAB Messsages 20110210
2 Importing IT_REGISTER Call by reference Type reference (TYPE) ESH_T_FU_CO_REG Fast Update: Connector Registration 20090121
3 Importing IT_UNREGISTER Call by reference Type reference (TYPE) ESH_T_FU_CO_REG Fast Update: Connector Registration 20090121
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
5 Importing IV_RFC_DESTINATION Call by reference Type reference (TYPE) RFCDEST Logical Destination (Specified in Function Call) 20090121
# Exception Resumable Description Created on
1 CX_ESH_INT_ENGINE ESH Integration Exception 20090121

Method RESET_RTI_REGISTRATIONS Signature

# Type Parameter Pass Value Optional Typing Method Associated Type Default value Description Created on
1 Importing IT_DELTA_OBJECTS Call by reference Type reference (TYPE) ESH_T_OM_TRANS_DELTA_OBJECTS Object List with Tasks (Delete) 20090518
2 Importing IV_CONNECTION_GUID Call by reference Type reference (TYPE) ESH_E_ADM_CONNECTION_GUID Connection GUID 20090518
# Exception Resumable Description Created on
1 CX_ESH_INT_ENGINE ESH Integration Exception 20090518

Method RFC_PING Signature

# Type Parameter Pass Value Optional Typing Method Associated Type Default value Description Created on
1 Exporting EV_MESSAGE Call by reference Type reference (TYPE) BAPI_MSG Message 20090203
2 Exporting EV_STATUS Call by reference Type reference (TYPE) ESH_E_EX_FU_DEMON_RT_STATUS Status 20090203
3 Importing IV_GET_STATUS Call by reference Type reference (TYPE) CHAR01 ABAP_TRUE Get Status if Backend Reached 20090203
4 Importing IV_RFC_DESTINATION Call by reference Type reference (TYPE) RFCDEST Logical Destination (Specified in Function Call) 20090126

Method RFC_PING on class CL_ESH_INT_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 CL_ESH_EX_FU_ADMIN=>GC_DEFAULT_FU_BLOCKSIZE Fast Update Extraction Blocksize 20090122
2 Importing IV_EXTRACT_FREQ Call by reference Type reference (TYPE) ESH_E_EX_FU_EXTRACT_FREQ CL_ESH_EX_FU_ADMIN=>GC_DEFAULT_FU_FREQUENCY Extraction Frequency 20090122
3 Importing IV_MAX_IDLE_TIME Call by reference Type reference (TYPE) ESH_E_EX_FU_MAX_IDLE_TIME CL_ESH_EX_FU_ADMIN=>GC_DEFAULT_FU_MAX_IDLE_TIME Fast Update: Max Idle Time 20090122
4 Importing IV_MAX_RUNTIME Call by reference Type reference (TYPE) ESH_E_EX_FU_MAX_RUNTIME CL_ESH_EX_FU_ADMIN=>GC_DEFAULT_FU_MAX_RUNTIME Fast Update: Max Runtime (secs) 20090122
5 Importing IV_RFC_DESTINATION Call by reference Type reference (TYPE) RFCDEST Logical Destination (Specified in Function Call) 20090122
6 Importing IV_SUSPEND_MODE Call by reference Type reference (TYPE) ESH_E_EX_FU_SUSPENDED_MODE SPACE Fast Update Suspended Mode 20090122
# Exception Resumable Description Created on
1 CX_ESH_INT_ENGINE ESH Integration Exception 20090122

Method START_PROCESS 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 CL_ESH_EX_FU_ADMIN=>GC_DEFAULT_FU_BLOCKSIZE Fast Update Extraction Blocksize 20090121
2 Importing IV_EXTRACT_FREQ Call by reference Type reference (TYPE) ESH_E_EX_FU_EXTRACT_FREQ CL_ESH_EX_FU_ADMIN=>GC_DEFAULT_FU_FREQUENCY Extraction Frequency 20090121
3 Importing IV_MAX_IDLE_TIME Call by reference Type reference (TYPE) ESH_E_EX_FU_MAX_IDLE_TIME CL_ESH_EX_FU_ADMIN=>GC_DEFAULT_FU_MAX_IDLE_TIME Fast Update: Max Idle Time 20090121
4 Importing IV_MAX_RUNTIME Call by reference Type reference (TYPE) ESH_E_EX_FU_MAX_RUNTIME CL_ESH_EX_FU_ADMIN=>GC_DEFAULT_FU_MAX_RUNTIME Fast Update: Max Runtime (secs) 20090121
5 Importing IV_RFC_DESTINATION Call by reference Type reference (TYPE) RFCDEST Logical Destination (Specified in Function Call) 20090121
6 Importing IV_SUSPEND_MODE Call by reference Type reference (TYPE) ESH_E_EX_FU_SUSPENDED_MODE SPACE Fast Update Suspended Mode 20090121
# Exception Resumable Description Created on
1 CX_ESH_INT_ENGINE ESH Integration Exception 20090121

Method STATUS_GET_STATUS_TEXT Signature

# Type Parameter Pass Value Optional Typing Method Associated Type Default value Description Created on
1 Returning EV_STATUS_TEXT Value transfer Type reference (TYPE) VAL_TEXT Short Text for Fixed Values 20090526
2 Importing IV_LANGU Call by reference Type reference (TYPE) SY-LANGU Language Key 20090526
3 Importing IV_PROCESS_STATUS Call by reference Type reference (TYPE) ESH_E_EX_FU_DEMON_RT_STATUS Fast Update Demon Runtime Status 20090526

Method STATUS_GET_STATUS_TEXT on class CL_ESH_INT_FU_ADMIN has no exception.

Method STOP_PROCESS Signature

# Type Parameter Pass Value Optional Typing Method Associated Type Default value Description Created on
1 Importing IV_RFC_DESTINATION Call by reference Type reference (TYPE) RFCDEST Logical Destination (Specified in Function Call) 20090121
# Exception Resumable Description Created on
1 CX_ESH_INT_ENGINE ESH Integration Exception 20090121
History
Last changed by/on SAP  20130531 
SAP Release Created in 720