SAP ABAP Class CL_ESH_INT_CONFIG_TOOLS (Tools for Cross-System Communication)
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_CONFIG_TOOLS | |
| Short Description | Tools for Cross-System Communication | |
| 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 | 20080730 | SAP |
| Last change | 20141121 | |
| 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) |
Interfaces
Class CL_ESH_INT_CONFIG_TOOLS has no interface implemented.
Friends
Class CL_ESH_INT_CONFIG_TOOLS has no friend class.
Attributes
| # | Attribute | Level | Visibility | Read only | Typing | Associated Type | Initial Value | Description | Created on |
|---|---|---|---|---|---|---|---|---|---|
| 1 | Constant | Public | Type reference (TYPE) | DDOBJNAME | '%BACKEND_CONNECTION_GUID%' | Name of ABAP Dictionary object | 20090120 | ||
| 2 | Constant | Public | Type reference (TYPE) | DDOBJNAME | 'CONNECTOR_DATA' | Name of ABAP Dictionary object | 20080801 | ||
| 3 | Constant | Public | Type reference (TYPE) | DDOBJNAME | '%CATEGORIES%' | Name of ABAP Dictionary object | 20080813 | ||
| 4 | Constant | Public | Type reference (TYPE) | DDOBJNAME | '%CONNECTION_GUID%' | Name of ABAP Dictionary object | 20080813 | ||
| 5 | Constant | Public | Type reference (TYPE) | DDOBJNAME | '%CONNECTORS%' | Name of ABAP Dictionary object | 20080813 | ||
| 6 | Constant | Public | Type reference (TYPE) | DDOBJNAME | '%CONNECTORS_EXECUTION%' | Name of ABAP Dictionary object | 20080813 | ||
| 7 | Constant | Public | Type reference (TYPE) | DDOBJNAME | '%CUSTOM_DATA%' | Name of ABAP Dictionary Object | 20110517 | ||
| 8 | Constant | Public | Type reference (TYPE) | DDOBJNAME | '%KEYWORDS%' | Name of ABAP Dictionary object | 20090520 | ||
| 9 | Constant | Public | Type reference (TYPE) | DDOBJNAME | '%OBJECT_TYPES%' | Name of ABAP Dictionary object | 20090119 | ||
| 10 | Constant | Public | Type reference (TYPE) | DDOBJNAME | '%SYSTEM_CLIENT%' | Name of ABAP Dictionary Object | 20130826 | ||
| 11 | Constant | Public | Type reference (TYPE) | DDOBJNAME | '%SYSTEM_ID%' | Name of ABAP Dictionary Object | 20130826 | ||
| 12 | Constant | Public | Type reference (TYPE) | DDOBJNAME | '%TEMPLATES%' | Name of ABAP Dictionary object | 20080813 | ||
| 13 | Constant | Public | Type reference (TYPE) | TROBJTYPE | 'DTEL' | Object type | 20080813 | ||
| 14 | Constant | Public | Type reference (TYPE) | TROBJTYPE | 'TABL' | Object type | 20080730 | ||
| 15 | Constant | Public | Type reference (TYPE) | TROBJTYPE | 'TTYP' | Object type | 20080730 | ||
| 16 | Constant | Public | Type reference (TYPE) | SYMSGID | 'ESH_INTEGRATION' | Message class | 20080730 | ||
| 17 | Constant | Public | Type reference (TYPE) | SYMSGTY | 'E' | Message type error | 20080730 | ||
| 18 | Constant | Public | Type reference (TYPE) | DDOBJNAME | 'MODEL_DATA' | Name of ABAP Dictionary object | 20080730 | ||
| 19 | Constant | Public | Type reference (TYPE) | DDOBJNAME | 'MODEL_DATA_ACTIVE' | Name of ABAP Dictionary object | 20080730 | ||
| 20 | Constant | Public | Type reference (TYPE) | DDOBJNAME | 'MODEL_DATA_ACTIVE_ENH' | Name of ABAP Dictionary object | 20100203 | ||
| 21 | Constant | Public | Type reference (TYPE) | DDOBJNAME | 'MODEL_DATA_INACTIVE' | Name of ABAP Dictionary object | 20080730 | ||
| 22 | Constant | Public | Type reference (TYPE) | DDOBJNAME | 'MODEL_DATA_INACTIVE_ENH' | Name of ABAP Dictionary object | 20100203 | ||
| 23 | Static Attribute | Public | Object reference (TYPE REF TO) | IF_ESH_OM_APPLOG | Application log | 20080730 |
Methods
| # | Method | Level | Visibility | Method type | Description | Created on |
|---|---|---|---|---|---|---|
| 1 | Static method | Public | Method | Ping RFC destination | 20090127 | |
| 2 | Static method | Public | Method | Check authorization and appliance switch | 20080730 | |
| 3 | Static method | Public | Method | Get log entries | 20080730 | |
| 4 | Static method | Public | Method | Pack cluster | 20080730 | |
| 5 | Static method | Public | Method | Set message | 20080730 | |
| 6 | Static method | Public | Method | Unpack cluster | 20080730 |
Events
Class CL_ESH_INT_CONFIG_TOOLS has no event.
Types
Class CL_ESH_INT_CONFIG_TOOLS has no local type.
Method Signatures
Method CHECK_DESTINATION Signature
| # | Type | Parameter | Pass Value | Optional | Typing Method | Associated Type | Default value | Description | Created on |
|---|---|---|---|---|---|---|---|---|---|
| 1 | CT_RETURN_CODES | Call by reference | Type reference (TYPE) | BAPIRETTAB | Table with BAPI Return Information | 20090127 | |||
| 2 | EV_OK | Call by reference | Type reference (TYPE) | ABAP_BOOL | Destination is OK | 20090127 | |||
| 3 | IO_APPLOG | Call by reference | Object reference (TYPE REF TO) | IF_ESH_OM_APPLOG | Application Log | 20090127 | |||
| 4 | IV_RFC_DESTINATION | Call by reference | Type reference (TYPE) | RFCDEST | Logical Destination (Specified in Function Call) | 20090127 | |||
| 5 | IV_SYSTEM_CLIENT | Call by reference | Type reference (TYPE) | SYST-MANDT | Client ID of Current User | 20090127 | |||
| 6 | IV_SYSTEM_ID | Call by reference | Type reference (TYPE) | SYST-SYSID | Name of the SAP System | 20090127 | |||
| 7 | IV_TIMEOUT_SECONDS | Value transfer | Type reference (TYPE) | INT4 | 3 | Timeout in seconds | 20090127 |
Method CHECK_DESTINATION on class CL_ESH_INT_CONFIG_TOOLS has no exception.
Method CHECK_STATUS_APPLIANCE Signature
| # | Type | Parameter | Pass Value | Optional | Typing Method | Associated Type | Default value | Description | Created on |
|---|---|---|---|---|---|---|---|---|---|
| 1 | IV_CHECK_AUTHORITY | Call by reference | Type reference (TYPE) | ABAP_BOOL | ABAP_TRUE | Check for admin authorization | 20100205 | ||
| 2 | IV_CHECK_FOR_APPLIANCE | Call by reference | Type reference (TYPE) | ABAP_BOOL | ABAP_TRUE | Check system is appliance | 20080730 | ||
| 3 | RT_RETURN_CODES | Value transfer | Type reference (TYPE) | BAPIRETTAB | Table with BAPI Return Information | 20080730 |
Method CHECK_STATUS_APPLIANCE on class CL_ESH_INT_CONFIG_TOOLS has no exception.
Method GET_LOG Signature
| # | Type | Parameter | Pass Value | Optional | Typing Method | Associated Type | Default value | Description | Created on |
|---|---|---|---|---|---|---|---|---|---|
| 1 | CT_RETURN_CODES | Value transfer | Type reference (TYPE) | BAPIRETTAB | Table with BAPI Return Information | 20080730 | |||
| 2 | IR_APPLOG | Call by reference | Object reference (TYPE REF TO) | IF_ESH_OM_APPLOG | Application Log | 20081002 |
Method GET_LOG on class CL_ESH_INT_CONFIG_TOOLS has no exception.
Method PACK_CLUSTER Signature
| # | Type | Parameter | Pass Value | Optional | Typing Method | Associated Type | Default value | Description | Created on |
|---|---|---|---|---|---|---|---|---|---|
| 1 | ES_DATA | Call by reference | Type reference (TYPE) | ESH_S_INT_CLUSTER | Data Cluster Container | 20080730 | |||
| 2 | IV_CONTENT | Call by reference | Type reference (TYPE) | DDOBJNAME | Name of ABAP Dictionary Object | 20080730 | |||
| 3 | IV_DDIC_NAME | Call by reference | Type reference (TYPE) | DDOBJNAME | Name of ABAP Dictionary Object | 20080730 | |||
| 4 | IV_DDIC_TYPE | Call by reference | Type reference (TYPE) | TROBJTYPE | Object Type | 20080730 | |||
| 5 | IX_DATA | Call by reference | Type reference (TYPE) | ANY | 20080730 |
Method PACK_CLUSTER on class CL_ESH_INT_CONFIG_TOOLS has no exception.
Method SET_MESSAGE Signature
| # | Type | Parameter | Pass Value | Optional | Typing Method | Associated Type | Default value | Description | Created on |
|---|---|---|---|---|---|---|---|---|---|
| 1 | IV_MSGID | Call by reference | Type reference (TYPE) | SYMSGID | Message Class | 20080730 | |||
| 2 | IV_MSGNO | Call by reference | Type reference (TYPE) | SYMSGNO | Message Number | 20080730 | |||
| 3 | IV_MSGTY | Call by reference | Type reference (TYPE) | SYMSGTY | Message Type | 20080730 | |||
| 4 | IV_MSGV1 | Call by reference | Type reference (TYPE) | SYMSGV | Message Variable | 20080730 | |||
| 5 | IV_MSGV2 | Call by reference | Type reference (TYPE) | SYMSGV | Message Variable | 20080730 | |||
| 6 | IV_MSGV3 | Call by reference | Type reference (TYPE) | SYMSGV | Message Variable | 20080730 | |||
| 7 | IV_MSGV4 | Call by reference | Type reference (TYPE) | SYMSGV | Message Variable | 20080730 |
Method SET_MESSAGE on class CL_ESH_INT_CONFIG_TOOLS has no exception.
Method UNPACK_CLUSTER Signature
| # | Type | Parameter | Pass Value | Optional | Typing Method | Associated Type | Default value | Description | Created on |
|---|---|---|---|---|---|---|---|---|---|
| 1 | CR_DATA | Call by reference | Object reference (TYPE REF TO) | DATA | 20081007 | ||||
| 2 | CT_RETURN_CODES | Call by reference | Type reference (TYPE) | BAPIRETTAB | Table with BAPI Return Information | 20080730 | |||
| 3 | EV_CLUSTER_IMPORT_ERROR | Call by reference | Type reference (TYPE) | ABAP_BOOL | 20090226 | ||||
| 4 | IS_DATA | Call by reference | Type reference (TYPE) | ESH_S_INT_CLUSTER | Data Cluster Container | 20080730 |
Method UNPACK_CLUSTER on class CL_ESH_INT_CONFIG_TOOLS has no exception.
History
| Last changed by/on | SAP | 20141121 |
| SAP Release Created in | 712 |