TREX_EXT_SERIALIZE_INDEX_CALL SAP Function module - Return a serialized string of indexCellTable call.

TREX_EXT_SERIALIZE_INDEX_CALL 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_EXT_SERIALIZE_INDEX_CALL into the relevant SAP transaction such as SE37 or SE80.

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

Pattern for FM TREX_EXT_SERIALIZE_INDEX_CALL - TREX EXT SERIALIZE INDEX CALL

CALL FUNCTION 'TREX_EXT_SERIALIZE_INDEX_CALL' "Return a serialized string of indexCellTable call.
  EXPORTING
    i_index_id =                " trex_rfc-index_id  Index Id
*   i_index_table =             " standard table  Table for indexing
*   i_comp_descr =              " trext_comp_descr  Description of the components
*   i_language = 'EN'           " trex_rfc-language  Language
*   i_deindex = ' '             " trex_rfc-flag  Deindex the recods in I_INDEX_TABLE
*   i_doc_action = ' '          " trexd_index_action  Document action for indexing.
*   i_transaction_id =          " trexd_transaction_id  obsolete
*   i_auto_optimize = 0         " trex_rfc-boolean  1: Optimization is done after indexing
*   i_as_plain_bxml = ABAP_TRUE  " abap_bool    'X': No length/endian info in the string. 'X' can be used only for multiIndex.
*   i_ignore_conv_error = 0     " trex_rfc-boolean  1: Ignore codepage conversion errors.
*   i_column_aggr_types =       " trext_column_aggregation  TREX column aggregation type
*   i_session_id = ''           " string
*   i_view_name = ''            " string
  IMPORTING
    e_request_string =          " xstring       Serialized string
  EXCEPTIONS
    ERROR = 1                   "               Error, see error message
    .  "  TREX_EXT_SERIALIZE_INDEX_CALL

ABAP code example for Function Module TREX_EXT_SERIALIZE_INDEX_CALL

The ABAP code below is a full code listing to execute function module TREX_EXT_SERIALIZE_INDEX_CALL 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_request_string  
 
 TYPE XSTRING
.



DATA(ld_i_index_id) = some text here

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

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


DATA(ld_i_language) = some text here


DATA(ld_i_deindex) = some text here

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

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


DATA(ld_i_auto_optimize) = Check type of data required

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


DATA(ld_i_ignore_conv_error) = Check type of data required

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

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

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

CALL FUNCTION 'TREX_EXT_SERIALIZE_INDEX_CALL'
  EXPORTING
    i_index_id =                 ld_i_index_id
*   i_index_table =              ld_i_index_table
*   i_comp_descr =               ld_i_comp_descr
*   i_language =                 ld_i_language
*   i_deindex =                  ld_i_deindex
*   i_doc_action =               ld_i_doc_action
*   i_transaction_id =           ld_i_transaction_id
*   i_auto_optimize =            ld_i_auto_optimize
*   i_as_plain_bxml =            ld_i_as_plain_bxml
*   i_ignore_conv_error =        ld_i_ignore_conv_error
*   i_column_aggr_types =        ld_i_column_aggr_types
*   i_session_id =               ld_i_session_id
*   i_view_name =                ld_i_view_name
  IMPORTING
    e_request_string =           ld_e_request_string
  EXCEPTIONS
    ERROR =                      1
    .  "  TREX_EXT_SERIALIZE_INDEX_CALL

IF SY-SUBRC EQ 0.
  "All OK
ELSEIF SY-SUBRC EQ 1. "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_request_string
 
 TYPE XSTRING ,
ld_i_index_id
 
 TYPE TREX_RFC-INDEX_ID ,
ld_i_index_table
 
 TYPE STANDARD TABLE ,
ld_i_comp_descr
 
 TYPE TREXT_COMP_DESCR ,
ld_i_language
 
 TYPE TREX_RFC-LANGUAGE ,
ld_i_deindex
 
 TYPE TREX_RFC-FLAG ,
ld_i_doc_action
 
 TYPE TREXD_INDEX_ACTION ,
ld_i_transaction_id
 
 TYPE TREXD_TRANSACTION_ID ,
ld_i_auto_optimize
 
 TYPE TREX_RFC-BOOLEAN ,
ld_i_as_plain_bxml
 
 TYPE ABAP_BOOL ,
ld_i_ignore_conv_error
 
 TYPE TREX_RFC-BOOLEAN ,
ld_i_column_aggr_types
 
 TYPE TREXT_COLUMN_AGGREGATION ,
ld_i_session_id
 
 TYPE STRING ,
ld_i_view_name
 
 TYPE STRING .



ld_i_index_id = some text here
ld_i_index_table = 'Check type of data required'.
ld_i_comp_descr = 'Check type of data required'.

ld_i_language = some text here

ld_i_deindex = some text here
ld_i_doc_action = 'Check type of data required'.
ld_i_transaction_id = 'Check type of data required'.

ld_i_auto_optimize = Check type of data required
ld_i_as_plain_bxml = 'Check type of data required'.

ld_i_ignore_conv_error = Check type of data required
ld_i_column_aggr_types = 'Check type of data required'.
ld_i_session_id = 'Check type of data required'.
ld_i_view_name = 'Check type of data required'.