SAP TREX_EXT_GET_SERVER_STATUS Function Module for Get Status of the TREX IndexServer









TREX_EXT_GET_SERVER_STATUS is a standard trex ext get server status SAP function module available within SAP R/3 or S/4 Hana systems, depending on your version and release level. It is used for Get Status of the TREX IndexServer processing and below is the pattern details for this FM, showing its interface including any import and export parameters, exceptions etc. there is also a full "cut and paste" ABAP pattern code example, along with implementation ABAP coding, documentation and contribution comments specific to this or related objects.


See here to view full function module documentation and code listing for trex ext get server status FM, simply by entering the name TREX_EXT_GET_SERVER_STATUS into the relevant SAP transaction such as SE37 or SE38.

Function Group: TREX_EXT_ADMINISTRATION
Program Name: SAPLTREX_EXT_ADMINISTRATION
Main Program: SAPLTREX_EXT_ADMINISTRATION
Appliation area:
Release date: N/A
Mode(Normal, Remote etc): Normal Function Module
Update:



Function TREX_EXT_GET_SERVER_STATUS pattern details

In-order to call this FM within your sap programs, simply using the below ABAP pattern details to trigger the function call...or see the full ABAP code listing at the end of this article. You can simply cut and paste this code into your ABAP progrom as it is, including variable declarations.
CALL FUNCTION 'TREX_EXT_GET_SERVER_STATUS'"Get Status of the TREX IndexServer
EXPORTING
* I_INDEXSERVER_LOCATION = "Host:Port
I_RFC_DESTINATION = "RFC Destination
* I_KEEP_LUW = '' "X: Only for debugging: no rollout and no commit

IMPORTING
E_STATUS_INFO = "server status info
E_RETURN_CODE = "Return Code
E_RETURN_TEXT = "Return Text

EXCEPTIONS
CONVERSION_ERROR = 1 ERROR = 2
.



IMPORTING Parameters details for TREX_EXT_GET_SERVER_STATUS

I_INDEXSERVER_LOCATION - Host:Port

Data type: TREX_RFC-LOCATION
Optional: Yes
Call by Reference: Yes

I_RFC_DESTINATION - RFC Destination

Data type: TREX_RFC-RFC_DESTINATION
Optional: No
Call by Reference: Yes

I_KEEP_LUW - X: Only for debugging: no rollout and no commit

Data type: TREX_RFC-FLAG
Default: ''
Optional: Yes
Call by Reference: Yes

EXPORTING Parameters details for TREX_EXT_GET_SERVER_STATUS

E_STATUS_INFO - server status info

Data type: TREXT_STATUS_INFO
Optional: No
Call by Reference: Yes

E_RETURN_CODE - Return Code

Data type: TREX_RFC-RETURN_CODE
Optional: No
Call by Reference: Yes

E_RETURN_TEXT - Return Text

Data type: TREX_RFC-RETURN_TEXT
Optional: No
Call by Reference: Yes

EXCEPTIONS details

CONVERSION_ERROR - Error during conversion to UTF-8

Data type:
Optional: No
Call by Reference: Yes

ERROR - Error, see error message

Data type:
Optional: No
Call by Reference: Yes

Copy and paste ABAP code example for TREX_EXT_GET_SERVER_STATUS Function Module

The ABAP code below is a full code listing to execute function module POPUP_TO_CONFIRM including all data declarations. The code uses the original data declarations rather than the latest in-line data DECLARATION SYNTAX but I have included an ABAP code snippet at the end to show how declarations would look using the newer method of declaring data variables on the fly. This will allow you to compare and fully understand the new inline method. Please note some of the newer syntax such as the @DATA is not available until a later 4.70 service pack (SP8), which i why i have stuck to the origianl for this example.

DATA:
lv_e_status_info  TYPE TREXT_STATUS_INFO, "   
lv_conversion_error  TYPE TREXT_STATUS_INFO, "   
lv_i_indexserver_location  TYPE TREX_RFC-LOCATION, "   
lv_error  TYPE TREX_RFC, "   
lv_e_return_code  TYPE TREX_RFC-RETURN_CODE, "   
lv_i_rfc_destination  TYPE TREX_RFC-RFC_DESTINATION, "   
lv_i_keep_luw  TYPE TREX_RFC-FLAG, "   ''
lv_e_return_text  TYPE TREX_RFC-RETURN_TEXT. "   

  CALL FUNCTION 'TREX_EXT_GET_SERVER_STATUS'  "Get Status of the TREX IndexServer
    EXPORTING
         I_INDEXSERVER_LOCATION = lv_i_indexserver_location
         I_RFC_DESTINATION = lv_i_rfc_destination
         I_KEEP_LUW = lv_i_keep_luw
    IMPORTING
         E_STATUS_INFO = lv_e_status_info
         E_RETURN_CODE = lv_e_return_code
         E_RETURN_TEXT = lv_e_return_text
    EXCEPTIONS
        CONVERSION_ERROR = 1
        ERROR = 2
. " TREX_EXT_GET_SERVER_STATUS




ABAP code using 7.40 inline data declarations to call FM TREX_EXT_GET_SERVER_STATUS

The below ABAP code uses the newer in-line data declarations. This allows you to see the coding differences/benefits of the later inline syntax. Please note some of the newer syntax below, such as the @DATA is not available until 4.70 EHP 8.

 
 
"SELECT single LOCATION FROM TREX_RFC INTO @DATA(ld_i_indexserver_location).
 
 
"SELECT single RETURN_CODE FROM TREX_RFC INTO @DATA(ld_e_return_code).
 
"SELECT single RFC_DESTINATION FROM TREX_RFC INTO @DATA(ld_i_rfc_destination).
 
"SELECT single FLAG FROM TREX_RFC INTO @DATA(ld_i_keep_luw).
DATA(ld_i_keep_luw) = ''.
 
"SELECT single RETURN_TEXT FROM TREX_RFC INTO @DATA(ld_e_return_text).
 


Search for further information about these or an SAP related objects



Comments on this SAP object

What made you want to lookup this SAP object? Please tell us what you were looking for and anything you would like to be included on this page!