SAP RSBATCH_START_PROCESS Function Module for start batch process









RSBATCH_START_PROCESS is a standard rsbatch start process SAP function module available within SAP R/3 or S/4 Hana systems, depending on your version and release level. It is used for start batch process 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 rsbatch start process FM, simply by entering the name RSBATCH_START_PROCESS into the relevant SAP transaction such as SE37 or SE38.

Function Group: RSBATCH
Program Name: SAPLRSBATCH
Main Program: SAPLRSBATCH
Appliation area:
Release date: N/A
Mode(Normal, Remote etc): Normal Function Module
Update:



Function RSBATCH_START_PROCESS 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 'RSBATCH_START_PROCESS'"start batch process
  EXPORTING
   I_PROCESS_TYPE =  "Process Type
*  I_PC_LOGID =  "Log ID of a Process Chain Run
*  I_PC_CALLBACK_AT_END = ' ' "Boolean
*  I_PARALLEL_PROCS = 0 "Natural Number
*  I_BATCH_CLASS = ' ' "Single-Character Indicator
*  I_DO_IT_SERIAL = ' ' "Single-Character Indicator
*  I_ONLY_DO_IT_PAR = ' ' "Do NOT Use - !!! For Internal Usage ONLY !!!
*  I_SAME_LUW_IF_SER = ' ' "Single-Character Indicator
*  I_T_INFO =  "
*  I_PARENT_BATCH_ID =  "Batch ID
*  I_LANGU = SY-LANGU "SAP R/3 System, Current Language
   I_BATCH_ID =  "30 Characters
*  I_UNAME = SY-UNAME "ABAP System, User Logon Name
*  I_DETLEVEL_FOR_PROT = ' ' "Application Log: Level of Detail
*  I_START_ALL_AT_ONCE = ' ' "Split off all batches at the beginning (with Hold !)
*  I_HOLD_PAR_PROCS = ' ' "Off-splitted batches do not terminate
*  I_RESTART_RED_PROCESS = ' ' "Boolean
*  I_OVERWRITE_PARM = ' ' "Boolean
*  I_LEAD_PROC_TYPE =  "leading process that determines customizing
*  I_BATCH_PROCESS = 0 "Natural Number
   I_PARAMETER =  "Raw String
*  I_MODULE_NAME =  "ABAP Program: Current Main Program
*  I_MODULE_TYPE =  "Module Type
*  I_LAST_PROCESS = 'X' "Boolean
*  I_PC_VARIANT =  "Process Variant (Name)
*  I_PC_INSTANCE =  "Process Instance (Value)

 IMPORTING
   E_JOBNAME =  "Background Job Name
   E_JOBCOUNT =  "Job ID
   E_BATCH_PROCESS =  "Natural Number
   E_DONE_IN_SAME_WP =  "Boolean

EXCEPTIONS
   ERROR_STARTING_BATCHJOB = 1    NO_PARALLEL_PROCESSING_ALLOWED = 2
.



IMPORTING Parameters details for RSBATCH_START_PROCESS

I_PROCESS_TYPE - Process Type

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

I_PC_LOGID - Log ID of a Process Chain Run

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

I_PC_CALLBACK_AT_END - Boolean

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

I_PARALLEL_PROCS - Natural Number

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

I_BATCH_CLASS - Single-Character Indicator

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

I_DO_IT_SERIAL - Single-Character Indicator

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

I_ONLY_DO_IT_PAR - Do NOT Use - !!! For Internal Usage ONLY !!!

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

I_SAME_LUW_IF_SER - Single-Character Indicator

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

I_T_INFO -

Data type: RSBTC_T_INFO
Optional: Yes
Call by Reference: Yes

I_PARENT_BATCH_ID - Batch ID

Data type: RSBTC_BATCH_ID
Optional: Yes
Call by Reference: Yes

I_LANGU - SAP R/3 System, Current Language

Data type: SYLANGU
Default: SY-LANGU
Optional: Yes
Call by Reference: Yes

I_BATCH_ID - 30 Characters

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

I_UNAME - ABAP System, User Logon Name

Data type: SYUNAME
Default: SY-UNAME
Optional: Yes
Call by Reference: Yes

I_DETLEVEL_FOR_PROT - Application Log: Level of Detail

Data type: BALLEVEL
Default: SPACE
Optional: Yes
Call by Reference: Yes

I_START_ALL_AT_ONCE - Split off all batches at the beginning (with Hold !)

Data type: CHAR1
Default: SPACE
Optional: Yes
Call by Reference: Yes

I_HOLD_PAR_PROCS - Off-splitted batches do not terminate

Data type: CHAR1
Default: SPACE
Optional: Yes
Call by Reference: Yes

I_RESTART_RED_PROCESS - Boolean

Data type: RS_BOOL
Default: SPACE
Optional: Yes
Call by Reference: Yes

I_OVERWRITE_PARM - Boolean

Data type: RS_BOOL
Default: SPACE
Optional: Yes
Call by Reference: Yes

I_LEAD_PROC_TYPE - leading process that determines customizing

Data type: RSPC_TYPE
Optional: Yes
Call by Reference: Yes

I_BATCH_PROCESS - Natural Number

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

I_PARAMETER - Raw String

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

I_MODULE_NAME - ABAP Program: Current Main Program

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

I_MODULE_TYPE - Module Type

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

I_LAST_PROCESS - Boolean

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

I_PC_VARIANT - Process Variant (Name)

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

I_PC_INSTANCE - Process Instance (Value)

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

EXPORTING Parameters details for RSBATCH_START_PROCESS

E_JOBNAME - Background Job Name

Data type: BTCJOB
Optional: No
Call by Reference: Yes

E_JOBCOUNT - Job ID

Data type: BTCJOBCNT
Optional: No
Call by Reference: Yes

E_BATCH_PROCESS - Natural Number

Data type: INT4
Optional: No
Call by Reference: Yes

E_DONE_IN_SAME_WP - Boolean

Data type: RS_BOOL
Optional: No
Call by Reference: Yes

EXCEPTIONS details

ERROR_STARTING_BATCHJOB - Error during start of batch job

Data type:
Optional: No
Call by Reference: Yes

NO_PARALLEL_PROCESSING_ALLOWED - Parallel processing not possible - switched to serial processing

Data type:
Optional: No
Call by Reference: Yes

Copy and paste ABAP code example for RSBATCH_START_PROCESS 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_e_jobname  TYPE BTCJOB, "   
lv_i_process_type  TYPE RSPC_TYPE, "   
lv_error_starting_batchjob  TYPE RSPC_TYPE, "   
lv_i_pc_logid  TYPE RSPC_LOGID, "   
lv_i_pc_callback_at_end  TYPE RS_BOOL, "   SPACE
lv_i_parallel_procs  TYPE INT4, "   0
lv_i_batch_class  TYPE CHAR1, "   SPACE
lv_i_do_it_serial  TYPE CHAR1, "   SPACE
lv_i_only_do_it_par  TYPE CHAR1, "   SPACE
lv_i_same_luw_if_ser  TYPE CHAR1, "   SPACE
lv_i_t_info  TYPE RSBTC_T_INFO, "   
lv_i_parent_batch_id  TYPE RSBTC_BATCH_ID, "   
lv_i_langu  TYPE SYLANGU, "   SY-LANGU
lv_e_jobcount  TYPE BTCJOBCNT, "   
lv_i_batch_id  TYPE RSBTC_BATCH_ID, "   
lv_no_parallel_processing_allowed  TYPE RSBTC_BATCH_ID, "   
lv_i_uname  TYPE SYUNAME, "   SY-UNAME
lv_i_detlevel_for_prot  TYPE BALLEVEL, "   SPACE
lv_i_start_all_at_once  TYPE CHAR1, "   SPACE
lv_i_hold_par_procs  TYPE CHAR1, "   SPACE
lv_i_restart_red_process  TYPE RS_BOOL, "   SPACE
lv_i_overwrite_parm  TYPE RS_BOOL, "   SPACE
lv_i_lead_proc_type  TYPE RSPC_TYPE, "   
lv_e_batch_process  TYPE INT4, "   
lv_i_batch_process  TYPE INT4, "   0
lv_i_parameter  TYPE RSRAWSTRING, "   
lv_e_done_in_same_wp  TYPE RS_BOOL, "   
lv_i_module_name  TYPE SYREPID, "   
lv_i_module_type  TYPE RSBATCH_MTYPE, "   
lv_i_last_process  TYPE RS_BOOL, "   'X'
lv_i_pc_variant  TYPE RSPC_VARIANT, "   
lv_i_pc_instance  TYPE RSPC_INSTANCE. "   

  CALL FUNCTION 'RSBATCH_START_PROCESS'  "start batch process
    EXPORTING
         I_PROCESS_TYPE = lv_i_process_type
         I_PC_LOGID = lv_i_pc_logid
         I_PC_CALLBACK_AT_END = lv_i_pc_callback_at_end
         I_PARALLEL_PROCS = lv_i_parallel_procs
         I_BATCH_CLASS = lv_i_batch_class
         I_DO_IT_SERIAL = lv_i_do_it_serial
         I_ONLY_DO_IT_PAR = lv_i_only_do_it_par
         I_SAME_LUW_IF_SER = lv_i_same_luw_if_ser
         I_T_INFO = lv_i_t_info
         I_PARENT_BATCH_ID = lv_i_parent_batch_id
         I_LANGU = lv_i_langu
         I_BATCH_ID = lv_i_batch_id
         I_UNAME = lv_i_uname
         I_DETLEVEL_FOR_PROT = lv_i_detlevel_for_prot
         I_START_ALL_AT_ONCE = lv_i_start_all_at_once
         I_HOLD_PAR_PROCS = lv_i_hold_par_procs
         I_RESTART_RED_PROCESS = lv_i_restart_red_process
         I_OVERWRITE_PARM = lv_i_overwrite_parm
         I_LEAD_PROC_TYPE = lv_i_lead_proc_type
         I_BATCH_PROCESS = lv_i_batch_process
         I_PARAMETER = lv_i_parameter
         I_MODULE_NAME = lv_i_module_name
         I_MODULE_TYPE = lv_i_module_type
         I_LAST_PROCESS = lv_i_last_process
         I_PC_VARIANT = lv_i_pc_variant
         I_PC_INSTANCE = lv_i_pc_instance
    IMPORTING
         E_JOBNAME = lv_e_jobname
         E_JOBCOUNT = lv_e_jobcount
         E_BATCH_PROCESS = lv_e_batch_process
         E_DONE_IN_SAME_WP = lv_e_done_in_same_wp
    EXCEPTIONS
        ERROR_STARTING_BATCHJOB = 1
        NO_PARALLEL_PROCESSING_ALLOWED = 2
. " RSBATCH_START_PROCESS




ABAP code using 7.40 inline data declarations to call FM RSBATCH_START_PROCESS

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.

 
 
 
 
DATA(ld_i_pc_callback_at_end) = ' '.
 
 
DATA(ld_i_batch_class) = ' '.
 
DATA(ld_i_do_it_serial) = ' '.
 
DATA(ld_i_only_do_it_par) = ' '.
 
DATA(ld_i_same_luw_if_ser) = ' '.
 
 
 
DATA(ld_i_langu) = SY-LANGU.
 
 
 
 
DATA(ld_i_uname) = SY-UNAME.
 
DATA(ld_i_detlevel_for_prot) = ' '.
 
DATA(ld_i_start_all_at_once) = ' '.
 
DATA(ld_i_hold_par_procs) = ' '.
 
DATA(ld_i_restart_red_process) = ' '.
 
DATA(ld_i_overwrite_parm) = ' '.
 
 
 
 
 
 
 
 
DATA(ld_i_last_process) = 'X'.
 
 
 


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!