SAP BAPI_XBP_JOB_ADD_EXT_STEP Function Module for Assign an External Program to a Job Step









BAPI_XBP_JOB_ADD_EXT_STEP is a standard bapi xbp job add ext step SAP function module available within SAP R/3 or S/4 Hana systems, depending on your version and release level. It is used for Assign an External Program to a Job Step processing and below is the pattern details for this FM, showing its interface including any import and export parameters, exceptions etc. there is also a full "cut and paste" ABAP pattern code example, along with implementation ABAP coding, documentation and contribution comments specific to this or related objects.


See here to view full function module documentation and code listing for bapi xbp job add ext step FM, simply by entering the name BAPI_XBP_JOB_ADD_EXT_STEP into the relevant SAP transaction such as SE37 or SE38.

Function Group: SXBP
Program Name: SAPLSXBP
Main Program: SAPLSXBP
Appliation area: S
Release date: 29-Apr-1998
Mode(Normal, Remote etc): Remote-Enabled
Update:



Function BAPI_XBP_JOB_ADD_EXT_STEP pattern details

In-order to call this FM within your sap programs, simply using the below ABAP pattern details to trigger the function call...or see the full ABAP code listing at the end of this article. You can simply cut and paste this code into your ABAP progrom as it is, including variable declarations.
CALL FUNCTION 'BAPI_XBP_JOB_ADD_EXT_STEP'"Assign an External Program to a Job Step
EXPORTING
JOBNAME = "Job Name
JOBCOUNT = "Job Count
EXTERNAL_USER_NAME = "Name of the SAP-External User
EXT_PROGRAM_NAME = "ABAP Program Name
* EXT_PROGRAM_PARAMETERS = ' ' "ABAP Variant Name
* WAIT_FOR_TERMINATION = 'X' "Job Waiting (Yes / No)
TARGET_HOST = "Executing Host for External Program
* SAP_USER_NAME = SY-UNAME "SAP User Name

IMPORTING
STEP_NUMBER = "Step Number in the Job
RETURN = "
.



IMPORTING Parameters details for BAPI_XBP_JOB_ADD_EXT_STEP

JOBNAME - Job Name

Data type: BAPIXMJOB-JOBNAME
Optional: No
Call by Reference: No ( called with pass by value option)

JOBCOUNT - Job Count

Data type: BAPIXMJOB-JOBCOUNT
Optional: No
Call by Reference: No ( called with pass by value option)

EXTERNAL_USER_NAME - Name of the SAP-External User

Data type: BAPIXMLOGR-EXTUSER
Optional: No
Call by Reference: No ( called with pass by value option)

EXT_PROGRAM_NAME - ABAP Program Name

Data type: BAPIXMSTEP-PROGRAM
Optional: No
Call by Reference: No ( called with pass by value option)

EXT_PROGRAM_PARAMETERS - ABAP Variant Name

Data type: BAPIXMSTEP-PARAMETER
Default: SPACE
Optional: Yes
Call by Reference: No ( called with pass by value option)

WAIT_FOR_TERMINATION - Job Waiting (Yes / No)

Data type: BAPIXMAUX-CHAR1
Default: 'X'
Optional: Yes
Call by Reference: No ( called with pass by value option)

TARGET_HOST - Executing Host for External Program

Data type: BAPIXMSTEP-XPGTGTSYS
Optional: No
Call by Reference: No ( called with pass by value option)

SAP_USER_NAME - SAP User Name

Data type: BAPIXMSTEP-AUTHCKNAM
Default: SY-UNAME
Optional: Yes
Call by Reference: No ( called with pass by value option)

EXPORTING Parameters details for BAPI_XBP_JOB_ADD_EXT_STEP

STEP_NUMBER - Step Number in the Job

Data type: BAPIXMJOB-STEPCOUNT
Optional: No
Call by Reference: No ( called with pass by value option)

RETURN -

Data type: BAPIRET2
Optional: No
Call by Reference: No ( called with pass by value option)

Copy and paste ABAP code example for BAPI_XBP_JOB_ADD_EXT_STEP Function Module

The ABAP code below is a full code listing to execute function module POPUP_TO_CONFIRM including all data declarations. The code uses the original data declarations rather than 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 newer method of declaring data variables on the fly. 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), which i why i have stuck to the origianl for this example.

DATA:
lv_jobname  TYPE BAPIXMJOB-JOBNAME, "   
lv_step_number  TYPE BAPIXMJOB-STEPCOUNT, "   
lv_return  TYPE BAPIRET2, "   
lv_jobcount  TYPE BAPIXMJOB-JOBCOUNT, "   
lv_external_user_name  TYPE BAPIXMLOGR-EXTUSER, "   
lv_ext_program_name  TYPE BAPIXMSTEP-PROGRAM, "   
lv_ext_program_parameters  TYPE BAPIXMSTEP-PARAMETER, "   SPACE
lv_wait_for_termination  TYPE BAPIXMAUX-CHAR1, "   'X'
lv_target_host  TYPE BAPIXMSTEP-XPGTGTSYS, "   
lv_sap_user_name  TYPE BAPIXMSTEP-AUTHCKNAM. "   SY-UNAME

  CALL FUNCTION 'BAPI_XBP_JOB_ADD_EXT_STEP'  "Assign an External Program to a Job Step
    EXPORTING
         JOBNAME = lv_jobname
         JOBCOUNT = lv_jobcount
         EXTERNAL_USER_NAME = lv_external_user_name
         EXT_PROGRAM_NAME = lv_ext_program_name
         EXT_PROGRAM_PARAMETERS = lv_ext_program_parameters
         WAIT_FOR_TERMINATION = lv_wait_for_termination
         TARGET_HOST = lv_target_host
         SAP_USER_NAME = lv_sap_user_name
    IMPORTING
         STEP_NUMBER = lv_step_number
         RETURN = lv_return
. " BAPI_XBP_JOB_ADD_EXT_STEP




ABAP code using 7.40 inline data declarations to call FM BAPI_XBP_JOB_ADD_EXT_STEP

The below ABAP code uses the newer in-line data declarations. This allows you to see the coding differences/benefits of the later inline syntax. Please note some of the newer syntax below, such as the @DATA is not available until 4.70 EHP 8.

"SELECT single JOBNAME FROM BAPIXMJOB INTO @DATA(ld_jobname).
 
"SELECT single STEPCOUNT FROM BAPIXMJOB INTO @DATA(ld_step_number).
 
 
"SELECT single JOBCOUNT FROM BAPIXMJOB INTO @DATA(ld_jobcount).
 
"SELECT single EXTUSER FROM BAPIXMLOGR INTO @DATA(ld_external_user_name).
 
"SELECT single PROGRAM FROM BAPIXMSTEP INTO @DATA(ld_ext_program_name).
 
"SELECT single PARAMETER FROM BAPIXMSTEP INTO @DATA(ld_ext_program_parameters).
DATA(ld_ext_program_parameters) = ' '.
 
"SELECT single CHAR1 FROM BAPIXMAUX INTO @DATA(ld_wait_for_termination).
DATA(ld_wait_for_termination) = 'X'.
 
"SELECT single XPGTGTSYS FROM BAPIXMSTEP INTO @DATA(ld_target_host).
 
"SELECT single AUTHCKNAM FROM BAPIXMSTEP INTO @DATA(ld_sap_user_name).
DATA(ld_sap_user_name) = SY-UNAME.
 


Search for further information about these or an SAP related objects



Comments on this SAP object

What made you want to lookup this SAP object? Please tell us what you were looking for and anything you would like to be included on this page!