SAP BP_STEPLIST_EDITOR Function Module for









BP_STEPLIST_EDITOR is a standard bp steplist editor SAP function module available within SAP R/3 or S/4 Hana systems, depending on your version and release level. It is used to perform a specific ABAP function and below is the pattern details, 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 bp steplist editor FM, simply by entering the name BP_STEPLIST_EDITOR into the relevant SAP transaction such as SE37 or SE38.

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



Function BP_STEPLIST_EDITOR 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 'BP_STEPLIST_EDITOR'"
EXPORTING
STEPLIST_DIALOG = "Interactive mode (yes = BTC_YES/no = BTC_NO)
* STEPLIST_OPCODE = 0 "Mode (edit/display online)
* STEP_TO_VERIFY = 0 "Index of the step to be checked (non-online)
* I_JOBNAME = "
* I_JOBCOUNT = "

IMPORTING
STEPLIST_MODIFY_TYPE = "it specifies whether and how step list was modified

TABLES
STEPLIST = "step list to be edited (internal table)

EXCEPTIONS
BAD_USER_TYPE = 1 INVALID_STEP_TYP = 10 INVALID_SYSTEM_LANGUAGE = 11 INVALID_USER_NAME = 12 INVALID_VARIANT_NAME = 13 NAME_OF_EXTPGM_MISSING = 14 NO_PLAN_AUTHORITY = 15 NO_USER_ASSIGN_PRIVILEGE = 16 NO_VARIANTS_DEFINED = 17 READING_PRINT_PARAMS_FAILED = 18 REPORT_CAN_NOT_BE_SCHEDULED = 19 CANT_GET_INSTALLED_LANGUAGES = 2 REPORT_HAS_NO_VARIANTS = 20 REPORT_NAME_MISSING = 21 TARGET_HOST_NAME_MISSING = 22 USER_NAME_MISSING = 23 VARIANT_CHECK_HAS_FAILED = 24 VARIANT_NAME_MISSING = 25 ERROR_READING_STEP_VALUES = 3 INVALID_DIALOG_TYPE = 4 INVALID_EXTERNAL_COMMAND = 5 INVALID_OPCODE = 6 INVALID_REPORT_NAME = 7 INVALID_STEP_INDEX = 8 INVALID_STEP_STATUS = 9
.



IMPORTING Parameters details for BP_STEPLIST_EDITOR

STEPLIST_DIALOG - Interactive mode (yes = BTC_YES/no = BTC_NO)

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

STEPLIST_OPCODE - Mode (edit/display online)

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

STEP_TO_VERIFY - Index of the step to be checked (non-online)

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

I_JOBNAME -

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

I_JOBCOUNT -

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

EXPORTING Parameters details for BP_STEPLIST_EDITOR

STEPLIST_MODIFY_TYPE - it specifies whether and how step list was modified

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

TABLES Parameters details for BP_STEPLIST_EDITOR

STEPLIST - step list to be edited (internal table)

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

EXCEPTIONS details

BAD_USER_TYPE - Category of the user ID is invalid for background

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

INVALID_STEP_TYP - invalid step category (not ABAP/external program)

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

INVALID_SYSTEM_LANGUAGE - Invalid system language specified

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

INVALID_USER_NAME - invalid user name

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

INVALID_VARIANT_NAME - invalid variant name

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

NAME_OF_EXTPGM_MISSING - Name of the external program is missing

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

NO_PLAN_AUTHORITY - no authorization to plan report as background job

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

NO_USER_ASSIGN_PRIVILEGE - no authorization to plan user

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

NO_VARIANTS_DEFINED - no variants are defined yet for report

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

READING_PRINT_PARAMS_FAILED - Reading the user print parameters failed

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

REPORT_CAN_NOT_BE_SCHEDULED - Report cannot be planned

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

CANT_GET_INSTALLED_LANGUAGES - Installed system languages cannot be determined

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

REPORT_HAS_NO_VARIANTS - Report has no variants

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

REPORT_NAME_MISSING - Report name is missing

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

TARGET_HOST_NAME_MISSING - Target computer name is missing

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

USER_NAME_MISSING - User ID is missing

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

VARIANT_CHECK_HAS_FAILED - Testing the variant failed (see Syslog)

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

VARIANT_NAME_MISSING - Variant name is missing

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

ERROR_READING_STEP_VALUES - Error when reading a step from step list

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

INVALID_DIALOG_TYPE - invalid interactive category

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

INVALID_EXTERNAL_COMMAND -

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

INVALID_OPCODE - invalid mode

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

INVALID_REPORT_NAME - invalid report name

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

INVALID_STEP_INDEX - Step index is invalid (non-online operation)

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

INVALID_STEP_STATUS - invalid step status

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

Copy and paste ABAP code example for BP_STEPLIST_EDITOR 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:
lt_steplist  TYPE STANDARD TABLE OF TBTCSTEP, "   
lv_bad_user_type  TYPE TBTCSTEP, "   
lv_steplist_dialog  TYPE BTCH0000-CHAR1, "   
lv_steplist_modify_type  TYPE BTCH0000-INT4, "   
lv_invalid_step_typ  TYPE BTCH0000, "   
lv_invalid_system_language  TYPE BTCH0000, "   
lv_invalid_user_name  TYPE BTCH0000, "   
lv_invalid_variant_name  TYPE BTCH0000, "   
lv_name_of_extpgm_missing  TYPE BTCH0000, "   
lv_no_plan_authority  TYPE BTCH0000, "   
lv_no_user_assign_privilege  TYPE BTCH0000, "   
lv_no_variants_defined  TYPE BTCH0000, "   
lv_reading_print_params_failed  TYPE BTCH0000, "   
lv_report_can_not_be_scheduled  TYPE BTCH0000, "   
lv_steplist_opcode  TYPE BTCH0000-INT4, "   0
lv_cant_get_installed_languages  TYPE BTCH0000, "   
lv_report_has_no_variants  TYPE BTCH0000, "   
lv_report_name_missing  TYPE BTCH0000, "   
lv_target_host_name_missing  TYPE BTCH0000, "   
lv_user_name_missing  TYPE BTCH0000, "   
lv_variant_check_has_failed  TYPE BTCH0000, "   
lv_variant_name_missing  TYPE BTCH0000, "   
lv_step_to_verify  TYPE BTCH0000-INT4, "   0
lv_error_reading_step_values  TYPE BTCH0000, "   
lv_i_jobname  TYPE BTCJOB, "   
lv_invalid_dialog_type  TYPE BTCJOB, "   
lv_i_jobcount  TYPE BTCJOBCNT, "   
lv_invalid_external_command  TYPE BTCJOBCNT, "   
lv_invalid_opcode  TYPE BTCJOBCNT, "   
lv_invalid_report_name  TYPE BTCJOBCNT, "   
lv_invalid_step_index  TYPE BTCJOBCNT, "   
lv_invalid_step_status  TYPE BTCJOBCNT. "   

  CALL FUNCTION 'BP_STEPLIST_EDITOR'  "
    EXPORTING
         STEPLIST_DIALOG = lv_steplist_dialog
         STEPLIST_OPCODE = lv_steplist_opcode
         STEP_TO_VERIFY = lv_step_to_verify
         I_JOBNAME = lv_i_jobname
         I_JOBCOUNT = lv_i_jobcount
    IMPORTING
         STEPLIST_MODIFY_TYPE = lv_steplist_modify_type
    TABLES
         STEPLIST = lt_steplist
    EXCEPTIONS
        BAD_USER_TYPE = 1
        INVALID_STEP_TYP = 10
        INVALID_SYSTEM_LANGUAGE = 11
        INVALID_USER_NAME = 12
        INVALID_VARIANT_NAME = 13
        NAME_OF_EXTPGM_MISSING = 14
        NO_PLAN_AUTHORITY = 15
        NO_USER_ASSIGN_PRIVILEGE = 16
        NO_VARIANTS_DEFINED = 17
        READING_PRINT_PARAMS_FAILED = 18
        REPORT_CAN_NOT_BE_SCHEDULED = 19
        CANT_GET_INSTALLED_LANGUAGES = 2
        REPORT_HAS_NO_VARIANTS = 20
        REPORT_NAME_MISSING = 21
        TARGET_HOST_NAME_MISSING = 22
        USER_NAME_MISSING = 23
        VARIANT_CHECK_HAS_FAILED = 24
        VARIANT_NAME_MISSING = 25
        ERROR_READING_STEP_VALUES = 3
        INVALID_DIALOG_TYPE = 4
        INVALID_EXTERNAL_COMMAND = 5
        INVALID_OPCODE = 6
        INVALID_REPORT_NAME = 7
        INVALID_STEP_INDEX = 8
        INVALID_STEP_STATUS = 9
. " BP_STEPLIST_EDITOR




ABAP code using 7.40 inline data declarations to call FM BP_STEPLIST_EDITOR

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 CHAR1 FROM BTCH0000 INTO @DATA(ld_steplist_dialog).
 
"SELECT single INT4 FROM BTCH0000 INTO @DATA(ld_steplist_modify_type).
 
 
 
 
 
 
 
 
 
 
 
"SELECT single INT4 FROM BTCH0000 INTO @DATA(ld_steplist_opcode).
 
 
 
 
 
 
 
 
"SELECT single INT4 FROM BTCH0000 INTO @DATA(ld_step_to_verify).
 
 
 
 
 
 
 
 
 
 


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!