Functionality
This function module is part of the Application Programming Interface(API) of the EH&Scomponent Industrial Hygiene and Safety. It is used to readpattern data.

Which patterns are read?
To determine the patterns for which the SAP system reads the data, theX_API_HEADER_TAB table must contain records in which therecord number (RECN) field is filled.
If the X_API_HEADER_TAB table does not contain an entry, theexception NO_OBJECT_SPECIFIED is triggered.

Which data is read for the patterns?
Which pattern data is read is specified by the I_FLG_XXXindicators, where an indicator corresponds to one or more output tablesas 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 thecorresponding output table(s).
If an indicator is set to "TRUE," but no corresponding output table isspecified, 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 sharedlock) or "for changing."
Within a scenario there is a maximum of three levels for which the readtype 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
INCLUDE EHS_FMODULE_API_INTERVAL_IHS OBJECT DOKU ID TX
INCLUDE EHS_NLS_API OBJECT DOKU ID TX

Notes

• Using the I_FLG_PATTERN, I_FLG_ACCUPATTERN, and
I_FLG_WORK_AREA indicators you can control whether you want toread work area patterns, workarea collective patterns or work areas. The default setting is toread 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
EH&S programming guidelines (API programming chapter)


• Type group CIHWA


• Type group CIH01