SAP Function Modules

comments icon Comments

TREX_EXT_GET_ATTR_VALUE_COUNTS SAP Function module - Get statistics and values for a TREX attribute







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

Associated Function Group: TREX_EXT_AE
Released Date: Not Released
Processing type: Normal fucntion module
Normal function module settings


Pattern for FM TREX_EXT_GET_ATTR_VALUE_COUNTS - TREX EXT GET ATTR VALUE COUNTS 





CALL FUNCTION 'TREX_EXT_GET_ATTR_VALUE_COUNTS' "Get statistics and values for a TREX attribute
  EXPORTING
    i_rfc_destination =         " trex_rfc-rfc_destination  RFC destination to TREX engine
    i_index_id =                " trex_rfc-index_id  Index Id
    i_language =                " trex_rfc-language  Language
    i_attr_name =               " trex_rfc-attribute  Attribute name
    i_max_results = 10000       " trex_rfc-numc  maximum number of tuples for calculation
    i_get_statistics = 0        " trex_rfc-boolean  1: statistics are calculated
    i_number_of_pairs = 0       " trex_rfc-numc  maximum number of pairs be returned
  IMPORTING
    e_return_code =             " trex_rfc-return_code  Return code
    e_return_text =             " trex_rfc-return_text  Return text
    e_statistics =              " trexs_attr_statistics  Statistics
    e_number_of_pairs =         " trex_rfc-numc  Number of actually returned value pairs
    e_pairs =                   " trext_attr_value_counts  Pairs (values and their occurence)
  EXCEPTIONS
    CONVERSION_ERROR = 1        "               Error during conversion to or from UTF-8
    ERROR = 2                   "               Error, see error message
    .  "  TREX_EXT_GET_ATTR_VALUE_COUNTS

ABAP code example for Function Module TREX_EXT_GET_ATTR_VALUE_COUNTS





The ABAP code below is a full code listing to execute function module TREX_EXT_GET_ATTR_VALUE_COUNTS 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
,
ld_e_statistics    TYPE TREXS_ATTR_STATISTICS
,
ld_e_number_of_pairs    TYPE TREX_RFC-NUMC
,
ld_e_pairs    TYPE TREXT_ATTR_VALUE_COUNTS
.





DATA(ld_i_rfc_destination) = some text here


DATA(ld_i_index_id) = some text here


DATA(ld_i_language) = some text here


DATA(ld_i_attr_name) = some text here


DATA(ld_i_max_results) = 123 


DATA(ld_i_get_statistics) = Check type of data required


DATA(ld_i_number_of_pairs) = 123 
.

CALL FUNCTION 'TREX_EXT_GET_ATTR_VALUE_COUNTS'
  EXPORTING
    i_rfc_destination =          ld_i_rfc_destination
    i_index_id =                 ld_i_index_id
    i_language =                 ld_i_language
    i_attr_name =                ld_i_attr_name
    i_max_results =              ld_i_max_results
    i_get_statistics =           ld_i_get_statistics
    i_number_of_pairs =          ld_i_number_of_pairs
  IMPORTING
    e_return_code =              ld_e_return_code
    e_return_text =              ld_e_return_text
    e_statistics =               ld_e_statistics
    e_number_of_pairs =          ld_e_number_of_pairs
    e_pairs =                    ld_e_pairs
  EXCEPTIONS
    CONVERSION_ERROR =           1
    ERROR =                      2
    .  "  TREX_EXT_GET_ATTR_VALUE_COUNTS

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
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_rfc_destination  TYPE TREX_RFC-RFC_DESTINATION ,
ld_e_return_text  TYPE TREX_RFC-RETURN_TEXT ,
ld_i_index_id  TYPE TREX_RFC-INDEX_ID ,
ld_e_statistics  TYPE TREXS_ATTR_STATISTICS ,
ld_i_language  TYPE TREX_RFC-LANGUAGE ,
ld_e_number_of_pairs  TYPE TREX_RFC-NUMC ,
ld_i_attr_name  TYPE TREX_RFC-ATTRIBUTE ,
ld_e_pairs  TYPE TREXT_ATTR_VALUE_COUNTS ,
ld_i_max_results  TYPE TREX_RFC-NUMC ,
ld_i_get_statistics  TYPE TREX_RFC-BOOLEAN ,
ld_i_number_of_pairs  TYPE TREX_RFC-NUMC .





ld_i_rfc_destination = some text here

ld_i_index_id = some text here

ld_i_language = some text here

ld_i_attr_name = some text here

ld_i_max_results = 123 

ld_i_get_statistics = Check type of data required

ld_i_number_of_pairs = 123

Contribute (Add Comments)

Please help keep this info upto date and use the comments section below to add useful hints, tips and information specific to this SAP function. This will then be available for you and other users to easily find by simply searching on the object name TREX_EXT_GET_ATTR_VALUE_COUNTS or its description.


   
 

TREX_EXT_GET_ATTR_VALUE_COUNTS - Get statistics and values for a TREX attribute
TREX_EXT_GET_ATTR_STATISTICS - Obsolete: use trex_ext_get_attr_value_counts instead
TREX_EXT_GET_ALERT_STATUS - Get the Alert Monitor Check Results
TREX_EXT_FULLTEXT_INDEX_EXISTS - HANA only: check if fulltext index exists
TREX_EXT_FLUSH_QUEUES - Flush Queues
TREX_EXT_EXPORT_TENANT - Export Tenant