HR_ECM_ADD_MESSAGE SAP Function module - Adding a Message to the Message Handler

HR_ECM_ADD_MESSAGE is a standard SAP function module available within R/3 SAP systems depending on your version and release level. Below is the pattern details for this FM showing its interface including any import and export parameters, exceptions etc as well as any documentation contributions (Comments) specific to the object.

See here to view full function module documentation and code listing, simply by entering the name HR_ECM_ADD_MESSAGE into the relevant SAP transaction such as SE37 or SE80.

Associated Function Group: HRECM00MESSAGE
Released Date: Not Released
Processing type: Normal fucntion module

Pattern for FM HR_ECM_ADD_MESSAGE - HR ECM ADD MESSAGE

CALL FUNCTION 'HR_ECM_ADD_MESSAGE' "Adding a Message to the Message Handler
  EXPORTING
    message_handler =           " if_hrpa_message_handler  HR Master Data: Messages
    msgty =                     " symsgty       Messages, message type
    msgid =                     " symsgid       Messages, Message Class
    msgno =                     " symsgno       Messages, Message Number
*   msgv1 =                     " any           Message Variable No 1
*   msgv2 =                     " any           Message Variable No 2
*   msgv3 =                     " any           Message Variable No 3
*   msgv4 =                     " any           Message Variable No 4
*   varno_pernr_to_name =       " i             Number of variable containing PERNR which should be converted to name
    .  "  HR_ECM_ADD_MESSAGE

ABAP code example for Function Module HR_ECM_ADD_MESSAGE

The ABAP code below is a full code listing to execute function module HR_ECM_ADD_MESSAGE including all data declarations. The code uses the latest in-line data DECLARATION SYNTAX but I have included an ABAP code snippet at the end to show how declarations would look using the original method of declaring data variables up front. This will allow you to compare and fully understand the new inline method. Please note some of the newer syntax such as the @DATA is not available until a later 4.70 service pack (SP8).

DATA(ld_message_handler) = 'Check type of data required'.

DATA(ld_msgty) = 'some text here'.

DATA(ld_msgid) = 'some text here'.

DATA(ld_msgno) = 'Check type of data required'.

DATA(ld_msgv1) = 'some text here'.

DATA(ld_msgv2) = 'some text here'.

DATA(ld_msgv3) = 'some text here'.

DATA(ld_msgv4) = 'some text here'.

DATA(ld_varno_pernr_to_name) = 'some text here'.
.

CALL FUNCTION 'HR_ECM_ADD_MESSAGE'
  EXPORTING
    message_handler =            ld_message_handler
    msgty =                      ld_msgty
    msgid =                      ld_msgid
    msgno =                      ld_msgno
*   msgv1 =                      ld_msgv1
*   msgv2 =                      ld_msgv2
*   msgv3 =                      ld_msgv3
*   msgv4 =                      ld_msgv4
*   varno_pernr_to_name =        ld_varno_pernr_to_name
    .  "  HR_ECM_ADD_MESSAGE

IF SY-SUBRC EQ 0.
  "All OK
ENDIF.

ABAP code to compare 7.40 inline data declaration with original syntax

The below ABAP code uses the older none in-line data declarations. This allows you to see the coding differences/benefits of the later inline syntax. It may also be useful if you are using an older version of SAP as some of the newer syntax above, such as the @DATA is not available until 4.70 EHP 8.

DATA:

ld_message_handler
 
 TYPE IF_HRPA_MESSAGE_HANDLER ,
ld_msgty
 
 TYPE SYMSGTY ,
ld_msgid
 
 TYPE SYMSGID ,
ld_msgno
 
 TYPE SYMSGNO ,
ld_msgv1
 
 TYPE ANY ,
ld_msgv2
 
 TYPE ANY ,
ld_msgv3
 
 TYPE ANY ,
ld_msgv4
 
 TYPE ANY ,
ld_varno_pernr_to_name
 
 TYPE I .


ld_message_handler = 'some text here'.
ld_msgty = 'some text here'.
ld_msgid = 'some text here'.
ld_msgno = 'Check type of data required'.
ld_msgv1 = 'some text here'.
ld_msgv2 = 'some text here'.
ld_msgv3 = 'some text here'.
ld_msgv4 = 'some text here'.
ld_varno_pernr_to_name = 'some text here'.