Fonction SAP CBIH_FA30_FAL_READ - EHS: Read Injury/Illness Log Data

Paramètre Reférence Type Long. Valeur par déf. Facultatif Description
I_ADDINF RCGADDINF u 27 Additional Information on Object
I_FLG_AFF_EXTLTXT ESP1_BOOLEAN 0 ESP1_FALSE X Indicator: Long text external note
I_FLG_AFF_INTLTXT ESP1_BOOLEAN 0 ESP1_FALSE X Indicator: Long text internal note
I_FLG_FALVAL ESP1_BOOLEAN 0 ESP1_FALSE X Indicator: Read classification system data
I_FLG_FILL_EXTERROR ESP1_BOOLEAN 0 ESP1_TRUE X Indicator: Fill extended error information table
I_FLG_HEADER ESP1_BOOLEAN 0 ESP1_FALSE X Indicator: Read injury/illness log header
I_FLG_INJURIES ESP1_BOOLEAN 0 ESP1_FALSE X Indicator: Read injuries
I_FLG_INVPERS ESP1_BOOLEAN 0 ESP1_FALSE X Indicator: Read persons involved
I_FLG_INVPERS_LTXT ESP1_BOOLEAN 0 ESP1_FALSE X Indicator: Long texts for persons involved
I_FLG_KEY_DATE_SWITCH_ONLY ESP1_BOOLEAN 0 ESP1_FALSE X Indicator: Change key date and change number only
I_FLG_MEDACT ESP1_BOOLEAN 0 ESP1_FALSE X Indicator: Read medical activities
I_FLG_MEDA_DESCF_LTXT ESP1_BOOLEAN 0 ESP1_FALSE X Indicator: Long text follow-up medical treatment
I_FLG_MEDA_DESC_LTXT ESP1_BOOLEAN 0 ESP1_FALSE X Indicator: Long text medical aid given
I_FLG_NO_AUTH_CHECK ESP1_BOOLEAN 0 ESP1_FALSE X Indicator: Switch off authorization checks
I_FLG_RETURN_WHOLE_INTERVAL ESP1_BOOLEAN 0 ESP1_FALSE X Indicator: Read the entire time interval
I_FLG_VAL_READ_ALL ESP1_BOOLEAN 0 ESP1_FALSE X
I_FLG_VAL_SORT ESP1_BOOLEAN 0 ESP1_FALSE X
I_LANGU LANGU C 1 SY-LANGU X
I_SCENARIO ESPAP_SCENARIO_TYPE 0 Lock scenario for reading injury/illness log data
I_VALFR RCGADDINF-VALDAT D 8 X Lower Time Interval Limit
I_VALTO RCGADDINF-VALDAT D 8 X Upper Time Interval Limit

Paramètre Reférence Type Long. Description
E_FLG_ERROR ESP1_BOOLEAN 0 Error reading a record indicator
E_FLG_LOCKFAIL ESP1_BOOLEAN 0 Indicator: Lock on at least one record failed
E_FLG_WARNING ESP1_BOOLEAN 0 Warning reading a record indicator

Paramètre Reférence Long. Facultatif Description
E_API_AFF_EXTLTXT_TAB CIHAL_IPEVALTAPI_TAB_TYPE 0 X Long text external note
E_API_AFF_INTLTXT_TAB CIHAL_IPEVALTAPI_TAB_TYPE 0 X Long text internal note
E_API_FALVAL_INST_TAB CIH01_IHVALAPI_TAB_TYPE 0 X Classification system instance records
E_API_FALVAL_PROP_TAB CIH01_IHPRAPI_TAB_TYPE 0 X Classification system properties (contents)
E_API_INJURIES_TAB CIHAL_IPEVINJAPI_TAB_TYPE 0 X Injuries to persons affected
E_API_INVPERS_LTXT_TAB CIHAL_IPLTAPI_TAB_TYPE 0 X Long text table for persons affected
E_API_MEDACT_TAB CIHAL_FALMAAPI_TAB_TYPE 0 X Medical activities
E_API_MEDA_DESCF_LTXT_TAB CIHAL_FALMALTAPI_TAB_TYPE 0 X Long text follow-up medical treatment
E_API_MEDA_DESC_LTXT_TAB CIHAL_FALMALTAPI_TAB_TYPE 0 X Long text medical aid given
X_API_HEADER_TAB CIHAL_FALHAPI_TAB_TYPE 0 Injury/illness log header data
X_API_INVPERSONS_TAB CIHAL_IPAPI_TAB_TYPE 0 X Persons involved

Exception Description
CONVMODE_SET_FAILED Language Support Error
INTERNAL_ERROR Internal error or Customizing error
INTERVAL_ACCESS_ERROR Access to time intervals failed
NO_OBJECT_SPECIFIED No objects were specified in the header table
PARAMETER_ERROR Indicator set but relevant table missing

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

Which injury/illness log entries are read?
To determine the injury/illness log entries for which the SAP systemreads the data, the X_API_HEADER_TAB table must contain recordsin which the record 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 injury/illness log entries?
Which injury/illness log data is read is specified by the differentI_FLG_XXX indicators, where an indicator corresponds to one ormore output tables as follows:
| Corresponding
Indicator | table parameter
--------------------------|---------------------------
I_FLG_HEADER | X_API_HEADER_TAB
I_FLG_MEDACT | E_API_MEDACT_TAB
I_FLG_MEDA_DESC_LTXT | E_API_MEDA_DESC_LTXT_TAB
I_FLG_MEDA_DESCF_LTXT | E_API_MEDA_DESCF_LTXT_TAB
I_FLG_INVPERS | X_API_INVPERSONS_TAB
I_FLG_INVPERS_LTXT | E_API_INVPERS_LTXT_TAB
I_FLG_AFF_INTLTXT | E_API_AFF_INTLTXT_TAB
I_FLG_AFF_EXTLTXT | E_API_AFF_EXTLTXT_TAB
I_FLG_INJURIES | E_API_INJURIES_TAB
I_FLG_FALVAL | E_API_FALVAL_INST_TAB
| E_API_FALVAL_PROP_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 injury/illness logdata is read: "for display" (secure or nonsecure, meaning with orwithout shared lock) or "for changing." Within a scenario there is amaximum 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_MEDACT_TAB
,,E_API_MEDA_DESC_LTXT_TAB
,,E_API_MEDA_DESCF_LTXT_TAB
,,X_API_INVPERSONS_TAB
,,E_API_INVPERS_LTXT_TAB
,,E_API_AFF_INTLTXT_TAB
,,E_API_AFF_EXTLTXT_TAB
,,E_API_INJURIES_TAB
,,E_API_FALVAL_INST_TAB
,,E_API_FALVAL_PROP_TAB
INCLUDE EHS_FMODULE_API_INTERVAL_IHS OBJECT DOKU ID TX

Notes

  • So that the classification system data (I_FLG_FALVAL = TRUE) is placed
  • in the E_API_FALVAL_PROP_TAB table in the order in which it appears inthe dialog box, the I_FLG_VAL_SORT indicator must be set to"TRUE." Note that the sort takes additional time and therefore slowsperformance.
    • So that characteristics without value assignments are also returned in
    • the E_API_FALVAL_PROP_TAB table, the I_FLG_VAL_READ_ALLindicator must be set to "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 CIHAL

          • Type group CIH01

936476Language-dependent reading of characteristic values