Ansicht
Dokumentation
/SEHS/C1F0_PHRASES_READ - EHS-ERP: Read Phrases, redirected to ERP
CL_GUI_FRONTEND_SERVICES - Frontend Services Fill RESBD Structure from EBP Component StructureThis documentation is copyright by SAP AG.
Functionality
This function module is part of the application programming interfaces (APIs) in EH&S for phrases. It is used to read phrase data.
Which phrases are read?
In order to determine the phrases for which the SAP System reads data, the table X_API_HEADER_TAB must contain records for which one of the following fields is filled:
- Record number (RECN)
- Phrase key (PHRID)
If an entry in the table X_API_HEADER_TAB contains both values, the record number is used for selection. If the table X_API_HEADER_TAB does not contain an entry, the exception NO_OBJECT_SPECIFIED is triggered.
Which data is read by the phrases?
The individual indicators I_FLG_xxx specify which phrase data is read, one indicator corresponding to one or more output tables as follows:
| I_FLG_HEADER | X_API_HEADER_TAB |
| I_FLG_TEXT | E_API_TEXT_TAB |
| I_FLG_TEXT_LONGTEXT | E_API_TEXT_LONGTEXT_TAB |
| I_FLG_REF | E_API_REF_TAB |
| I_FLG_JOIN | E_API_JOIN_TAB |
If an indicator is set to TRUE, the corresponding data is transferred to the relevant output table or tables. If an indicator is set to TRUE but no output table is specified, the exception PARAMETER_ERROR is triggered.
Data selection can also be restricted as follows:
- I_TEXT_LANGU
- The phrase texts are only read in the specified language. If the translation into this language is not available, the phrase text is output in the source language.
Locks are generally always set on the phrase header. You can, however, minimize the number of locks:
- I_FLG_LOCK_CATALOG
- Locks are only set on the phrase library.
How and for what purpose is the data read?
The scenario I_SCENARIO determines how the phrase data is read, in other words to
display (nonsecure or secure, in other words with or without shared lock) or to
change. Within a scenario, there is a maximum of two levels for which the read type can be specified individually. Each output table is assigned to a level as follows:
| Level 1, header level: | X_API_HEADER_TAB |
| Level 2 : | E_API_TEXT_TAB |
| E_API_TEXT_LONGTEXT_TAB | |
| E_API_REF_TAB | |
| E_API_JOIN_TAB | |
Notes
- In order for the SAP System to read phrase long texts (I_FLG_TEXT_LONGTEXT = TRUE), the initiator must also request the corresponding phrase texts (I_FLG_TEXT = TRUE and output table E_API_TEXT_TAB specified in the call). Otherwise, the function is terminated with the exception PARAMETER_ERROR.
- Type group ESPAP
- Type group ESPPH
Parameters
E_API_JOIN_TABE_API_REF_TAB
E_API_TEXT_LONGTEXT_TAB
E_API_TEXT_TAB
E_FLG_ERROR
E_FLG_LOCKFAIL
E_FLG_WARNING
I_ADDINF
I_FLG_DO_USEREXIT
I_FLG_FILL_EXTERROR
I_FLG_HEADER
I_FLG_JOIN
I_FLG_KEY_DATE_SWITCH_ONLY
I_FLG_LOCK_CATALOG
I_FLG_NO_AUTH_CHECK
I_FLG_REF
I_FLG_RETURN_WHOLE_INTERVAL
I_FLG_SPLIT_WITHOUT_CHANGENO
I_FLG_TEXT
I_FLG_TEXT_LONGTEXT
I_LSADM
I_SCENARIO
I_TEXT_LANGU
I_VALFR
I_VALTO
X_API_HEADER_TAB
X_LANGU_TAB
Exceptions
CONVMODE_SET_FAILEDINTERNAL_ERROR
INTERVAL_ACCESS_ERROR
KEYDATE_OR_CHANGENUMBER_ERROR
NO_OBJECT_SPECIFIED
PARAMETER_ERROR
Function Group
S/SAPLC1F0Vendor Master (General Section) CL_GUI_FRONTEND_SERVICES - Frontend Services
This documentation is copyright by SAP AG.
Length: 4739 Date: 20240419 Time: 145309 sap01-206 ( 73 ms )
