Fonction SAP BAPI_XBP_JOB_ADD_EXT_STEP - Assign an External Program to a Job Step

Paramètre Reférence Type Long. Valeur par déf. Facultatif Description
EXTERNAL_USER_NAME BAPIXMLOGR-EXTUSER C 16 Name of the SAP-External User
EXT_PROGRAM_NAME BAPIXMSTEP-PROGRAM C 128 ABAP Program Name
EXT_PROGRAM_PARAMETERS BAPIXMSTEP-PARAMETER C 255 SPACE X ABAP Variant Name
JOBCOUNT BAPIXMJOB-JOBCOUNT C 8 Job Count
JOBNAME BAPIXMJOB-JOBNAME C 32 Job Name
SAP_USER_NAME BAPIXMSTEP-AUTHCKNAM C 12 SY-UNAME X SAP User Name
TARGET_HOST BAPIXMSTEP-XPGTGTSYS C 32 Executing Host for External Program
WAIT_FOR_TERMINATION BAPIXMAUX-CHAR1 C 1 'X' X Job Waiting (Yes / No)

Paramètre Reférence Type Long. Description
RETURN BAPIRET2 u 548
STEP_NUMBER BAPIXMJOB-STEPCOUNT I 4 Step Number in the Job

Functionality
This method deals with the second step of scheduling a job in the R/3background processing system. With this method you add a job step tothe job that you created with BackgroundJob.Open. This job stepinstructs the job to execute the external program.
Here you can only enter external programs directly, You cannot schedulenon-SAP commands (also known as logical commands) with the BAP methods.(Non-SAP commands define programs or commands that can be executed athost system level.) If users do not have administrator authorization,they can only schedule external programs using logical commands injobs. Users with administrator authorization, however, can schedule anexternal program in a job step in exactly the same form as it wouldcall the program in the host system.
The authorization user specified with parameter SAP_USER_NAME must haveauthorization to schedule external programs. This means that this usermust have authorization for authorization object S_RZL_ADM (RZcontrol station: Systemadministration) with the value 01.
A job may contain any number of job steps. Jobs can only containseveral different types of job steps (ABAP, external programs).
With the method call BackgroundJob.Close you finish defining the joband transfer it with the status Scheduled without start date tothe background processing system.
With the method call BackgroundJob.StartImmediately orBackgroundJob.StartAsSoonAsPossible, you instruct the system to executethe job.

Further information
XBP documentation (SAPnet/CCMS).

Description
INCLUDE BAPI_TABLE

Value range
MSG_JOBID_MISSING: You have not identified the job to which the jobstep is to be added. Either the job name or the job count is missing,or both.
MSG_JOB_DOES_NOT_EXIST: The job that you specified by job name and jobcount does not exist in the R/3 System.
MSG_PROGRAM_NAME_MISSING: You have not specified the executing externalprogram.
MSG_TARGET_HOST_MISSING: You have not specified the host on which theexternal program is to be executed.
MSG_PROBLEM_DETECTED: The background processing system has detected anerror. You can find an exact description of the problem in the R/3System log.
MSG_CANT_LOG: The method call was terminated due to an error in the R/3XMI logging system.
MSG_EXT_USER_MISSING: The external user name was not specified in thecall. This name specifies the user in the external system who triggeredthe method call.
MSG_NOT_LOGGED_ON: The external system administration tool has notlogged onto the CCMS XMI interface. The method call was terminated as aresult.
INCLUDE BAPI_XBP_STEP_NUMBER ID TX
INCLUDE BAPI_XBP_EXTERNAL_USER_NAME ID TX
INCLUDE BAPI_XBP_EXT_PROGRAM_NAME_A ID TX
INCLUDE BAPI_XBP_EXT_PROGRAM_PARM_A ID TX
INCLUDE BAPI_XBP_JOBCOUNT ID TX
INCLUDE BAPI_XBP_JOBNAME ID TX
INCLUDE BAPI_XBP_SAP_USER_NAME ID TX
INCLUDE BAPI_XBP_TARGET_SERVER_A ID TX

Description
This parameter has the effect that the background job waits for theexternal program to finish before processing the next job step(synchronous job step processing). This option is activated by default.
This setting is useful in the following cases:

  • You want to include the return code from external programs in the job
  • log.
    • You are using the options for diverting the standard output to the job
    • log.