Kontakt

Ansicht
Dokumentation

CBIH_WA30_PT_READ - EHS: Read Patterns

CBIH_WA30_PT_READ - EHS: Read Patterns

ABAP Short Reference   CL_GUI_FRONTEND_SERVICES - Frontend Services  
This documentation is copyright by SAP AG.
SAP E-Book

Functionality

This function module is part of the Application Programming Interface (API) of the EH&S component Industrial Hygiene and Safety. It is used to read pattern data.

Which patterns are read?

To determine the patterns for which the SAP system reads the data, the X_API_HEADER_TAB table must contain records in which the record number (RECN) field is filled.

If the X_API_HEADER_TAB table does not contain an entry, the exception NO_OBJECT_SPECIFIED is triggered.

Which data is read for the patterns?

Which pattern data is read is specified by the I_FLG_XXX indicators, where an indicator corresponds to one or more output tables as follows:

                          | Corresponding
Indicator                 | table parameter
--------------------------|---------------------------
I_FLG_HEADER              | X_API_HEADER_TAB
I_FLG_EXP_PROFILE         | E_API_EXP_PROFILE_TAB
I_FLG_DESCRIPTION         | E_API_DESCRIPTION_TAB
I_FLG_DESCR_LONGTEXT      | E_API_DESCR_LONGTEXT_TAB
I_FLG_WAQS_ASSIG          | E_API_WAQS_TAB
I_FLG_PATTERN_ASSIG       | E_API_WAPT_TAB
I_FLG_ACPATT_ASSIG        | E_API_PTCP_TAB

If an indicator is set to "TRUE," the respective data is placed in the corresponding output table(s).

If an indicator is set to "TRUE," but no corresponding output table is specified, the exception PARAMETER_ERROR is triggered.

How and for what purpose is the data read?

The scenario I_SCENARIO determines how the pattern data is read: "for display" (secure or nonsecure, meaning with or without shared lock) or "for changing."

Within a scenario there is a maximum of three levels for which the read type can be specified.

Each output table is assigned to a level as follows:

Level 1, header level: X_API_HEADER_TAB
Level 2: E_API_EXP_PROFILE_TAB
E_API_PROP_DATA_TAB TYPE
E_API_DESCRIPTION_TAB
E_API_DESCR_LONGTEXT
E_API_WAQS_TAB
E_API_WAPT_TAB
E_API_PTCP_TAB

Notes

  • Using the I_FLG_PATTERN, I_FLG_ACCUPATTERN, and I_FLG_WORK_AREA indicators you can control whether you want to read work area patterns, work area collective patterns or work areas. The default setting is to read patterns (I_FLG_PATTERN = TRUE).

  • Possible function module exceptions:
  • NO_OBJECT_SPECIFIED: No objects were specified for reading

  • PARAMETER_ERROR: Table for specified object missing

  • INTERNAL_ERROR: Internal processing error

  • CONVMODE_SET_FAILED: Language support error

  • INTERVAL_ACCESS_ERROR: Interval-related read error

  • Possible error indicators:
  • E_FLG_LOCKFAIL: Error locking data

  • E_FLG_ERROR: Error reading data

  • E_FLG_WARNING: Warning reading data

Further information

  • Type group CIHWA
  • Type group CIH01




Parameters

E_API_DESCRIPTION_TAB
E_API_DESCR_LONGTEXT_TAB
E_API_EXP_PROFILE_TAB
E_API_PTCP_TAB
E_API_WAPT_TAB
E_API_WAQS_TAB
E_FLG_ERROR
E_FLG_LOCKFAIL
E_FLG_WARNING
I_ADDINF
I_FLG_ACCUPATTERN
I_FLG_ACPATT_ASSIG
I_FLG_DESCRIPTION
I_FLG_DESCR_LONGTEXT
I_FLG_EXP_PROFILE
I_FLG_FILL_EXTERROR
I_FLG_HEADER
I_FLG_KEY_DATE_SWITCH_ONLY
I_FLG_PATTERN
I_FLG_PATTERN_ASSIG
I_FLG_RETURN_WHOLE_INTERVAL
I_FLG_WAQS_ASSIG
I_FLG_WORK_AREA
I_LSADM
I_SCENARIO
I_VALFR
I_VALTO
X_API_HEADER_TAB

Exceptions

CONVMODE_SET_FAILED
INTERNAL_ERROR
INTERVAL_ACCESS_ERROR
NO_OBJECT_SPECIFIED
PARAMETER_ERROR

Function Group

CBIH_WA30

Fill RESBD Structure from EBP Component Structure   BAL Application Log Documentation  
This documentation is copyright by SAP AG.

Length: 6666 Date: 20240523 Time: 084313     sap01-206 ( 64 ms )