SAP Function CBIH_FA30_UE_FAL_MAIN_CHECK - EHS: User Exit Template for Checks of Injury/Illness Log Data in APIs

Parameter Reference Type Length Default Optional Text
I_ADDINF RCGADDINF u 27 Additional Information on Object
I_CALLED_API CHAR3 C 3 Calling API
I_FLG_AFF_EXTLTXT ESP1_BOOLEAN 0 ESP1_FALSE X
I_FLG_AFF_INTLTXT ESP1_BOOLEAN 0 ESP1_FALSE X
I_FLG_CHECK_CLVALUE ESP1_BOOLEAN 0 ESP1_TRUE X Indicator: Check value assignment data
I_FLG_CHECK_ONLY ESP1_BOOLEAN 0 ESP1_FALSE X Indicator: Check data only
I_FLG_FILL_EXTERROR ESP1_BOOLEAN 0 ESP1_FALSE X Indicator: Fill extended error information table
I_FLG_HEADER ESP1_BOOLEAN 0 ESP1_FALSE X
I_FLG_INJURIES ESP1_BOOLEAN 0 ESP1_FALSE X
I_FLG_INVPERS ESP1_BOOLEAN 0 ESP1_FALSE X
I_FLG_INVPERS_LTXT ESP1_BOOLEAN 0 ESP1_FALSE X
I_FLG_MEDACT ESP1_BOOLEAN 0 ESP1_FALSE X
I_FLG_MEDA_DESCF_LTXT ESP1_BOOLEAN 0 ESP1_FALSE X
I_FLG_MEDA_DESC_LTXT ESP1_BOOLEAN 0 ESP1_FALSE X
I_FLG_PHRASECHECK_OFF ESP1_BOOLEAN 0 ESP1_FALSE X
I_FLG_VALUATION ESP1_BOOLEAN 0 ESP1_FALSE X Indicator: Value Assignment Data

Parameter Reference Type Length Text
E_FLG_ERROR ESP1_BOOLEAN 0 Indicator: Error Updating a Record
E_FLG_LOCKFAIL ESP1_BOOLEAN 0 Indicator: Lock on at least one record failed
E_FLG_WARNING ESP1_BOOLEAN 0 Indicator: Warning Updating a Record

Parameter Reference Length Optional Text
E_ERROR_TAB ESPAP_EXTERROR_TAB_TYPE 0 X Error Log Table
I_EX_API_AFFPERSDAT_TAB CIHAL_IPEVAAPI_TAB_TYPE 0 X Existing event data for person affected
I_EX_API_AFF_EXTLTXT_TAB CIHAL_IPEVALTAPI_TAB_TYPE 0 X
I_EX_API_AFF_INTLTXT_TAB CIHAL_IPEVALTAPI_TAB_TYPE 0 X
I_EX_API_HEADER_TAB CIHAL_FALHAPI_TAB_TYPE 0 X Existing Injury/Illness Log Header Data
I_EX_API_INJURIES_TAB CIHAL_IPEVINJAPI_TAB_TYPE 0 X
I_EX_API_INVPERSONS_TAB CIHAL_IPAPI_TAB_TYPE 0 X Existing Person Involved
I_EX_API_INVPERS_LTXT_TAB CIHAL_IPLTAPI_TAB_TYPE 0 X
I_EX_API_MEDACT_TAB CIHAL_FALMAAPI_TAB_TYPE 0 X
I_EX_API_MEDA_DESCF_LTXT_TAB CIHAL_FALMALTAPI_TAB_TYPE 0 X
I_EX_API_MEDA_DESC_LTXT_TAB CIHAL_FALMALTAPI_TAB_TYPE 0 X
I_EX_API_VAL_INST_TAB CIH01_IHVALAPI_TAB_TYPE 0 X
I_EX_API_VAL_PROP_TAB CIH01_IHPRAPI_TAB_TYPE 0 X
X_API_AFF_EXTLTXT_TAB CIHAL_IPEVALTAPI_TAB_TYPE 0 X
X_API_AFF_INTLTXT_TAB CIHAL_IPEVALTAPI_TAB_TYPE 0 X
X_API_FAL_TAB CIHAL_FAL_API_TAB_TYPE 0 X Injury/Illness Log Data (Create)
X_API_HEADER_TAB CIHAL_FALHAPI_TAB_TYPE 0 X Injury/Illness Log Header Data
X_API_INJURIES_TAB CIHAL_IPEVINJAPI_TAB_TYPE 0 X Injuries to persons affected
X_API_INVPERSONS_TAB CIHAL_IPAPI_TAB_TYPE 0 X Persons Involved
X_API_INVPERS_LTXT_TAB CIHAL_IPLTAPI_TAB_TYPE 0 X
X_API_MEDACT_TAB CIHAL_FALMAAPI_TAB_TYPE 0 X Medical Measures
X_API_MEDA_DESCF_LTXT_TAB CIHAL_FALMALTAPI_TAB_TYPE 0 X
X_API_MEDA_DESC_LTXT_TAB CIHAL_FALMALTAPI_TAB_TYPE 0 X
X_API_VAL_INST_TAB CIH01_IHVALAPI_TAB_TYPE 0 X
X_API_VAL_PROP_TAB CIH01_IHPRAPI_TAB_TYPE 0 X

Exception Text
INTERNAL_ERROR Internal error or Customizing error

Functionality
This function module is used to check injury/illness log data.
The function module is also available as a reference function module forthe definition of the interface of the user exit category FAL_MCHECK.The user exit is delivered empty.

Preconditions
The user exit name MAIN_CHECK must exist for FAL_MCHECK in Customizingfor Basic Data and Tools and a function module must be assignedto it.

Features
The transfer tables are set up as follows:

  • X_API_FAL_TAB: Current injury/illness log data in case of creating
    • injury/illness log entries
    • X_API_*: Current injury/illness log data when updated or deleted

    • I_EX_API_*: Existing injury/illness log data for the current data

    • E_ERROR_TAB: Error log table; the errors in this table are displayed
      • automatically on the interface
      Errors must not be raised directly in the user exit, but must bereturned via the table E_ERROR_TAB. Also, the ERRORMODE field in thecorresponding data records must be filled with the constantESPAP_ERRORMODE-ERROR and the E_FLG_ERROR indicator must be set to 'X'(TRUE). The same applies to warnings.
      Changes must not be made to the current data records other than to theERRORMODE field.

      Notes
      INCLUDE EHS_CBIH_USER_EXIT_HINT OBJECT DOKU ID TX

      Further information
      For more information, particularly about the parameters, see thedocumentation for the following APIs:
      CBIH_FA30_FAL_CREATE
      CBIH_FA30_FAL_UPDATE
      CBIH_FA30_FAL_DELETE