Kontakt

Ansicht
Dokumentation

C1F2_SUBSTANCES_READ - NOTRANSL: EHS: Lesen von Spezifikationsdaten (ohne Berücks. der Referenzie

C1F2_SUBSTANCES_READ - NOTRANSL: EHS: Lesen von Spezifikationsdaten (ohne Berücks. der Referenzie

ROGBILLS - Synchronize billing plans   ABAP Short Reference  
This documentation is copyright by SAP AG.
SAP E-Book

Functionality

This function module is part of the Application Programming Interface (API) in EH&S for specifications. It is used for reading specification data.

Which specifications are read?

In order to determine the specifications for which the SAP System reads data, the table X_API_HEADER_TAB must contain records in which one of the following fields is filled:

  • Record number (RECN)
  • Specification key (SUBID)

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 specifications?

The individual indicators I_FLG_xxx specify which specification data is read, one indicator corresponding to one or more output tables as follows:

I_FLG_HEADER X_API_HEADER_TAB
I_FLG_REFSUBS E_API_REFSUBS_TAB
I_FLG_IDENT X_API_IDENT_TAB
E_API_IDENT_SUBLIST_TAB
I_FLG_IDENT_LONGTEXT E_API_IDENT_LONGTEXT_TAB
I_FLG_MATJOIN E_API_MATJOIN_TAB
I_FLG_PROPERTIES X_API_PROP_HEADER_TAB
X_API_PROP_TAB
I_FLG_PROP_DATA E_API_PROP_DATA_TAB
E_API_PROP_COMPONENT_TAB
E_API_PROP_TAB0F_TAB
I_FLG_PROP_DETAILS X_API_PROP_USAGE_TAB
E_API_PROP_RELIABILITY_TAB
E_API_PROP_SOURCE_TAB
X_API_PROP_FTEXT_TAB
E_API_PROP_TAB07_TAB
E_API_PROP_TAB0B_TAB
E_API_PROP_TAB0D_TAB
I_FLG_PROP_FTEXT_LONGTEXT X_API_PROP_FTEXT_TAB
E_API_PROP_FTEXT_LONGTEXT_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 corresponding output table is specified, the exception PARAMETER_ERROR is triggered.

Moreover, the data selection can be restricted as follows:

  • Only identifier long texts for certain identifiers (standard value in X_API_IDENT_TAB)
  • Only value assignments for certain value assignment types (standard value in X_API_PROP_HEADER_TAB)
  • Only value assignments with a certain usage (standard value in X_API_PROP_USAGE_TAB)
  • Only value assignments that have a usage for which the user is authorized (I_FLG_PROP_CHECK_AUTH_BY_USAGE = TRUE)
  • Only value assignment detail data for certain value assignments (standard value in X_API_PROP_TAB; the corresponding value assignment type header data X_API_PROP_HEADER_TAB should also be filled)
  • Only value assignment long texts for certain user-defined texts (standard value in X_API_PROP_FTEXT_TAB)

The particular standard value is overwritten if the corresponding data is also requested (in other words, the corresponding indicator and scenario is set).

How and for what purpose is the data read?

The scenario I_SCENARIO determines how the specification 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 four levels for which the read type can be specified individually. Each output table is assigned to one level as follows:

Level 1, Header: X_API_HEADER_TAB
Level 2: E_API_REFSUBS_TAB
X_API_IDENT_TAB
E_API_IDENT_LONGTEXT_TAB
E_API_IDENT_SUBLIST_TAB
E_API_MATJOIN_TAB
X_API_PROP_HEADER_TAB
X_API_PROP_TAB
E_API_PROP_DATA_TAB
E_API_PROP_COMPONENT_TAB
E_API_PROP_TAB0F_TAB
Level 3: X_API_PROP_USAGE_TAB
E_API_PROP_RELIABILITY_TAB
E_API_PROP_SOURCE_TAB
X_API_PROP_FTEXT_TAB
E_API_PROP_FTEXT_LONGTEXT_TAB
E_API_PROP_TAB07_TAB
E_API_PROP_TAB0B_TAB
E_API_PROP_TAB0D_TAB

Notes

  • In order for the SAP System to read identifier long texts (I_FLG_IDENT_LONGTEXT = TRUE), one of the following conditions must be fulfilled, otherwise the function is terminated with the exception PARAMETER_ERROR:
  • The calling program must also request the corresponding identifiers

(I_FLG_IDENT = TRUE and output table X_API_IDENT_TAB specified in the call).
  • The calling program must transfer the corresponding identifiers in the table X_API_IDENT_TAB to the function.

  • In order to determine value assignment types, the table X_API_PROP_HEADER_TAB must contain records in which one of the following fields is filled:
  • Record number (RECN)

  • Value assignment type key (ESTCAT)

  • In order for the characteristic value assignments (I_FLG_PROP_DATA = TRUE) to be transferred to the table E_API_PROP_DATA_TAB in the same sequence as in the dialog, the indicator I_FLG_SORT_PROP_DATA = TRUE must be set. Note that sorting costs additional time and therefore slows performance.

  • In order for characteristics that do not have values assigned to them to be returned in the table X_API_PROP_DATA_TAB too, the indicator I_FLG_READ_ALL_CHARACT = TRUE must be set.

  • In order that the system only reads the value assignments (I_FLG_PROPERTIES = TRUE) for whose usage the user has authorization, the indicator I_FLG_PROP_CHECK_AUTH_BY_USAGE = TRUE must be set. If the indicator is equal to FALSE, all value assignment instances are returned, including those for which the user may not have authorization in accordance with the usage. These are, however, marked with a warning (X_API_PROP_TAB-ERRORMODE = ESPAP_ERRORMODE-WARNING). The activity (display or change) for which authorization is checked depends on the scenario chosen.

  • In order that the system only reads the value assignments that have a certain usage (I_FLG_PROPERTIES = TRUE, output table X_API_PROP_TAB specified), usage can be specified in the table X_API_PROP_USAGE_TAB. For each entry, the following fields must be defined:
  • Rating (VACLID)

  • Validity area (RVLID)

  • Active indicator (ACTVFLG = 'X')

If the indicator I_FLG_PROP_CHECK_AUTH_BY_USAGE = TRUE is set, the predefined usage is first subject to an authorization check, in other words if the predefined usage contains entries for which the user does not have authorization, these entries are deleted. Therefore, only value assignments are read that have the predefined usage and for which the user has authorization.

  • In order for value assignment long texts to be read, (I_FLG_PROP_FTEXT_LONGTEXT = TRUE), one of the following conditions must be fulfilled, otherwise the function is terminated with the exception PARAMETER_ERROR.
  • The calling program must also request the corresponding user-defined texts (I_FLG_PROP_DETAILS = TRUE and output table X_API_PROP_FTEXT_TAB specified in the call).

  • The calling program must transfer the corresponding user-defined texts in the table X_API_PROP_FTEXT_TAB to the function

  • An internal authorization check (LG_FLG_NO_AUTH_CHECK = TRUE), which may be switched off, is unconditionally switched on again at the end of this function.

Further information

  • Type group ESPAP
  • Type group ESPRH




Parameters

E_API_APPLSCP_TAB
E_API_IDENT_LONGTEXT_TAB
E_API_IDENT_SUBLIST_TAB
E_API_MATJOIN_TAB
E_API_PROP_CARR_TAB
E_API_PROP_COMPONENT_TAB
E_API_PROP_DATA_LANGU_TAB
E_API_PROP_DATA_TAB
E_API_PROP_FTEXT_LONGTEXT_TAB
E_API_PROP_PACK_TAB
E_API_PROP_RELIABILITY_TAB
E_API_PROP_SOURCE_TAB
E_API_PROP_SPROV_TAB
E_API_PROP_TAB07_TAB
E_API_PROP_TAB0B_TAB
E_API_PROP_TAB0D_TAB
E_API_PROP_TAB0F_TAB
E_API_REFSUBS_TAB
E_API_STATUS_TAB
E_API_TPLREL_TAB
E_FLG_ERROR
E_FLG_LOCKFAIL
E_FLG_WARNING
I_ADDINF
I_FLG_APPLSCP
I_FLG_DANG_GOOD_DATA
I_FLG_GET_NUM_VALS_FOR_LANGUS
I_FLG_HEADER
I_FLG_HEADER_USAGE
I_FLG_IDENT
I_FLG_IDENT_LONGTEXT
I_FLG_IDENT_SUBLIST
I_FLG_IDENT_USAGE
I_FLG_KEY_DATE_SWITCH_ONLY
I_FLG_MATJOIN
I_FLG_NO_AUTH_CHECK
I_FLG_PROPERTIES
I_FLG_PROP_CARR
I_FLG_PROP_CHAR_DATA
I_FLG_PROP_CHECK_AUTH_BY_USAGE
I_FLG_PROP_COMP
I_FLG_PROP_DATA
I_FLG_PROP_DETAILS
I_FLG_PROP_FTEXT
I_FLG_PROP_FTEXT_LONGTEXT
I_FLG_PROP_PACK
I_FLG_PROP_REL
I_FLG_PROP_SOURCE
I_FLG_PROP_SPROV
I_FLG_PROP_TAB07
I_FLG_PROP_TAB0B
I_FLG_PROP_TAB0D
I_FLG_PROP_TAB0F
I_FLG_PROP_USAGE
I_FLG_READ_ALL_CHARACT
I_FLG_REFSUBS
I_FLG_RETURN_WHOLE_INTERVAL
I_FLG_SHOW_LOCAL_INH_REC
I_FLG_SKIP_AUTH_ERRORS
I_FLG_SKIP_AUTH_MESSAGES
I_FLG_SKIP_RECNTPH
I_FLG_SORT_PROP_DATA
I_FLG_STATUS_ALLOCS
I_FLG_TPLREL
I_FLG_USG_AND
I_FLG_VAL_CHECK_BY_STATUS
I_FLG_WITH_INH_DATA
I_LANGU_TAB
I_LSADM
I_SCENARIO
I_SCENARIO_CALLBACK_FUNC
I_USAGECHECK
I_VALFR
I_VALTO
X_API_HEADER_TAB
X_API_IDENT_TAB
X_API_PROP_FTEXT_TAB
X_API_PROP_HEADER_TAB
X_API_PROP_TAB
X_API_PROP_USAGE_TAB
X_FURTHER_PARAMS

Exceptions

CONVMODE_SET_FAILED
INTERNAL_ERROR
INTERVAL_ACCESS_ERROR
KEYDATE_OR_CHANGENUMBER_ERROR
NO_OBJECT_SPECIFIED
PARAMETER_ERROR

Function Group

C1F2

SUBST_MERGE_LIST - merge external lists to one complete list with #if... logic for R3up   BAL_S_LOG - Application Log: Log header data  
This documentation is copyright by SAP AG.

Length: 12766 Date: 20240523 Time: 054426     sap01-206 ( 187 ms )