RH_TASK_AGENT_CHECK SAP Function module - Check Whether Specific OrgObject May Edit Task

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

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

Pattern for FM RH_TASK_AGENT_CHECK - RH TASK AGENT CHECK

CALL FUNCTION 'RH_TASK_AGENT_CHECK' "Check Whether Specific OrgObject May Edit Task
  EXPORTING
    org_otype =                 " objec-otype
    org_objid =                 "
    task_otype =                " objec-otype
    task_objid =                "
*   act_wi_id =                 " swwwihead-wi_id
*   act_plvar =                 " objec-plvar
*   act_begda = SY-DATUM        " objec-begda
*   act_endda = SY-DATUM        " objec-endda
*   update_index =              " objec-histo
  IMPORTING
    general_task =              " p1217-general  Indicator: General task
    no_gensend =                " p1217-no_gensend  General forwarding not allowed
    no_send =                   " p1217-no_send  Forwarding not allowed
* TABLES
*   excluded_agents =           " swhactor
  EXCEPTIONS
    NO_ACTIVE_PLVAR = 1         "
    NOT_AGENT_OF_TASK = 2       "
    NO_AGENT_OTYPE = 3          "
    NO_TASK_OTYPE = 4           "
    NO_AGENTS_OF_TASK_FOUND = 5  "
    BACKGROUND_TASK = 6         "
    .  "  RH_TASK_AGENT_CHECK

ABAP code example for Function Module RH_TASK_AGENT_CHECK

The ABAP code below is a full code listing to execute function module RH_TASK_AGENT_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:
ld_general_task  
 
 TYPE P1217-GENERAL
,
ld_no_gensend  
 
 TYPE P1217-NO_GENSEND
,
ld_no_send  
 
 TYPE P1217-NO_SEND
,
it_excluded_agents  
 
 TYPE STANDARD TABLE OF SWHACTOR,"TABLES PARAM
wa_excluded_agents
 
 LIKE LINE OF it_excluded_agents
.



DATA(ld_org_otype) = some text here

DATA(ld_org_objid) = 'some text here'.


DATA(ld_task_otype) = some text here

DATA(ld_task_objid) = 'some text here'.
 

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



DATA(ld_act_plvar) = some text here


DATA(ld_act_begda) = 20210129


DATA(ld_act_endda) = 20210129


DATA(ld_update_index) = some text here
 

"populate fields of struture and append to itab
append wa_excluded_agents to it_excluded_agents.
.

CALL FUNCTION 'RH_TASK_AGENT_CHECK'
  EXPORTING
    org_otype =                  ld_org_otype
    org_objid =                  ld_org_objid
    task_otype =                 ld_task_otype
    task_objid =                 ld_task_objid
*   act_wi_id =                  ld_act_wi_id
*   act_plvar =                  ld_act_plvar
*   act_begda =                  ld_act_begda
*   act_endda =                  ld_act_endda
*   update_index =               ld_update_index
  IMPORTING
    general_task =               ld_general_task
    no_gensend =                 ld_no_gensend
    no_send =                    ld_no_send
* TABLES
*   excluded_agents =            it_excluded_agents
  EXCEPTIONS
    NO_ACTIVE_PLVAR =            1
    NOT_AGENT_OF_TASK =          2
    NO_AGENT_OTYPE =             3
    NO_TASK_OTYPE =              4
    NO_AGENTS_OF_TASK_FOUND =    5
    BACKGROUND_TASK =            6
    .  "  RH_TASK_AGENT_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
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_general_task
 
 TYPE P1217-GENERAL ,
ld_org_otype
 
 TYPE OBJEC-OTYPE ,
it_excluded_agents
 
 TYPE STANDARD TABLE OF SWHACTOR ,
wa_excluded_agents
 
 LIKE LINE OF it_excluded_agents,
ld_no_gensend
 
 TYPE P1217-NO_GENSEND ,
ld_org_objid
 
 TYPE STRING ,
ld_no_send
 
 TYPE P1217-NO_SEND ,
ld_task_otype
 
 TYPE OBJEC-OTYPE ,
ld_task_objid
 
 TYPE STRING ,
ld_act_wi_id
 
 TYPE SWWWIHEAD-WI_ID ,
ld_act_plvar
 
 TYPE OBJEC-PLVAR ,
ld_act_begda
 
 TYPE OBJEC-BEGDA ,
ld_act_endda
 
 TYPE OBJEC-ENDDA ,
ld_update_index
 
 TYPE OBJEC-HISTO .



ld_org_otype = some text here 

"populate fields of struture and append to itab
append wa_excluded_agents to it_excluded_agents.
ld_org_objid = 'some text here'.

ld_task_otype = some text here
ld_task_objid = 'some text here'.

SELECT single WI_ID 
  FROM SWWWIHEAD 
  INTO ld_act_wi_id.


ld_act_plvar = some text here

ld_act_begda = 20210129

ld_act_endda = 20210129

ld_update_index = some text here