SAP ABAP Function Module TREX_EXT_CREATE_CRAWL (creates a TREX crawl (cruise) object)
Hierarchy
☛
SAP_BASIS (Software Component) SAP Basis Component
⤷
BC-TRX-API (Application Component) TREX ABAP + JAVA API
⤷
STREX (Package) TREX ABAP client
SAP_BASIS (Software Component) SAP Basis Component⤷
BC-TRX-API (Application Component) TREX ABAP + JAVA API⤷
STREX (Package) TREX ABAP client
Basic Data
| Function Module | TREX_EXT_CREATE_CRAWL | creates a TREX crawl (cruise) object |
| Function Group | TREX_EXT_CRAWLER | External: TREX crawler functions |
| Program Name | SAPLTREX_EXT_CRAWLER | |
| INCLUDE Name | LTREX_EXT_CRAWLERU01 |
Parameters
| Type | Parameter Name | Typing | Associated Type | Default value | Optional | Pass Value | Short text |
|---|---|---|---|---|---|---|---|
 Exporting |
E_RETURN_CODE | TYPE | TREX_RFC-RETURN_CODE | Return Code | |||
| Exporting |
E_RETURN_TEXT | TYPE | TREX_RFC-RETURN_TEXT | Return Text | |||
 Importing |
I_RFC_DESTINATION | TYPE | TREX_RFC-RFC_DESTINATION | RFC destination to TREX | |||
| Importing |
I_CRUISE_NAME | TYPE | TREXS_CRUISER-CRUISE_NAME | name of the crawl / cruise | |||
| Importing |
I_INDEX_ID | TYPE | TREX_RFC-INDEX_ID | indexid | |||
| Importing |
I_LANGUAGE | TYPE | LAISO | Language according to ISO 639 | |||
| Importing |
I_CREATE_SUSPENDED | TYPE | TREXS_CRUISER-NUMC1 | 0 | 1=cruise is suspended after creatation | ||
| Importing |
I_MAX_DEPTH | TYPE | TREXS_CRUISER-COUNTER | 0 | maximal depth which will be crawled | ||
| Importing |
I_MAX_DOCSIZE | TYPE | TREXS_CRUISER-COUNTER | 20000000 | maximal size in bytes which will be crawled | ||
| Importing |
I_MIN_DOCSIZE | TYPE | TREXS_CRUISER-COUNTER | 1 | minimal size in bytes which will be crawled | ||
| Importing |
I_CRAWLING_ALGORITHM | TYPE | TREXS_CRUISER-NUMC1 | 0 | 0=down the tree; 1= same server; 2=same domain; 3 = top level domain, 4= free | ||
| Importing |
I_PREPROCESSOR_POOL_SIZE | TYPE | TREXS_CRUISER-POOL_SIZE | 3 | number of parallel requests to the PreProcessor processes | ||
| Importing |
I_DONT_INDEX_DIRS | TYPE | TREXS_CRUISER-NUMC1 | 0 | 1=do not index directories | ||
| Importing |
I_ACCESS_DELAY | TYPE | TREXS_CRUISER-COUNTER | 0 | time between 2 HTTP gets in ms | ||
| Importing |
I_MAX_RETRY_COUNT | TYPE | TREXS_CRUISER-COUNTER | 3 | max retry of HTTP gets | ||
| Importing |
I_USE_ROBOTRULES | TYPE | TREXS_CRUISER-NUMC1 | 0 | 1 = crawler is using robot rules | ||
| Importing |
I_IS_MULTILANGUAGE_INDEX | TYPE | TREXS_CRUISER-NUMC1 | 0 | 1 = using multi language index | ||
| Importing |
I_USER_AGENT | TYPE | TREXS_CRUISER-STRING_FIELD | 'TREX' | user agent for HTTP get | ||
| Importing |
I_SCHEDULE_TIME | TYPE | TREXS_CRUISER-STRING_FIELD | if not empty, scheduler will be used | |||
| Importing |
I_PYTHON_COMMAND_ARGS | TYPE | TREXS_CRUISER-STRING_FIELD | Python command for scheduled execution | |||
| Importing |
I_RESULT_CONNECTOR_TYPE | TYPE | TREXS_CRUISER-NUMC1 | 0 | (default )0=TREX index, 1=file, 2=dummy for python commands | ||
| Importing |
I_USE_QUEUESERVER | TYPE | TREXS_CRUISER-NUMC1 | 1 | X=using queue server for crawling / indexing | ||
| Importing |
I_OPTIMIZE_EVERY | TYPE | TREXS_CRUISER-COUNTER | 1 | call an optimize after indexing n documents | ||
| Importing |
I_DEINDEX_FLAG | TYPE | TREXS_CRUISER-NUMC1 | 1 | 1= deindex documents which got an error during update crawl | ||
| Importing |
I_USE_FREESTYLE_CONTAINER | TYPE | TREXS_CRUISER-NUMC1 | 0 | 1= concatenate all attribute values to one | ||
| Importing |
I_GET_ACCESS_RIGHTS | TYPE | TREXS_CRUISER-NUMC1 | 0 | 1= extract ACLs from files | ||
| Importing |
I_USE_RAPTOR_ATTRIBUTES | TYPE | TREXS_CRUISER-NUMC1 | 1 | extracting of standard attributes | ||
| Importing |
I_FILE_PATH | TYPE | TREXS_CRUISER-STRING_FIELD | connector type = 1 (file) where documents will be stored | |||
| Importing |
I_CRUISE_DOCUMENT_INFO | TYPE | TREXS_CRUISE_DOCUMENT_INFO | meta information like seedurl etc. | |||
| Importing |
I_CRUISE_EXTENSION_LIST | TYPE | TREXT_CRUISE_EXTENSION_LIST | TREX cruiser extension list for parameters | |||
| Importing |
I_CRUISE_PP_EXTENSION_LIST | TYPE | TREXT_CRUISE_EXTENSION_LIST | TREX cruiser extension list for parameters | |||
| Importing |
I_DOCKEY_CONVERSION_LIST | TYPE | TREXT_CRUISE_LIST | cruiser list for convertion (e.g. document keys) | |||
| Importing |
I_HOST_INFORMATION | TYPE | TREXT_CRUISE_HOST_INFORMATION | TREX cruiser host information | |||
| Importing |
I_REGULAR_EXPRESSION | TYPE | TREXT_CRUISER_REG_EXPRESSION | regular expressions for the TREX cruiser/crawler | |||
| Importing |
I_POSITIVE_FILE_EXTENSIONS | TYPE | TREXT_POSITIVE_FILE_EXTENSIONS | list of positive files extensions which will be crawled | |||
| Importing |
I_NEGATIVE_FILE_EXTENSION | TYPE | TREXT_NEGATIVE_FILE_EXTENSIONS | list of negative files extensions which will NOT be crawled | |||
| Importing |
I_EXCLUDE_DIRECTORIES | TYPE | TREXT_EXCLUDE_DIRECTORIES | directories which must not be craweld | |||
| Importing |
I_RESULT_CONNECTOR | TYPE | TREXT_CRUISE_RESULT_CONNECTOR | TREX cruiser result connector | |||
 Exception |
CONVERSION_ERROR | TYPE | Error during conversion to UTF-8 | ||||
| Exception |
ERROR | TYPE | Error, see error message | ||||
Processing Type
| Normal Function Module | |
 Remote-Enabled Module |
BaseXML supported |
| Update Module | Start immediately |
| Immediate Start, No Restart | |
| Start Delayed | |
| Coll.run | |
| JAVA Module Callable from ABAP | |
| Remote-Enabled JAVA Module | |
| Module Callable from JAVA |
History
| Last changed by/on | SAP | 20041216 |
| SAP Release Created in | 710 |
