SAP ABAP Data Element SRTVCBDOCS (Text Retrieval: Callback for Reading Documents)

Hierarchy

☛ SAP_BASIS (Software Component) SAP Basis Component
   ⤷ BC-SRV-SEN (Application Component) ABAP Search Engine for ERP Solution Database
     ⤷ SRTV (Package) Natural Language Text Retrieval: Core functions

Basic Data

Data Element	SRTVCBDOCS
Short Description	Text Retrieval: Callback for Reading Documents

Data Type

Category of Dictionary Type	D	Domain
Type of Object Referenced		No Information
Domain / Name of Reference Type	FUNCNAME
Data Type	CHAR	Character String
Length	30
Decimal Places	0
Output Length	30
Value Table	TFDIR

Further Characteristics

Search Help: Name
Search Help: Parameters
Parameter ID	LIB
Default Component name
Change document	☐
No Input History	☐
Basic direction is set to LTR	☐
No BIDI Filtering	☐

Field Label

	Length	Field Label
Short	10	Doc. Read
Medium	15	Document Read
Long	20	Document Read CB
Heading	30	Document Read Callback

Documentation

Definition

Name of the callback that passes the documents when the index is compiled.

Use

The interface of the callback function is described in the following parameters:

• IMPORT
• VALUE(ID_CORPUSID) TYPE SRTVCORPID
• CHANGING
• REFERENCE(CT_DOCUMENTS) TYPE SRTV_DOC_TABLE
• REFERENCE(CD_NO_MORE_DOCUMENTS) TYPE CHAR01 DEFAULT 'X'
• EXCEPTIONS
• NO_DOCUMENTS_FOUND

The search engine returns the index name. The callback provides a list of documents (the non-flat line type is srtv_doc) containing an ID and the text for each document. If the documents are to be deleted from the index, the texts do not have to be passed.

If the flag CD_NO_MORE_DOCUMENTS is initial, the callback is called again until the flag is set to X.

Dependencies

The key of the action to be performed is passed to the search engine by the actuality check callback.

The types used on the interfaces of the callback functions are defined in the ABAP Dictionary or in type pools SRTV and SRTV1.

Examples

History

Last changed by/on	SAP	20020827
SAP Release Created in