TREX_DBS_PE_OPEN_SESSION SAP Function module - Open Planning Session

TREX_DBS_PE_OPEN_SESSION is a standard SAP function module available within R/3 SAP systems depending on your version and release level. Below is the pattern details for this FM showing its interface including any import and export parameters, exceptions etc as well as any documentation contributions (Comments) specific to the object.

See here to view full function module documentation and code listing, simply by entering the name TREX_DBS_PE_OPEN_SESSION into the relevant SAP transaction such as SE37 or SE80.

Associated Function Group: TREX_DBS_PE
Released Date: Not Released
Processing type: Normal fucntion module

Pattern for FM TREX_DBS_PE_OPEN_SESSION - TREX DBS PE OPEN SESSION

CALL FUNCTION 'TREX_DBS_PE_OPEN_SESSION' "Open Planning Session
  EXPORTING
    i_session_id =              " trexd_pe_session_id  Planning: Session Id
    i_main_index_id =           " trexd_index_id  Index Id
    i_xml =                     " xstring
    i_result =                  " string
  IMPORTING
    e_return_code =             " trex_rfc-return_code  Return Code
    e_return_text =             " trex_rfc-return_text  Return Text
  EXCEPTIONS
    MAIN_INDEX_DOES_NOT_EXIST = 1  "            Main index does not exist
    SESSION_ALREADY_LOCKED = 2  "               Session already locked
    SESSION_ALREADY_EXISTS = 3  "               Session already exists
    .  "  TREX_DBS_PE_OPEN_SESSION

ABAP code example for Function Module TREX_DBS_PE_OPEN_SESSION

The ABAP code below is a full code listing to execute function module TREX_DBS_PE_OPEN_SESSION including all data declarations. The code uses 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 original method of declaring data variables up front. 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).

DATA:
ld_e_return_code  
 
 TYPE TREX_RFC-RETURN_CODE
,
ld_e_return_text  
 
 TYPE TREX_RFC-RETURN_TEXT
.


DATA(ld_i_session_id) = 'Check type of data required'.

DATA(ld_i_main_index_id) = 'Check type of data required'.

DATA(ld_i_xml) = 'Check type of data required'.

DATA(ld_i_result) = 'Check type of data required'.
.

CALL FUNCTION 'TREX_DBS_PE_OPEN_SESSION'
  EXPORTING
    i_session_id =               ld_i_session_id
    i_main_index_id =            ld_i_main_index_id
    i_xml =                      ld_i_xml
    i_result =                   ld_i_result
  IMPORTING
    e_return_code =              ld_e_return_code
    e_return_text =              ld_e_return_text
  EXCEPTIONS
    MAIN_INDEX_DOES_NOT_EXIST =    1
    SESSION_ALREADY_LOCKED =     2
    SESSION_ALREADY_EXISTS =     3
    .  "  TREX_DBS_PE_OPEN_SESSION

IF SY-SUBRC EQ 0.
  "All OK
ELSEIF SY-SUBRC EQ 1. "Exception
  "Add code for exception here
ELSEIF SY-SUBRC EQ 2. "Exception
  "Add code for exception here
ELSEIF SY-SUBRC EQ 3. "Exception
  "Add code for exception here
ENDIF.

ABAP code to compare 7.40 inline data declaration with original syntax

The below ABAP code uses the older none in-line data declarations. This allows you to see the coding differences/benefits of the later inline syntax. It may also be useful if you are using an older version of SAP as some of the newer syntax above, such as the @DATA is not available until 4.70 EHP 8.

DATA:

ld_e_return_code
 
 TYPE TREX_RFC-RETURN_CODE ,
ld_i_session_id
 
 TYPE TREXD_PE_SESSION_ID ,
ld_e_return_text
 
 TYPE TREX_RFC-RETURN_TEXT ,
ld_i_main_index_id
 
 TYPE TREXD_INDEX_ID ,
ld_i_xml
 
 TYPE XSTRING ,
ld_i_result
 
 TYPE STRING .


ld_i_session_id = 'Check type of data required'.
ld_i_main_index_id = 'Check type of data required'.
ld_i_xml = 'Check type of data required'.
ld_i_result = 'Check type of data required'.