SPI_AGENT_GENERAL SAP Function module

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

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

Pattern for FM SPI_AGENT_GENERAL - SPI AGENT GENERAL

CALL FUNCTION 'SPI_AGENT_GENERAL' "
  EXPORTING
    ip_agent_id =               " spiagntid
    it_tracking_data =          " tspinv
*   ip_check_only =             " spibool
*   ip_forced_finish =          " spibool
*   ip_forced_finish_all =      " spibool
*   ip_led_status =             " spiled
  IMPORTING
    ep_is_active =              " spibool
    .  "  SPI_AGENT_GENERAL

ABAP code example for Function Module SPI_AGENT_GENERAL

The ABAP code below is a full code listing to execute function module SPI_AGENT_GENERAL 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_ep_is_active  
 
 TYPE SPIBOOL
.


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

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

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

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

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

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

CALL FUNCTION 'SPI_AGENT_GENERAL'
  EXPORTING
    ip_agent_id =                ld_ip_agent_id
    it_tracking_data =           ld_it_tracking_data
*   ip_check_only =              ld_ip_check_only
*   ip_forced_finish =           ld_ip_forced_finish
*   ip_forced_finish_all =       ld_ip_forced_finish_all
*   ip_led_status =              ld_ip_led_status
  IMPORTING
    ep_is_active =               ld_ep_is_active
    .  "  SPI_AGENT_GENERAL

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_ep_is_active
 
 TYPE SPIBOOL ,
ld_ip_agent_id
 
 TYPE SPIAGNTID ,
ld_it_tracking_data
 
 TYPE TSPINV ,
ld_ip_check_only
 
 TYPE SPIBOOL ,
ld_ip_forced_finish
 
 TYPE SPIBOOL ,
ld_ip_forced_finish_all
 
 TYPE SPIBOOL ,
ld_ip_led_status
 
 TYPE SPILED .


ld_ip_agent_id = 'Check type of data required'.
ld_it_tracking_data = 'Check type of data required'.
ld_ip_check_only = 'Check type of data required'.
ld_ip_forced_finish = 'Check type of data required'.
ld_ip_forced_finish_all = 'Check type of data required'.
ld_ip_led_status = 'Check type of data required'.