RH_WI_AGENT_EXECUTE_CHECK SAP Function module - Check whether work item may be edited

RH_WI_AGENT_EXECUTE_CHECK 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 RH_WI_AGENT_EXECUTE_CHECK into the relevant SAP transaction such as SE37 or SE80.

Associated Function Group: RHW1
Released Date: Not Released
Processing type: Remote-Enabled

Pattern for FM RH_WI_AGENT_EXECUTE_CHECK - RH WI AGENT EXECUTE CHECK

CALL FUNCTION 'RH_WI_AGENT_EXECUTE_CHECK' "Check whether work item may be edited
  EXPORTING
    wi_id =                     " swwwihead-wi_id
*   origin_otype =              " swhactor-otype
*   origin_objid =              " swhactor-objid
*   search_date = SY-DATUM      " sy-datum
*   check_org_restriction =     " hrpp0c-test
*   inbox_fcode = SPACE         " sy-ucomm      Screens, Function Code Triggered by PAI
*   inbox_user = SY-UNAME       " actorid
*   iv_do_commit = 'X'          " xflag
* TABLES
*   it_inbox_view =             " hrwfuser_v    Transfer Structure to FM Org_Info_and_Task
  EXCEPTIONS
    NO_ACTIVE_PLVAR = 1         "
    WI_NOT_FOUND = 2            "
    NO_AGENT_OF_TASK = 3        "
    ORG_INFO_NOT_FOUND = 4      "
    EXCLUDED_AGENT = 5          "
    RESERVED_WI = 6             "
    WRONG_STATUS = 7            "
    OTHER_ERROR = 8             "
    .  "  RH_WI_AGENT_EXECUTE_CHECK

ABAP code example for Function Module RH_WI_AGENT_EXECUTE_CHECK

The ABAP code below is a full code listing to execute function module RH_WI_AGENT_EXECUTE_CHECK 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:
it_it_inbox_view  
 
 TYPE STANDARD TABLE OF HRWFUSER_V,"TABLES PARAM
wa_it_inbox_view
 
 LIKE LINE OF it_it_inbox_view
.

 

SELECT single WI_ID 
  FROM SWWWIHEAD 
  INTO @DATA(ld_wi_id).



DATA(ld_origin_otype) = some text here


DATA(ld_origin_objid) = some text here

DATA(ld_search_date) = '20210129'.


DATA(ld_check_org_restriction) = some text here

DATA(ld_inbox_fcode) = 'some text here'.

DATA(ld_inbox_user) = 'some text here'.

DATA(ld_iv_do_commit) = 'some text here'.
 

"populate fields of struture and append to itab
append wa_it_inbox_view to it_it_inbox_view.
.

CALL FUNCTION 'RH_WI_AGENT_EXECUTE_CHECK'
  EXPORTING
    wi_id =                      ld_wi_id
*   origin_otype =               ld_origin_otype
*   origin_objid =               ld_origin_objid
*   search_date =                ld_search_date
*   check_org_restriction =      ld_check_org_restriction
*   inbox_fcode =                ld_inbox_fcode
*   inbox_user =                 ld_inbox_user
*   iv_do_commit =               ld_iv_do_commit
* TABLES
*   it_inbox_view =              it_it_inbox_view
  EXCEPTIONS
    NO_ACTIVE_PLVAR =            1
    WI_NOT_FOUND =               2
    NO_AGENT_OF_TASK =           3
    ORG_INFO_NOT_FOUND =         4
    EXCLUDED_AGENT =             5
    RESERVED_WI =                6
    WRONG_STATUS =               7
    OTHER_ERROR =                8
    .  "  RH_WI_AGENT_EXECUTE_CHECK

IF SY-SUBRC EQ 0.
  "All OK
ELSEIF SY-SUBRC EQ 1. "Exception
  "Add code for exception here
ELSEIF SY-SUBRC EQ 2. "Exception
  "Add code for exception here
ELSEIF SY-SUBRC EQ 3. "Exception
  "Add code for exception here
ELSEIF SY-SUBRC EQ 4. "Exception
  "Add code for exception here
ELSEIF SY-SUBRC EQ 5. "Exception
  "Add code for exception here
ELSEIF SY-SUBRC EQ 6. "Exception
  "Add code for exception here
ELSEIF SY-SUBRC EQ 7. "Exception
  "Add code for exception here
ELSEIF SY-SUBRC EQ 8. "Exception
  "Add code for exception here
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_wi_id
 
 TYPE SWWWIHEAD-WI_ID ,
it_it_inbox_view
 
 TYPE STANDARD TABLE OF HRWFUSER_V ,
wa_it_inbox_view
 
 LIKE LINE OF it_it_inbox_view,
ld_origin_otype
 
 TYPE SWHACTOR-OTYPE ,
ld_origin_objid
 
 TYPE SWHACTOR-OBJID ,
ld_search_date
 
 TYPE SY-DATUM ,
ld_check_org_restriction
 
 TYPE HRPP0C-TEST ,
ld_inbox_fcode
 
 TYPE SY-UCOMM ,
ld_inbox_user
 
 TYPE ACTORID ,
ld_iv_do_commit
 
 TYPE XFLAG .



SELECT single WI_ID 
  FROM SWWWIHEAD 
  INTO ld_wi_id.
 

"populate fields of struture and append to itab
append wa_it_inbox_view to it_it_inbox_view.

ld_origin_otype = some text here

ld_origin_objid = some text here
ld_search_date = '20210129'.

ld_check_org_restriction = some text here
ld_inbox_fcode = 'some text here'.
ld_inbox_user = 'some text here'.
ld_iv_do_commit = 'some text here'.