|
Functionality
This function module is part of the Application Programming Interface(API) of the EH&Scomponent Industrial Hygiene and Safety. It is used to read workarea data.Which work areas are read?
To determine the work areas for which the SAP system reads the data,the X_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 work areas?
Which work area 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_INFO_JOIN | E_API_INFO_JOIN_TAB
I_FLG_IH_DATA | E_API_IH_DATA_TAB
| E_API_PROP_DATA_TAB
I_FLG_ACTION | E_API_ACTION_TAB
I_FLG_ACTION_LTXT | E_API_ACTION_LTXT_TAB
I_FLG_DESCRIPTION | E_API_DESCRIPTION_TAB
I_FLG_DESCR_LONGTEXT | E_API_DESCR_LONGTEXT_TAB
I_FLG_ACLOC | X_API_ACLOC_TAB
I_FLG_ACLOCNAM | E_API_ACLOCNAM_TAB
I_FLG_WAQS_ASSIG | E_API_WAQS_TAB
I_FLG_FREETEXT | E_API_FREETEXT_TAB
I_FLG_FREETEXT_LTXT | E_API_FREETEXT_LTXT_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 work area data isread: "for display" (secure or nonsecure, meaning with or withoutshared lock) 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_INFO_JOIN_TAB
,,E_API_IH_DATA_TAB
,,E_API_PROP_DATA_TAB
,,E_API_ACTION_TAB
,,E_API_DESCRIPTION_TAB
,,E_API_DESCR_LONGTEXT
,,X_API_ACLOC_TAB
,,E_API_ACTION_LTXT_TAB
,,E_API_WAQS_TAB
,,E_API_WAPT_TAB
,,E_API_PTCP_TAB
,,E_API_FREETEXT_TAB
,,E_API_FREETEXT_LTXT_TAB
,,
Level 3: ,,E_API_ACLOCNAM_TAB
INCLUDE EHS_FMODULE_API_INTERVAL_IHS OBJECT DOKU ID TX
INCLUDE EHS_NLS_API OBJECT DOKU ID TXNotes
- So that the characteristic value assignments (I_FLG_IH_DATA = TRUE) are
placed in the E_API_PROP_DATA_TAB table in the order in whichthey appear in the dialog box, the I_FLG_SORT_PROP_DATAindicator must be set to "TRUE."
Note that the sort takes additional time and therefore slowsperformance.
- So that characteristics without value assignments are returned in the
X_API_PROP_DATA_TAB table, the I_FLG_READ_ALL_CHARACTindicator must be set "TRUE."
- Using the I_FLG_PATTERN, I_FLG_ACCUPATTERN, and
I_FLG_WORK_AREA indicators you can control whether you want toread work area patterns,work area collectivepatterns, or work areas. The default setting is to read work areas(I_FLG_WORK_AREA = TRUE).
|