Ansicht
Dokumentation

SDOK_INDEX_PHIO_ASYNC - Asynchrones Indizieren eines PHIOs

Fill RESBD Structure from EBP Component Structure   CL_GUI_FRONTEND_SERVICES - Frontend Services  
Diese Dokumentation steht unter dem Copyright der SAP AG.

Funktionalität

Der Funktionsbaustein gibt ein PHIO zum Indizieren frei. Die Angabe des Dokuments erfolgt über OBJECT_ID (Klasse und GUID des PHIOs). Sollte es sich um eine mandantenabhängige Anwendung halten, ist der CLIENT zu setzen, falls er vom aktuellen Mandanten abweicht.

Bei Bedarf wird eine Indexkategorie angelegt. Mittels IDXCAT_DESCRIPTION wird die Beschreibung der Indexkategorie definiert.

Der Parameter SAPCODEPAGE dient zum expliziten Setzen der SAP-Codepage.

Sollen die indexrelevanten Daten nicht selbständig bestimmt werden, so kann man diese durch Setzen des X_IDXCAT_PROPS_GIVEN explizit setzen. Dann allerdings müssen die optionalen Parameter: COMP_CNT, LANGUAGE und IDXCAT_PROPTAB explizit gesetzt werden.

Der Rückgabewert RCODE hat den Wert:

• sdoka_idxerr_ok, wenn die Vormerkung zur Indizierung durchgeführt werden konnte

• sdoka_idxerr_idxact_notallowed, wenn die Klasse bzw. der entsprechende Indexraum gegenüber Indizierung gesperrt ist. Dieser Fall tritt ein, wenn:

• a) der Indexraum nicht aktiviert ist oder

• b) der Index ausgeliefert wird

Folgendes nur für internen Gebrauch: Mit X_UPDATE kann man einen bestehenden Eintrag erneuern, hierzu muß CREATION_TIME auf den entsprechenden Generierungszeitpunkt gestellt sein. Diese Option ist nur dann einzusetzen, wenn nachträglich eine Indexkategorie erzeugt werden soll.

Beispiel

- Normale Indexierung: nur ID und Klasse angeben.

- PHIO ist noch nicht angelegt, Attribute liegen aber schon vor:
call function 'SDOK_INDEX_PHIO_ASYNC'
exporting
object_id = object_id
client = u_client
* SAPCODEPAGE =
x_idxcat_props_given = 'X'
comp_cnt = comp_cnt
language = language
* X_UPDATE =
* CREATION_TIME =
* IDXCAT_DESCRIPTION =
tables
idxcat_proptab = idxcat_properties
exceptions
class_has_no_index_space = 1
index_space_unknown = 2
object_not_existing = 3
phio_has_no_components = 4
error_creating_idxcat = 5
more_than_one_catid = 6
no_language_given = 7
index_job_already_exists = 8
xerror = 9
others = 10.

Hinweise

Ausnahmen:

CLASS_HAS_NO_INDEX_SPACE:
Zu der Objektklasse ist kein Indexraum vorhanden.

Index_SPACE_UNKNOWN:
Der angegebene Indexraum existiert nicht.

OBJECT_NOT_EXISTING:
Das angegebene Objekt (PHIO) existiert noch nicht oder nicht mehr.

PHIO_HAS_NO_COMPONENTS:
Zu dem angegebenen Objekt existieren keine Komponenten.

ERROR_CREATING_IDXCAT:
Es konnte keine Indexkategorie angelegt werden.

NO_LANGUAGE_GIVEN:
Es wurde keine Sprache zum Dokument mit abgelegt.

INDEX_JOB_ALREADY_EXISTS:
Es existiert bereits ein entsprechender Auftrag.

Weiterführende Informationen

Parameter

CLIENT
COMP_CNT
CREATION_TIME
IDXCAT_DESCRIPTION
IDXCAT_PROPTAB
LANGUAGE
OBJECT_ID
RCODE
SAPCODEPAGE
SELECTED_CATID
SELECTED_LANGU
X_DELIVER
X_IDXCAT_PROPS_GIVEN
X_UPDATE

Ausnahmen

CLASS_HAS_NO_DOCU_SPACE
DOCU_SPACE_UNKNOWN
ERROR_CREATING_IDXCAT
INDEX_JOB_ALREADY_EXISTS
MORE_THAN_ONE_CATID
NOT_SELECTED
NO_LANGUAGE_GIVEN
OBJECT_NOT_EXISTING
PHIO_HAS_NO_COMPONENTS
XERROR

Funktionsgruppe

SDCE

CPI1466 during Backup   BAL Application Log Documentation  
Diese Dokumentation steht unter dem Copyright der SAP AG.

Length: 4519 Date: 20240523 Time: 144735     sap01-206 ( 58 ms )