SAP Function Modules

comments icon Comments

TREX_EXT_UPDATE_CRAWL SAP Function module - update a TREX crawl (cruise)







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

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


Pattern for FM TREX_EXT_UPDATE_CRAWL - TREX EXT UPDATE CRAWL 





CALL FUNCTION 'TREX_EXT_UPDATE_CRAWL' "update a TREX crawl (cruise)
  EXPORTING
    i_rfc_destination =         " trex_rfc-rfc_destination  RFC destination to TREX
    i_cruise_name =             " trexs_cruiser-cruise_name  name of the crawl / cruise
    i_run_mode =                " trexs_cruiser-run_mode  1=update,2=continus,3=default,4=recrwal,5=repair, 6=full,7
*   i_max_depth = 1             " trexs_cruiser-counter  maximal depth which will be crawled
*   i_max_docsize = 20000000    " trexs_cruiser-counter  maximal size in bytes which will be crawled
*   i_min_docsize = 1           " trexs_cruiser-counter  minimal size in bytes which will be crawled
*   i_preprocessor_pool_size = 0  " trexs_cruiser-pool_size  number of parallel requests to the PreProcessor processes
*   i_access_delay = 0          " trexs_cruiser-counter  time between 2 HTTP gets in ms
*   i_max_retry_count = 3       " trexs_cruiser-counter  max retry of HTTP gets
*   i_user_agent = 'TREX'       " trexs_cruiser-string_field  user agent for HTTP get
*   i_schedule_time =           " trexs_cruiser-string_field  if not empty, scheduler will be used
*   i_reset_parameters = 0      " int4          1=Regexp;2=Excldirs;3=PosFileExts;8=NegFileExts
*   i_host_information =        " trext_cruise_host_information  TREX cruiser host information
*   i_regular_expression =      " trext_cruiser_reg_expression  regular expressions for the TREX cruiser/crawler
*   i_positive_file_extensions =   " trext_positive_file_extensions  list of positive files extensions which will be crawled
*   i_negative_file_extension =   " trext_negative_file_extensions  list of negative files extensions which will NOT be crawled
*   i_exclude_directories =     " trext_exclude_directories  directories which must not be craweld
  IMPORTING
    e_return_code =             " trex_rfc-return_code  Return Code
    e_return_text =             " trex_rfc-return_text  Return Text
  EXCEPTIONS
    CONVERSION_ERROR = 1        "               Error during conversion to UTF-8
    ERROR = 2                   "               Error, see error message
    .  "  TREX_EXT_UPDATE_CRAWL

ABAP code example for Function Module TREX_EXT_UPDATE_CRAWL





The ABAP code below is a full code listing to execute function module TREX_EXT_UPDATE_CRAWL 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_rfc_destination) = some text here


DATA(ld_i_cruise_name) = some text here


DATA(ld_i_run_mode) = Check type of data required


DATA(ld_i_max_depth) = Check type of data required


DATA(ld_i_max_docsize) = Check type of data required


DATA(ld_i_min_docsize) = Check type of data required


DATA(ld_i_preprocessor_pool_size) = Check type of data required


DATA(ld_i_access_delay) = Check type of data required


DATA(ld_i_max_retry_count) = Check type of data required


DATA(ld_i_user_agent) = Check type of data required


DATA(ld_i_schedule_time) = Check type of data required

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

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

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

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

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

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

CALL FUNCTION 'TREX_EXT_UPDATE_CRAWL'
  EXPORTING
    i_rfc_destination =          ld_i_rfc_destination
    i_cruise_name =              ld_i_cruise_name
    i_run_mode =                 ld_i_run_mode
*   i_max_depth =                ld_i_max_depth
*   i_max_docsize =              ld_i_max_docsize
*   i_min_docsize =              ld_i_min_docsize
*   i_preprocessor_pool_size =    ld_i_preprocessor_pool_size
*   i_access_delay =             ld_i_access_delay
*   i_max_retry_count =          ld_i_max_retry_count
*   i_user_agent =               ld_i_user_agent
*   i_schedule_time =            ld_i_schedule_time
*   i_reset_parameters =         ld_i_reset_parameters
*   i_host_information =         ld_i_host_information
*   i_regular_expression =       ld_i_regular_expression
*   i_positive_file_extensions =    ld_i_positive_file_extensions
*   i_negative_file_extension =    ld_i_negative_file_extension
*   i_exclude_directories =      ld_i_exclude_directories
  IMPORTING
    e_return_code =              ld_e_return_code
    e_return_text =              ld_e_return_text
  EXCEPTIONS
    CONVERSION_ERROR =           1
    ERROR =                      2
    .  "  TREX_EXT_UPDATE_CRAWL

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_cruise_name  TYPE TREXS_CRUISER-CRUISE_NAME ,
ld_i_run_mode  TYPE TREXS_CRUISER-RUN_MODE ,
ld_i_max_depth  TYPE TREXS_CRUISER-COUNTER ,
ld_i_max_docsize  TYPE TREXS_CRUISER-COUNTER ,
ld_i_min_docsize  TYPE TREXS_CRUISER-COUNTER ,
ld_i_preprocessor_pool_size  TYPE TREXS_CRUISER-POOL_SIZE ,
ld_i_access_delay  TYPE TREXS_CRUISER-COUNTER ,
ld_i_max_retry_count  TYPE TREXS_CRUISER-COUNTER ,
ld_i_user_agent  TYPE TREXS_CRUISER-STRING_FIELD ,
ld_i_schedule_time  TYPE TREXS_CRUISER-STRING_FIELD ,
ld_i_reset_parameters  TYPE INT4 ,
ld_i_host_information  TYPE TREXT_CRUISE_HOST_INFORMATION ,
ld_i_regular_expression  TYPE TREXT_CRUISER_REG_EXPRESSION ,
ld_i_positive_file_extensions  TYPE TREXT_POSITIVE_FILE_EXTENSIONS ,
ld_i_negative_file_extension  TYPE TREXT_NEGATIVE_FILE_EXTENSIONS ,
ld_i_exclude_directories  TYPE TREXT_EXCLUDE_DIRECTORIES .





ld_i_rfc_destination = some text here

ld_i_cruise_name = some text here

ld_i_run_mode = Check type of data required

ld_i_max_depth = Check type of data required

ld_i_max_docsize = Check type of data required

ld_i_min_docsize = Check type of data required

ld_i_preprocessor_pool_size = Check type of data required

ld_i_access_delay = Check type of data required

ld_i_max_retry_count = Check type of data required

ld_i_user_agent = Check type of data required

ld_i_schedule_time = Check type of data required
ld_i_reset_parameters = 'Check type of data required'.
ld_i_host_information = 'Check type of data required'.
ld_i_regular_expression = 'Check type of data required'.
ld_i_positive_file_extensions = 'Check type of data required'.
ld_i_negative_file_extension = 'Check type of data required'.
ld_i_exclude_directories = '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_UPDATE_CRAWL or its description.


   
 

TREX_EXT_UPDATE_CRAWL - update a TREX crawl (cruise)
TREX_EXT_UNSET_DBSL - Deactivate DBSL communication method.
TREX_EXT_UNLOAD_INDEX - Unload data of a BI cube from TREX
TREX_EXT_TEMP_INDEX_EXISTS - Check if an index exists
TREX_EXT_SUSPEND_TENANT - Suspend/Resume Tenant
TREX_EXT_SUSPEND_QUEUES - Suspend Queues