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 | Type group use (TYPE-POOLS tp) | Type group use (TYPE-POOLS tp) | |
| 2 | 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 | Instance attribute | Private | Object reference (TYPE REF TO) | IF_ESH_OM_APPLOG | Application log | 20090121 | |||
| 2 | Static Attribute | Private | Object reference (TYPE REF TO) | CL_ESH_INT_FU_ADMIN | Back-end integration: Fast update | 20090121 | |||
| 3 | Instance attribute | Private | Object reference (TYPE REF TO) | CL_ESH_SE_METADATA | Metadata provider | 20090526 | |||
| 4 | Static Attribute | Private | Type reference (TYPE) | LTY_T_STATUS_TEXT | Status text buffer | 20090526 |
Methods
| # | Method | Level | Visibility | Method type | Description | Created on |
|---|---|---|---|---|---|---|
| 1 | Instance method | Private | Method | Add BAPI return messages to log | 20090121 | |
| 2 | Instance method | Private | Method | Check for appliance/back end scenario | 20090121 | |
| 3 | Instance method | Public | Method | Get queue status | 20090122 | |
| 4 | Instance method | Private | Method | Get home software component | 20090518 | |
| 5 | Static method | Public | Method | Get instance | 20090121 | |
| 6 | Instance method | Public | Method | Get fast update process status | 20090202 | |
| 7 | Instance method | Public | Method | Get fast update process status | 20081211 | |
| 8 | Instance method | Public | Method | Get registered object types for fast update | 20090121 | |
| 9 | Instance method | Public | Method | Cleanup old change pointers prior to Initial Indexing | 20120711 | |
| 10 | Instance method | Public | Method | Set change pointer processing status "T" on Initial Indexing | 20120711 | |
| 11 | Instance method | Public | Method | (Un)Register object types for fast update | 20090121 | |
| 12 | Instance method | Public | Method | Reset registrations on 'delete connector' | 20090518 | |
| 13 | Static method | Public | Method | Check validity of RFC destination | 20090126 | |
| 14 | Instance method | Public | Method | Set fast update process status | 20090122 | |
| 15 | Instance method | Public | Method | Start daemon process | 20090121 | |
| 16 | Static method | Public | Method | Get status text for status | 20090526 | |
| 17 | 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 | ET_RETURN_CODES | Call by reference | Type reference (TYPE) | BAPIRETTAB | BAPI Return Messages | 20110210 | |||
| 2 | EV_ERROR_INCLUDED | Call by reference | Type reference (TYPE) | ABAP_BOOL | Error Included | 20120711 | |||
| 3 | IR_APPLICATION_LOG | Call by reference | Object reference (TYPE REF TO) | IF_ESH_OM_APPLOG | Application Log | 20110210 | |||
| 4 | IT_RETURN_CODES | Call by reference | Type reference (TYPE) | BAPIRETTAB | BAPI Return Messages | 20090121 | |||
| 5 | IV_BAPIRETTAB_REQUESTED | Call by reference | Type reference (TYPE) | CHAR01 | Return Tab Requested | 20110210 | |||
| 6 | IV_COMM_FAILURE_MSG | Call by reference | Type reference (TYPE) | BAPI_MSG | Log RFC Communication Failure | 20090121 | |||
| 7 | 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 | 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 | ES_EXTRACTION_STATUS | Call by reference | Type reference (TYPE) | ESH_S_EX_FU_EXTRACT_STATUSINFO | Fast Update / CP Extraction Status Info | 20090122 | |||
| 2 | ET_EXTRACTION_QUEUE | Call by reference | Type reference (TYPE) | ESH_T_INT_FU_QUEUE | Fast Update Queue with Status Information | 20090122 | |||
| 3 | IV_GET_EXTRACTION_QUEUE | Call by reference | Type reference (TYPE) | CHAR01 | ABAP_TRUE | Get Extraction Queue | 20090122 | ||
| 4 | IV_GET_EXTRACTION_STATUS | Call by reference | Type reference (TYPE) | CHAR01 | ABAP_TRUE | Get Extraction Status | 20090122 | ||
| 5 | IV_OBJECT_TYPE | Call by reference | Type reference (TYPE) | ESH_E_OM_OBJECT_TYPE | Get Extraction Queue for: Object Type | 20090122 | |||
| 6 | IV_RFC_DESTINATION | Call by reference | Type reference (TYPE) | RFCDEST | Logical Destination (Specified in Function Call) | 20090122 | |||
| 7 | 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 | 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 | IV_CONNECTION_GUID | Call by reference | Type reference (TYPE) | ESH_E_ADM_CONNECTION_GUID | Connection GUID | 20090518 | |||
| 2 | IV_OBJECT_TYPE | Call by reference | Type reference (TYPE) | ESH_E_OM_OBJECT_TYPE | Object Type | 20090518 | |||
| 3 | IV_ORG_SYSREL_GUID | Call by reference | Type reference (TYPE) | ESH_E_OM_SYSREL_GUID | Org Sysrel_Guid | 20090518 | |||
| 4 | RV_HOME_SOFTWARE_COMPONENT | Value transfer | Type reference (TYPE) | ESH_E_OM_SYSREL | Home Software Component | 20090518 |
| # | Exception | Resumable | Description | Created on |
|---|---|---|---|---|
| 1 | ESH Integration Exception | 20090518 |
Method GET_INSTANCE Signature
| # | Type | Parameter | Pass Value | Optional | Typing Method | Associated Type | Default value | Description | Created on |
|---|---|---|---|---|---|---|---|---|---|
| 1 | IR_APPLICATION_LOG | Call by reference | Object reference (TYPE REF TO) | IF_ESH_OM_APPLOG | Application Log | 20090121 | |||
| 2 | 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 | ET_LOGS | Call by reference | Type reference (TYPE) | BAPIRETTAB | Process Logs | 20090202 | |||
| 2 | IV_FROM_TIMESTAMP | Call by reference | Type reference (TYPE) | TIMESTAMP | From Timestamp (Default: 24 hrs) | 20090202 | |||
| 3 | IV_RFC_DESTINATION | Call by reference | Type reference (TYPE) | RFCDEST | RFC Destination | 20090202 |
| # | Exception | Resumable | Description | Created on |
|---|---|---|---|---|
| 1 | ESH Integration Exception | 20090202 |
Method GET_PROCESS_STATUS Signature
| # | Type | Parameter | Pass Value | Optional | Typing Method | Associated Type | Default value | Description | Created on |
|---|---|---|---|---|---|---|---|---|---|
| 1 | ES_PROCESS_ADMIN_DATA | Call by reference | Type reference (TYPE) | ESH_S_EX_FU_DEMON_ADM | Fast Update Demon Admin Data | 20090202 | |||
| 2 | ES_PROCESS_FEEDBACK | Call by reference | Type reference (TYPE) | ESH_S_EX_FU_DEMON_FBK | Fast Update Demon Feedback | 20090202 | |||
| 3 | EV_PROCESS_STATUS | Call by reference | Type reference (TYPE) | ESH_E_EX_FU_DEMON_RT_STATUS | Fast Update Demon Runtime Status | 20090202 | |||
| 4 | EV_PROCESS_STATUS_MSG | Call by reference | Type reference (TYPE) | BAPI_MSG | Status Message (if availbl) | 20090203 | |||
| 5 | IV_GET_PROCESS_ADMIN_DATA | Call by reference | Type reference (TYPE) | CHAR01 | ABAP_TRUE | Get Process Admin Data | 20090202 | ||
| 6 | IV_GET_PROCESS_FEEDBACK | Call by reference | Type reference (TYPE) | CHAR01 | ABAP_TRUE | Get Process Feedback (Last Execution Timestamps) | 20090202 | ||
| 7 | IV_GET_PROCESS_STATUS | Call by reference | Type reference (TYPE) | CHAR01 | ABAP_TRUE | Get Process Runtime Status | 20090202 | ||
| 8 | IV_RFC_DESTINATION | Call by reference | Type reference (TYPE) | RFCDEST | RFC Destination | 20090202 |
| # | Exception | Resumable | Description | Created on |
|---|---|---|---|---|
| 1 | 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 | ET_REGISTERED_OBJECT_TYPES | Call by reference | Type reference (TYPE) | ESH_T_FU_CO_REG | 20090122 | ||||
| 2 | IV_RFC_DESTINATION | Call by reference | Type reference (TYPE) | RFCDEST | 20090121 |
| # | Exception | Resumable | Description | Created on |
|---|---|---|---|---|
| 1 | 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 | ET_MESSAGES | Call by reference | Type reference (TYPE) | BAPIRETTAB | Table with BAPI Return Information | 20120711 | |||
| 2 | IV_OBJECT_TYPE | Call by reference | Type reference (TYPE) | ESH_E_OM_OBJECT_TYPE | Object Type | 20120711 | |||
| 3 | IV_RFC_DESTINATION | Call by reference | Type reference (TYPE) | RFCDEST | Backend Destination | 20120711 | |||
| 4 | IV_SOFTWARE_COMPONENT | Call by reference | Type reference (TYPE) | ESH_E_OM_SYSREL | Software Component (Object hSWC) | 20120711 |
| # | Exception | Resumable | Description | Created on |
|---|---|---|---|---|
| 1 | 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 | ET_MESSAGES | Call by reference | Type reference (TYPE) | BAPIRETTAB | Table with BAPI Return Information | 20120711 | |||
| 2 | IV_OBJECT_TYPE | Call by reference | Type reference (TYPE) | ESH_E_OM_OBJECT_TYPE | Object Type | 20120711 | |||
| 3 | IV_RFC_DESTINATION | Call by reference | Type reference (TYPE) | RFCDEST | Backend Destination | 20120711 | |||
| 4 | IV_SOFTWARE_COMPONENT | Call by reference | Type reference (TYPE) | ESH_E_OM_SYSREL | Software Component (Object hSWC) | 20120711 | |||
| 5 | 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 | ESH Integration Exception | 20120711 |
Method REGISTER_OBJECT_TYPES Signature
| # | Type | Parameter | Pass Value | Optional | Typing Method | Associated Type | Default value | Description | Created on |
|---|---|---|---|---|---|---|---|---|---|
| 1 | ET_MESSAGES | Call by reference | Type reference (TYPE) | BAPIRETTAB | Messsages | 20110210 | |||
| 2 | IT_REGISTER | Call by reference | Type reference (TYPE) | ESH_T_FU_CO_REG | Fast Update: Connector Registration | 20090121 | |||
| 3 | IT_UNREGISTER | Call by reference | Type reference (TYPE) | ESH_T_FU_CO_REG | Fast Update: Connector Registration | 20090121 | |||
| 4 | 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 | IV_RFC_DESTINATION | Call by reference | Type reference (TYPE) | RFCDEST | Logical Destination (Specified in Function Call) | 20090121 |
| # | Exception | Resumable | Description | Created on |
|---|---|---|---|---|
| 1 | ESH Integration Exception | 20090121 |
Method RESET_RTI_REGISTRATIONS Signature
| # | Type | Parameter | Pass Value | Optional | Typing Method | Associated Type | Default value | Description | Created on |
|---|---|---|---|---|---|---|---|---|---|
| 1 | IT_DELTA_OBJECTS | Call by reference | Type reference (TYPE) | ESH_T_OM_TRANS_DELTA_OBJECTS | Object List with Tasks (Delete) | 20090518 | |||
| 2 | IV_CONNECTION_GUID | Call by reference | Type reference (TYPE) | ESH_E_ADM_CONNECTION_GUID | Connection GUID | 20090518 |
| # | Exception | Resumable | Description | Created on |
|---|---|---|---|---|
| 1 | ESH Integration Exception | 20090518 |
Method RFC_PING Signature
| # | Type | Parameter | Pass Value | Optional | Typing Method | Associated Type | Default value | Description | Created on |
|---|---|---|---|---|---|---|---|---|---|
| 1 | EV_MESSAGE | Call by reference | Type reference (TYPE) | BAPI_MSG | Message | 20090203 | |||
| 2 | EV_STATUS | Call by reference | Type reference (TYPE) | ESH_E_EX_FU_DEMON_RT_STATUS | Status | 20090203 | |||
| 3 | IV_GET_STATUS | Call by reference | Type reference (TYPE) | CHAR01 | ABAP_TRUE | Get Status if Backend Reached | 20090203 | ||
| 4 | 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 | 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 | 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 | 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 | 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 | IV_RFC_DESTINATION | Call by reference | Type reference (TYPE) | RFCDEST | Logical Destination (Specified in Function Call) | 20090122 | |||
| 6 | 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 | ESH Integration Exception | 20090122 |
Method START_PROCESS Signature
| # | Type | Parameter | Pass Value | Optional | Typing Method | Associated Type | Default value | Description | Created on |
|---|---|---|---|---|---|---|---|---|---|
| 1 | 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 | 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 | 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 | 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 | IV_RFC_DESTINATION | Call by reference | Type reference (TYPE) | RFCDEST | Logical Destination (Specified in Function Call) | 20090121 | |||
| 6 | 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 | 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 | EV_STATUS_TEXT | Value transfer | Type reference (TYPE) | VAL_TEXT | Short Text for Fixed Values | 20090526 | |||
| 2 | IV_LANGU | Call by reference | Type reference (TYPE) | SY-LANGU | Language Key | 20090526 | |||
| 3 | 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 | IV_RFC_DESTINATION | Call by reference | Type reference (TYPE) | RFCDEST | Logical Destination (Specified in Function Call) | 20090121 |
| # | Exception | Resumable | Description | Created on |
|---|---|---|---|---|
| 1 | ESH Integration Exception | 20090121 |
History
| Last changed by/on | SAP | 20130531 |
| SAP Release Created in | 720 |