SAP Function Modules
TREX_EXT_SHOW_INDEX SAP Function module - show index
TREX_EXT_SHOW_INDEX 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_SHOW_INDEX into the relevant SAP transaction such as SE37 or SE80.
Associated Function Group:
TREX_EXT_ADMINISTRATION
Released Date:
Not Released
Processing type: Normal fucntion module
Pattern for FM TREX_EXT_SHOW_INDEX - TREX EXT SHOW INDEX
CALL FUNCTION 'TREX_EXT_SHOW_INDEX' "show index
EXPORTING
i_index_id = " trex_rfc-index_id Index Id
i_rfc_destination = " trex_rfc-rfc_destination Logical Destination (Specified in Function Call)
* i_calculation_view = " string Calculation view
* i_schema_name = '' " csequence HANA only: schema name
IMPORTING
e_return_code = " trex_rfc-return_code Return Code
e_return_text = " trex_rfc-return_text Return Text
e_languages = " trex_rfc-return_text Languages (separated by comma)
e_description = " trex_rfc-description Description
e_indexserver_location = " trex_rfc-location IndexServer Location
e_use_queueserver = " trex_rfc-flag
e_queueserver_location = " trex_rfc-location QueueServer Location
e_creation = " trex_rfc-location Creation date
e_modification = " trex_rfc-location Modification date
e_is_public = " trex_rfc-flag
e_textmining_relevant = " trex_rfc-flag
e_token_separators = " trex_rfc-separator
e_number_separators = " trex_rfc-separator
e_memory_index = " trexd_memory_only X: Memory Index
e_keep_content = " trex_rfc-flag
e_precalculate_features = " trex_rfc-flag
e_is_searchable = " trex_rfc-flag
e_auto_create_languages = " trex_rfc-flag
e_size_for_delta_index = " trex_rfc-numc
e_multilang_docs = " trex_rfc-flag
e_duplicate_detection = " trex_rfc-flag
e_is_writable = " trex_rfc-flag
e_doc_counter = " trex_rfc-numc Obsolete, do not use
e_attribute_definitions = " trext_attr_def Attribute definitions
e_attribute_definitions2 = " hdbt_attr_def HANA only: Attribute Definition
e_index_state = " trex_rfc-flag Index state in TREX
e_index_type = " trex_rfc-flag Obsolete: Index Type
e_logical_index_type = " trex_rfc-flag Obsolete: Logical Index Type
e_ext_index_type = " trexd_index_type Index Type (see Domain Values)
e_disk_free_space = " int4 Disk Free Space [MB]
e_physical_indexes = " trext_indexes Splitted Index: index is splitted in parts
e_language_indexes = " trext_indexes Language Index: idx is splitted in languages
e_taxonomies = " trext_taxonomy_info Taxonomies
e_extensions = " trext_extensions Extensions
e_language_index_info = " trext_language_index_info info about physical index (for earch language of this index)
e_delta_index_info = " trext_delta_index_info Information about a delta index in TREX
e_delta1_index_info = " trext_new_delta_index_info Information about a delta index in TREX
e_delta2_index_info = " trext_new_delta_index_info Information about a delta2 index in TREX
e_key_attributes = " trext_attributes Key attributes
e_join_indexes = " trext_join_index Join indexes
e_static_join_conditions = " trext_static_join_condition static join condition
e_view_attributes = " trext_view_attributes View attributes
e_view_attribute_groups = " trext_view_attribute_groups View Attribute Groups
e_semantic_relations = " trext_semantic_relations Semantic relations
e_business_object_views = " trext_bo_views Business object views
e_join_paths = " trext_join_paths Join paths
e_key_figures = " trext_key_figure Key figures
e_key_figures_2 = " trext_key_figure_2 Key figures (extended)
e_default_view = " trexs_view_attribute-view_name Name of the default view
e_constraints = " trext_constraints Constraints
e_constraints_long = " trext_constraints_l Constraints (no length limitation)
e_preload_attributes = " trext_attributes Preload Attributes
e_preload_languages = " trext_languages Preload Languages (ISO 639)
e_fast_preprocessing = " trex_rfc-flag
e_freestyle_search_attributes = " trext_attributes FreeStyle Attributes
e_all_attrs_freestyle = " trex_rfc-boolean 1: all Attrs are FreeStyle relevant
e_no_physical_indexes = " trex_rfc-numc number of physical indexes to be created
e_docs_change_language = " trex_rfc-boolean
e_insert_only = " trex_rfc-flag
e_use_temporary_delta_indexes = " trex_rfc-boolean
e_fast_update_with_temp_delta = " trex_rfc-boolean
e_analyzer_type = " trex_rfc-analyzer_type
e_partition_attributes = " trext_attributes
e_partition_specification = " string
e_set_transactional = " trex_rfc-boolean
e_hierarchy_metadata = " trexs_hierarchy_metadata Hierarchy metadata
e_range_attributes = " trext_range_attributes Range attributes
e_table_group = " hdbs_table_group HANA: table group
EXCEPTIONS
CONVERSION_ERROR = 1 " Error during conversion to UTF-8
ERROR = 2 " Error, see error message
. " TREX_EXT_SHOW_INDEX
ABAP code example for Function Module TREX_EXT_SHOW_INDEX
The ABAP code below is a full code listing to execute function module TREX_EXT_SHOW_INDEX 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).
| ld_e_return_code | TYPE TREX_RFC-RETURN_CODE , |
| ld_e_return_text | TYPE TREX_RFC-RETURN_TEXT , |
| ld_e_languages | TYPE TREX_RFC-RETURN_TEXT , |
| ld_e_description | TYPE TREX_RFC-DESCRIPTION , |
| ld_e_indexserver_location | TYPE TREX_RFC-LOCATION , |
| ld_e_use_queueserver | TYPE TREX_RFC-FLAG , |
| ld_e_queueserver_location | TYPE TREX_RFC-LOCATION , |
| ld_e_creation | TYPE TREX_RFC-LOCATION , |
| ld_e_modification | TYPE TREX_RFC-LOCATION , |
| ld_e_is_public | TYPE TREX_RFC-FLAG , |
| ld_e_textmining_relevant | TYPE TREX_RFC-FLAG , |
| ld_e_token_separators | TYPE TREX_RFC-SEPARATOR , |
| ld_e_number_separators | TYPE TREX_RFC-SEPARATOR , |
| ld_e_memory_index | TYPE TREXD_MEMORY_ONLY , |
| ld_e_keep_content | TYPE TREX_RFC-FLAG , |
| ld_e_precalculate_features | TYPE TREX_RFC-FLAG , |
| ld_e_is_searchable | TYPE TREX_RFC-FLAG , |
| ld_e_auto_create_languages | TYPE TREX_RFC-FLAG , |
| ld_e_size_for_delta_index | TYPE TREX_RFC-NUMC , |
| ld_e_multilang_docs | TYPE TREX_RFC-FLAG , |
| ld_e_duplicate_detection | TYPE TREX_RFC-FLAG , |
| ld_e_is_writable | TYPE TREX_RFC-FLAG , |
| ld_e_doc_counter | TYPE TREX_RFC-NUMC , |
| ld_e_attribute_definitions | TYPE TREXT_ATTR_DEF , |
| ld_e_attribute_definitions2 | TYPE HDBT_ATTR_DEF , |
| ld_e_index_state | TYPE TREX_RFC-FLAG , |
| ld_e_index_type | TYPE TREX_RFC-FLAG , |
| ld_e_logical_index_type | TYPE TREX_RFC-FLAG , |
| ld_e_ext_index_type | TYPE TREXD_INDEX_TYPE , |
| ld_e_disk_free_space | TYPE INT4 , |
| ld_e_physical_indexes | TYPE TREXT_INDEXES , |
| ld_e_language_indexes | TYPE TREXT_INDEXES , |
| ld_e_taxonomies | TYPE TREXT_TAXONOMY_INFO , |
| ld_e_extensions | TYPE TREXT_EXTENSIONS , |
| ld_e_language_index_info | TYPE TREXT_LANGUAGE_INDEX_INFO , |
| ld_e_delta_index_info | TYPE TREXT_DELTA_INDEX_INFO , |
| ld_e_delta1_index_info | TYPE TREXT_NEW_DELTA_INDEX_INFO , |
| ld_e_delta2_index_info | TYPE TREXT_NEW_DELTA_INDEX_INFO , |
| ld_e_key_attributes | TYPE TREXT_ATTRIBUTES , |
| ld_e_join_indexes | TYPE TREXT_JOIN_INDEX , |
| ld_e_static_join_conditions | TYPE TREXT_STATIC_JOIN_CONDITION , |
| ld_e_view_attributes | TYPE TREXT_VIEW_ATTRIBUTES , |
| ld_e_view_attribute_groups | TYPE TREXT_VIEW_ATTRIBUTE_GROUPS , |
| ld_e_semantic_relations | TYPE TREXT_SEMANTIC_RELATIONS , |
| ld_e_business_object_views | TYPE TREXT_BO_VIEWS , |
| ld_e_join_paths | TYPE TREXT_JOIN_PATHS , |
| ld_e_key_figures | TYPE TREXT_KEY_FIGURE , |
| ld_e_key_figures_2 | TYPE TREXT_KEY_FIGURE_2 , |
| ld_e_default_view | TYPE TREXS_VIEW_ATTRIBUTE-VIEW_NAME , |
| ld_e_constraints | TYPE TREXT_CONSTRAINTS , |
| ld_e_constraints_long | TYPE TREXT_CONSTRAINTS_L , |
| ld_e_preload_attributes | TYPE TREXT_ATTRIBUTES , |
| ld_e_preload_languages | TYPE TREXT_LANGUAGES , |
| ld_e_fast_preprocessing | TYPE TREX_RFC-FLAG , |
| ld_e_freestyle_search_attributes | TYPE TREXT_ATTRIBUTES , |
| ld_e_all_attrs_freestyle | TYPE TREX_RFC-BOOLEAN , |
| ld_e_no_physical_indexes | TYPE TREX_RFC-NUMC , |
| ld_e_docs_change_language | TYPE TREX_RFC-BOOLEAN , |
| ld_e_insert_only | TYPE TREX_RFC-FLAG , |
| ld_e_use_temporary_delta_indexes | TYPE TREX_RFC-BOOLEAN , |
| ld_e_fast_update_with_temp_delta | TYPE TREX_RFC-BOOLEAN , |
| ld_e_analyzer_type | TYPE TREX_RFC-ANALYZER_TYPE , |
| ld_e_partition_attributes | TYPE TREXT_ATTRIBUTES , |
| ld_e_partition_specification | TYPE STRING , |
| ld_e_set_transactional | TYPE TREX_RFC-BOOLEAN , |
| ld_e_hierarchy_metadata | TYPE TREXS_HIERARCHY_METADATA , |
| ld_e_range_attributes | TYPE TREXT_RANGE_ATTRIBUTES , |
| ld_e_table_group | TYPE HDBS_TABLE_GROUP . |
DATA(ld_i_index_id) = some text here
DATA(ld_i_rfc_destination) = some text here
DATA(ld_i_calculation_view) = 'Check type of data required'.
DATA(ld_i_schema_name) = 'Check type of data required'. . CALL FUNCTION 'TREX_EXT_SHOW_INDEX' EXPORTING i_index_id = ld_i_index_id i_rfc_destination = ld_i_rfc_destination * i_calculation_view = ld_i_calculation_view * i_schema_name = ld_i_schema_name IMPORTING e_return_code = ld_e_return_code e_return_text = ld_e_return_text e_languages = ld_e_languages e_description = ld_e_description e_indexserver_location = ld_e_indexserver_location e_use_queueserver = ld_e_use_queueserver e_queueserver_location = ld_e_queueserver_location e_creation = ld_e_creation e_modification = ld_e_modification e_is_public = ld_e_is_public e_textmining_relevant = ld_e_textmining_relevant e_token_separators = ld_e_token_separators e_number_separators = ld_e_number_separators e_memory_index = ld_e_memory_index e_keep_content = ld_e_keep_content e_precalculate_features = ld_e_precalculate_features e_is_searchable = ld_e_is_searchable e_auto_create_languages = ld_e_auto_create_languages e_size_for_delta_index = ld_e_size_for_delta_index e_multilang_docs = ld_e_multilang_docs e_duplicate_detection = ld_e_duplicate_detection e_is_writable = ld_e_is_writable e_doc_counter = ld_e_doc_counter e_attribute_definitions = ld_e_attribute_definitions e_attribute_definitions2 = ld_e_attribute_definitions2 e_index_state = ld_e_index_state e_index_type = ld_e_index_type e_logical_index_type = ld_e_logical_index_type e_ext_index_type = ld_e_ext_index_type e_disk_free_space = ld_e_disk_free_space e_physical_indexes = ld_e_physical_indexes e_language_indexes = ld_e_language_indexes e_taxonomies = ld_e_taxonomies e_extensions = ld_e_extensions e_language_index_info = ld_e_language_index_info e_delta_index_info = ld_e_delta_index_info e_delta1_index_info = ld_e_delta1_index_info e_delta2_index_info = ld_e_delta2_index_info e_key_attributes = ld_e_key_attributes e_join_indexes = ld_e_join_indexes e_static_join_conditions = ld_e_static_join_conditions e_view_attributes = ld_e_view_attributes e_view_attribute_groups = ld_e_view_attribute_groups e_semantic_relations = ld_e_semantic_relations e_business_object_views = ld_e_business_object_views e_join_paths = ld_e_join_paths e_key_figures = ld_e_key_figures e_key_figures_2 = ld_e_key_figures_2 e_default_view = ld_e_default_view e_constraints = ld_e_constraints e_constraints_long = ld_e_constraints_long e_preload_attributes = ld_e_preload_attributes e_preload_languages = ld_e_preload_languages e_fast_preprocessing = ld_e_fast_preprocessing e_freestyle_search_attributes = ld_e_freestyle_search_attributes e_all_attrs_freestyle = ld_e_all_attrs_freestyle e_no_physical_indexes = ld_e_no_physical_indexes e_docs_change_language = ld_e_docs_change_language e_insert_only = ld_e_insert_only e_use_temporary_delta_indexes = ld_e_use_temporary_delta_indexes e_fast_update_with_temp_delta = ld_e_fast_update_with_temp_delta e_analyzer_type = ld_e_analyzer_type e_partition_attributes = ld_e_partition_attributes e_partition_specification = ld_e_partition_specification e_set_transactional = ld_e_set_transactional e_hierarchy_metadata = ld_e_hierarchy_metadata e_range_attributes = ld_e_range_attributes e_table_group = ld_e_table_group EXCEPTIONS CONVERSION_ERROR = 1 ERROR = 2 . " TREX_EXT_SHOW_INDEX
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_index_id | TYPE TREX_RFC-INDEX_ID , |
| ld_e_return_text | TYPE TREX_RFC-RETURN_TEXT , |
| ld_i_rfc_destination | TYPE TREX_RFC-RFC_DESTINATION , |
| ld_e_languages | TYPE TREX_RFC-RETURN_TEXT , |
| ld_i_calculation_view | TYPE STRING , |
| ld_e_description | TYPE TREX_RFC-DESCRIPTION , |
| ld_i_schema_name | TYPE CSEQUENCE , |
| ld_e_indexserver_location | TYPE TREX_RFC-LOCATION , |
| ld_e_use_queueserver | TYPE TREX_RFC-FLAG , |
| ld_e_queueserver_location | TYPE TREX_RFC-LOCATION , |
| ld_e_creation | TYPE TREX_RFC-LOCATION , |
| ld_e_modification | TYPE TREX_RFC-LOCATION , |
| ld_e_is_public | TYPE TREX_RFC-FLAG , |
| ld_e_textmining_relevant | TYPE TREX_RFC-FLAG , |
| ld_e_token_separators | TYPE TREX_RFC-SEPARATOR , |
| ld_e_number_separators | TYPE TREX_RFC-SEPARATOR , |
| ld_e_memory_index | TYPE TREXD_MEMORY_ONLY , |
| ld_e_keep_content | TYPE TREX_RFC-FLAG , |
| ld_e_precalculate_features | TYPE TREX_RFC-FLAG , |
| ld_e_is_searchable | TYPE TREX_RFC-FLAG , |
| ld_e_auto_create_languages | TYPE TREX_RFC-FLAG , |
| ld_e_size_for_delta_index | TYPE TREX_RFC-NUMC , |
| ld_e_multilang_docs | TYPE TREX_RFC-FLAG , |
| ld_e_duplicate_detection | TYPE TREX_RFC-FLAG , |
| ld_e_is_writable | TYPE TREX_RFC-FLAG , |
| ld_e_doc_counter | TYPE TREX_RFC-NUMC , |
| ld_e_attribute_definitions | TYPE TREXT_ATTR_DEF , |
| ld_e_attribute_definitions2 | TYPE HDBT_ATTR_DEF , |
| ld_e_index_state | TYPE TREX_RFC-FLAG , |
| ld_e_index_type | TYPE TREX_RFC-FLAG , |
| ld_e_logical_index_type | TYPE TREX_RFC-FLAG , |
| ld_e_ext_index_type | TYPE TREXD_INDEX_TYPE , |
| ld_e_disk_free_space | TYPE INT4 , |
| ld_e_physical_indexes | TYPE TREXT_INDEXES , |
| ld_e_language_indexes | TYPE TREXT_INDEXES , |
| ld_e_taxonomies | TYPE TREXT_TAXONOMY_INFO , |
| ld_e_extensions | TYPE TREXT_EXTENSIONS , |
| ld_e_language_index_info | TYPE TREXT_LANGUAGE_INDEX_INFO , |
| ld_e_delta_index_info | TYPE TREXT_DELTA_INDEX_INFO , |
| ld_e_delta1_index_info | TYPE TREXT_NEW_DELTA_INDEX_INFO , |
| ld_e_delta2_index_info | TYPE TREXT_NEW_DELTA_INDEX_INFO , |
| ld_e_key_attributes | TYPE TREXT_ATTRIBUTES , |
| ld_e_join_indexes | TYPE TREXT_JOIN_INDEX , |
| ld_e_static_join_conditions | TYPE TREXT_STATIC_JOIN_CONDITION , |
| ld_e_view_attributes | TYPE TREXT_VIEW_ATTRIBUTES , |
| ld_e_view_attribute_groups | TYPE TREXT_VIEW_ATTRIBUTE_GROUPS , |
| ld_e_semantic_relations | TYPE TREXT_SEMANTIC_RELATIONS , |
| ld_e_business_object_views | TYPE TREXT_BO_VIEWS , |
| ld_e_join_paths | TYPE TREXT_JOIN_PATHS , |
| ld_e_key_figures | TYPE TREXT_KEY_FIGURE , |
| ld_e_key_figures_2 | TYPE TREXT_KEY_FIGURE_2 , |
| ld_e_default_view | TYPE TREXS_VIEW_ATTRIBUTE-VIEW_NAME , |
| ld_e_constraints | TYPE TREXT_CONSTRAINTS , |
| ld_e_constraints_long | TYPE TREXT_CONSTRAINTS_L , |
| ld_e_preload_attributes | TYPE TREXT_ATTRIBUTES , |
| ld_e_preload_languages | TYPE TREXT_LANGUAGES , |
| ld_e_fast_preprocessing | TYPE TREX_RFC-FLAG , |
| ld_e_freestyle_search_attributes | TYPE TREXT_ATTRIBUTES , |
| ld_e_all_attrs_freestyle | TYPE TREX_RFC-BOOLEAN , |
| ld_e_no_physical_indexes | TYPE TREX_RFC-NUMC , |
| ld_e_docs_change_language | TYPE TREX_RFC-BOOLEAN , |
| ld_e_insert_only | TYPE TREX_RFC-FLAG , |
| ld_e_use_temporary_delta_indexes | TYPE TREX_RFC-BOOLEAN , |
| ld_e_fast_update_with_temp_delta | TYPE TREX_RFC-BOOLEAN , |
| ld_e_analyzer_type | TYPE TREX_RFC-ANALYZER_TYPE , |
| ld_e_partition_attributes | TYPE TREXT_ATTRIBUTES , |
| ld_e_partition_specification | TYPE STRING , |
| ld_e_set_transactional | TYPE TREX_RFC-BOOLEAN , |
| ld_e_hierarchy_metadata | TYPE TREXS_HIERARCHY_METADATA , |
| ld_e_range_attributes | TYPE TREXT_RANGE_ATTRIBUTES , |
| ld_e_table_group | TYPE HDBS_TABLE_GROUP . |
ld_i_index_id = some text here
ld_i_rfc_destination = some text here
ld_i_calculation_view = 'Check type of data required'.
ld_i_schema_name = 'Check type of data required'.
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_SHOW_INDEX or its description.