WFA_FORECAST_RUN_BACKGROUND SAP Function module - run a forecasting session

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

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

Pattern for FM WFA_FORECAST_RUN_BACKGROUND - WFA FORECAST RUN BACKGROUND

CALL FUNCTION 'WFA_FORECAST_RUN_BACKGROUND' "run a forecasting session
  EXPORTING
*   iv_location =               " wfa_location_type  Location Profile
*   iv_org_id =                 " hrobjid       CRM Organizational Management Org Key
    iv_start_date =             " begdatum      Start Date
    iv_end_date =               " enddatum      End Date
*   iv_phase = 0                " i             phase to start forecast at 0=beginning, -1=resume, 1=workload
*   iv_bypass_warnings = 'X'    " wfa_boolean   Boolean ( True = 'X', False = ' ')
    iv_calcstatus_id =          " wfa_id        ID
    iv_end_of_process =         " wfa_boolean   Boolean ( True = 'X', False = ' ')
    iv_lock_org =               " hrobjid       Object ID
*   it_org_samples =            " wfafct_sampleval_set2  Sample Value Set Table
*   iv_workload_adjust = ' '    " wfa_boolean   Boolean ( True = 'X', False = ' ')
  IMPORTING
    et_return =                 " bapiret2_t    Return parameter table
    ev_calcstatus_id =          " wfa_id        ID
    ev_org_id =                 " hrobjid       Object ID
    ev_end_of_process =         " wfa_boolean   Boolean ( True = 'X', False = ' ')
    ev_eff_date =               " wfa_date      Boolean ( True = 'X', False = ' ')
    ev_lock_org =               " hrobjid       Object ID
    .  "  WFA_FORECAST_RUN_BACKGROUND

ABAP code example for Function Module WFA_FORECAST_RUN_BACKGROUND

The ABAP code below is a full code listing to execute function module WFA_FORECAST_RUN_BACKGROUND 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_et_return  
 
 TYPE BAPIRET2_T
,
ld_ev_calcstatus_id  
 
 TYPE WFA_ID
,
ld_ev_org_id  
 
 TYPE HROBJID
,
ld_ev_end_of_process  
 
 TYPE WFA_BOOLEAN
,
ld_ev_eff_date  
 
 TYPE WFA_DATE
,
ld_ev_lock_org  
 
 TYPE HROBJID
.


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

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

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

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

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

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

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

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

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

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

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

CALL FUNCTION 'WFA_FORECAST_RUN_BACKGROUND'
  EXPORTING
*   iv_location =                ld_iv_location
*   iv_org_id =                  ld_iv_org_id
    iv_start_date =              ld_iv_start_date
    iv_end_date =                ld_iv_end_date
*   iv_phase =                   ld_iv_phase
*   iv_bypass_warnings =         ld_iv_bypass_warnings
    iv_calcstatus_id =           ld_iv_calcstatus_id
    iv_end_of_process =          ld_iv_end_of_process
    iv_lock_org =                ld_iv_lock_org
*   it_org_samples =             ld_it_org_samples
*   iv_workload_adjust =         ld_iv_workload_adjust
  IMPORTING
    et_return =                  ld_et_return
    ev_calcstatus_id =           ld_ev_calcstatus_id
    ev_org_id =                  ld_ev_org_id
    ev_end_of_process =          ld_ev_end_of_process
    ev_eff_date =                ld_ev_eff_date
    ev_lock_org =                ld_ev_lock_org
    .  "  WFA_FORECAST_RUN_BACKGROUND

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_et_return
 
 TYPE BAPIRET2_T ,
ld_iv_location
 
 TYPE WFA_LOCATION_TYPE ,
ld_ev_calcstatus_id
 
 TYPE WFA_ID ,
ld_iv_org_id
 
 TYPE HROBJID ,
ld_ev_org_id
 
 TYPE HROBJID ,
ld_iv_start_date
 
 TYPE BEGDATUM ,
ld_ev_end_of_process
 
 TYPE WFA_BOOLEAN ,
ld_iv_end_date
 
 TYPE ENDDATUM ,
ld_ev_eff_date
 
 TYPE WFA_DATE ,
ld_iv_phase
 
 TYPE I ,
ld_ev_lock_org
 
 TYPE HROBJID ,
ld_iv_bypass_warnings
 
 TYPE WFA_BOOLEAN ,
ld_iv_calcstatus_id
 
 TYPE WFA_ID ,
ld_iv_end_of_process
 
 TYPE WFA_BOOLEAN ,
ld_iv_lock_org
 
 TYPE HROBJID ,
ld_it_org_samples
 
 TYPE WFAFCT_SAMPLEVAL_SET2 ,
ld_iv_workload_adjust
 
 TYPE WFA_BOOLEAN .


ld_iv_location = 'Check type of data required'.
ld_iv_org_id = 'Check type of data required'.
ld_iv_start_date = 'Check type of data required'.
ld_iv_end_date = 'Check type of data required'.
ld_iv_phase = 'Check type of data required'.
ld_iv_bypass_warnings = 'Check type of data required'.
ld_iv_calcstatus_id = 'Check type of data required'.
ld_iv_end_of_process = 'Check type of data required'.
ld_iv_lock_org = 'Check type of data required'.
ld_it_org_samples = 'Check type of data required'.
ld_iv_workload_adjust = 'Check type of data required'.