SAP ABAP Class RS_BCT_PBPC_CONTROLLER (BBPC: Main controller class for planning functions)

Hierarchy

☛ BI_CONT (Software Component) Business Intelligence Content
   ⤷ BW-BCT-PSM (Application Component) Public Sector Management
     ⤷ UPYC_EN (Package) BW: Content BPS for Public Sector Management (English)

Meta Relationship - Using

#	Relationship type	Using	Short Description	Created on
1	Interface implementation (CLASS c. INTERFACES i_ref)	IF_RSPLFA_SRVTYPE_IMP_EXEC_REF	Planning Function Type: Impl. Execution (with Ref. Data)	20051124

Properties

Class	RS_BCT_PBPC_CONTROLLER
Short Description	BBPC: Main controller class for planning functions
Super Class
Instantiability of a Class	2	Public
Final	☐

General Data

Message Class	RSBCT_PBPC
Program status
Category	0
Package	UPYC_EN	BW: Content BPS for Public Sector Management (English)
Created	20051118	SAP
Last change	20141101
Shared Memory-enabled	☐
Fixed point arithmetic	☑
Unicode checks active	☑

Forward declarations

#	Type group / Object type	Type	Type Description
1	ABAP	Type group use (TYPE-POOLS tp)	Type group use (TYPE-POOLS tp)
2	RSD	Type group use (TYPE-POOLS tp)	Type group use (TYPE-POOLS tp)

Interfaces

#	Interface	Abstract	Final	Description	Created on
1	IF_RSPLFA_SRVTYPE_IMP_EXEC_REF	☐	☐	Planning Function Type: Impl. Execution (with Ref. Data)	20051124

Friends

Class RS_BCT_PBPC_CONTROLLER has no friend class.

Attributes

#	Attribute	Level	Visibility	Read only	Typing	Associated Type	Initial Value	Description	Created on
1	CON_DELETE	Constant	Public	☐	Type reference (TYPE)	CHAR1	'D'	Update type = DELETED	20051118
2	CON_ERR_ON_UPDATE_MISSING	Instance attribute	Public	☐	Type reference (TYPE)	RSPBPC_UPDATE_MISSING	'2'	Raise error on update if missing rows for planning update	20051222
3	CON_INSERT	Constant	Public	☐	Type reference (TYPE)	CHAR1	'I'	Update type = INSERTED	20051118
4	CON_INS_ON_UPDATE_MISSING	Instance attribute	Public	☐	Type reference (TYPE)	RSPBPC_UPDATE_MISSING	'1'	Create row on update if missing rows for planning update	20051222
5	CON_NO_ACT_ON_UPDATE_MISSING	Instance attribute	Public	☐	Type reference (TYPE)	RSPBPC_UPDATE_MISSING	'0'	No action on update if missing rows for planning update	20051222
6	CON_ON	Constant	Protected	☐	Type reference (TYPE)	BOOLE_D	'X'	Constant TRUE	20051118
7	CON_PBPCSC_IOBJ	Constant	Public	☐	Type reference (TYPE)	RSD_IOBJNM	'0PSM_PBPCSC'	Infoobject 0PSM_PBPCSC	20080423
8	CON_UPDATE	Constant	Public	☐	Type reference (TYPE)	CHAR1	'U'	Update type = UPDATED	20051118
9	CON_UPDATE_SAME_VALUE	Constant	Public	☐	Type reference (TYPE)	CHAR1	'S'	Update requested but value unchanged	20051205
10	GO_BRF_CONTROLLER	Instance attribute	Protected	☐	Object reference (TYPE REF TO)	IF_CONTROLLER_BRF		BRF Controller	20051118
11	GR_ADD_DATA	Instance attribute	Public	☐	Object reference (TYPE REF TO)	RS_BCT_PBPC_ADD_DATA_SVC		PBPC: Special Data Functions	20080423
12	GR_BADI	Instance attribute	Protected	☐	Object reference (TYPE REF TO)	RSBCT_PBPC_BADI_CTRL		BAdI instance	20051216
13	GR_SCEN_PROVIDER	Instance attribute	Public	☐	Object reference (TYPE REF TO)	RS_BCT_PBPC_SCEN_DB		Data provider for scenario config	20051124
14	GR_SUBSET_LINE	Instance attribute	Protected	☐	Object reference (TYPE REF TO)	DATA		One row of subset data for unrestricted value	20051118
15	GR_TH_DATA	Instance attribute	Public	☐	Object reference (TYPE REF TO)	DATA		Reference to ct_th_data	20051209
16	GR_TH_REF	Instance attribute	Public	☐	Object reference (TYPE REF TO)	DATA		Reference to reference data table	20051209
17	GR_TH_SUBSET	Instance attribute	Protected	☐	Object reference (TYPE REF TO)	DATA		Subset of TH data	20051118
18	GR_TH_SUBSET_ORIG	Instance attribute	Protected	☐	Object reference (TYPE REF TO)	DATA		Subset data before BRF	20051118
19	GT_FIELD_LIST	Instance attribute	Protected	☐	Type reference (TYPE)	RSBCT_PBPC_T_TH_FIELD		List of fields for flat structure processing	20051209
20	GT_KEYFNM	Instance attribute	Protected	☐	Type reference (TYPE)	RSPLF_T_KEYFNM		List of key figures of the infoprovider	20051208
21	GT_MESSAGES	Instance attribute	Protected	☐	Type reference (TYPE)	RSPLF_T_MSG		Message table	20051209
22	GT_PBPC_EVENT	Instance attribute	Protected	☐	Type reference (TYPE)	TY_PBPC_EVENT_TAB		List/references of BRF events to call	20051213
23	G_BRF_APPLCLASS	Instance attribute	Protected	☐	Type reference (TYPE)	BRF_APPLCLASS		BRF Application Group	20051118
24	G_CALC_VARIANT	Instance attribute	Public	☐	Type reference (TYPE)	RSPBPC_CALC_VARIANT		Calculation variant for PBPC	20051125
25	G_CALYEAR_FROM	Instance attribute	Protected	☐	Type reference (TYPE)	RSCALYEAR		Planning function parameter value	20051130
26	G_CNT	Instance attribute	Private	☐	Type reference (TYPE)	INT4		Natural number	20080423
27	G_HAS_REFERENCE_DATA	Instance attribute	Protected	☐	Type reference (TYPE)	BOOLE_D		Indicator: planning function has reference data	20051130
28	G_INFOPROV	Instance attribute	Protected	☐	Type reference (TYPE)	RSINFOPROV		Infoprovider for the planning function	20051128
29	G_MSG_DUMMY	Instance attribute	Protected	☐	Type reference (TYPE)	CHAR100		For MESSAGE .... INTO	20051118
30	G_PBPCSC_EXIST	Instance attribute	Private	☐	Type reference (TYPE)	ABAP_BOOL		Infoobject 0PSM_PBPCSC exist in planning cube	20080423
31	G_RFC_CALL	Instance attribute	Public	☐	Type reference (TYPE)	BOOLE_D		Flag: called by parallel processing	20051209
32	G_RFC_TASKS_RCVD	Instance attribute	Private	☐	Type reference (TYPE)	INT4		Nbr of completed RFC tasks	20051209
33	G_SCEN_ID	Instance attribute	Public	☐	Type reference (TYPE)	RSPBPC_SCEN_ID		PBPC Scenario ID	20051124
34	G_TRACE_START_TIME	Instance attribute	Protected	☐	Type reference (TYPE)	TIMESTAMPL		Start of INIT_EXECUTION	20051223

Methods

#	Method	Level	Visibility	Method type	Description	Created on
1	ADD_MSG	Instance method	Public	Method	Add message from system data	20051209
2	CALCULATE_FROM_RFC	Instance method	Public	Method	Run calculation from RFC function call	20051209
3	CALL_RFC_TASK	Instance method	Protected	Method	Execute the call for a parallel processing batch	20051212
4	CONVERT_FLAT_ROW_TO_TH	Static method	Public	Method	Convert one TH row to a string for RFC processing	20051209
5	CONVERT_TH_ROW_TO_FLAT	Static method	Public	Method	Convert one TH row to a string for RFC processing	20051209
6	CREATE_FIELD_LIST_TAB	Instance method	Protected	Method	Create list of fields in flat structure for RFC	20051209
7	CREATE_SUBSET_ITAB	Instance method	Protected	Method	Create dynamic data references for planning data	20051118
8	DO_CALCULATION	Instance method	Protected	Method	Perform the calculation	20051209
9	GET_BRF_CONTROLLER	Instance method	Public	Method	Get BRF controller	20080423
10	GET_BRF_CONTROLLER_EVENT	Instance method	Protected	Method	Instantiate BRF Controller and Event objects	20051118
11	GET_SUBSET_TABLE_REF	Instance method	Public	Method	Get reference to subset data table	20051118
12	GET_UNRESTRICTED_VALUE	Instance method	Public	Method	Get line of subset data for unrestricted values	20051118
13	LOAD_TH_FROM_FLAT	Instance method	Protected	Method	Write TH data to flat string for RFC processing	20051209
14	PROCESS_SUBSET	Instance method	Protected	Method	Process a data subset through BRF	20051118
15	RECEIVE_RFC_RESULT	Instance method	Public	Method	Receive result from asynch RFC call	20051209
16	UPDATE_SUBSET_ROW	Instance method	Public	Method	Update one row of subset data	20051205
17	UPDATE_SUBSET_TABLE	Instance method	Public	Method	Update subset table with values from BRF processing	20051129
18	WRITE_TH_TO_FLAT	Instance method	Protected	Method	Write TH data to flat string for RFC processing	20051209

Events

Class RS_BCT_PBPC_CONTROLLER has no event.

Types

#	Type	Visibility	Typing	Associated Type	Description	Created on	Type Source
1	TY_PBPC_EVENT	Protected	See coding			20051213	BEGIN OF ty_pbpc_event, event TYPE brf_event, r_event TYPE REF TO cl_event_base_brf, END OF ty_pbpc_event
2	TY_PBPC_EVENT_TAB	Protected	See coding			20051213	ty_pbpc_event_tab TYPE STANDARD TABLE OF ty_pbpc_event

Method Signatures

Method ADD_MSG Signature

Method ADD_MSG on class RS_BCT_PBPC_CONTROLLER has no parameter.
Method ADD_MSG on class RS_BCT_PBPC_CONTROLLER has no exception.

Method CALCULATE_FROM_RFC Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Changing	C_TH_DATA	Call by reference	☐	Type reference (TYPE)	HASHED TABLE		Planning data	20051209
2	Exporting	ET_MESSAGES	Call by reference	☐	Type reference (TYPE)	RSPLF_T_MSG		Messages issued while processing	20051209
3	Importing	IT_KEYFNM	Call by reference	☐	Type reference (TYPE)	RSPLF_T_KEYFNM		Table of Key Figures	20051209
4	Importing	IT_SORT_FIELDS	Call by reference	☐	Type reference (TYPE)	ABAP_SORTORDER_TAB		Table for SORT itab BY (ABAP_SORTORDER_TAB)	20051209
5	Importing	I_BRF_APPLCLASS	Call by reference	☐	Type reference (TYPE)	BRF_APPLCLASS		BRF: Application Class	20051209
6	Importing	I_CALC_VARIANT	Call by reference	☐	Type reference (TYPE)	RSPBPC_CALC_VARIANT		Calculation variant for PBPC	20051209
7	Importing	I_SCEN_ID	Call by reference	☐	Type reference (TYPE)	RSPBPC_SCEN_ID		Personnel Budget Calculator Scenario ID	20051209

Method CALCULATE_FROM_RFC on class RS_BCT_PBPC_CONTROLLER has no exception.

Method CALL_RFC_TASK Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Changing	CT_TH_SUBSET	Call by reference	☐	Type reference (TYPE)	STANDARD TABLE		Subset of data to process in task	20051212
2	Changing	C_SENT_TASKS	Call by reference	☐	Type reference (TYPE)	INT4		Natural number	20051212
3	Importing	IT_SORT_FIELDS	Call by reference	☐	Type reference (TYPE)	ABAP_SORTORDER_TAB		Table for SORT itab BY (ABAP_SORTORDER_TAB)	20051212

#	Exception	Resumable	Description	Created on
1	RFC_ERROR	☐	Failed to start RFC tast	20051212

Method CONVERT_FLAT_ROW_TO_TH Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Exporting	E_IS_REF_DATA	Call by reference	☐	Type reference (TYPE)	BOOLE_D		Did this row come from reference data?	20051212
2	Exporting	E_TH	Call by reference	☐	Type reference (TYPE)	ANY		Data in regular TH structure	20051209
3	Importing	IT_FIELDS	Call by reference	☐	Type reference (TYPE)	RSBCT_PBPC_T_TH_FIELD		List of fields in TH	20051209
4	Importing	I_STRING	Call by reference	☐	Type reference (TYPE)	STRING		Data as a flat string	20051209

Method CONVERT_FLAT_ROW_TO_TH on class RS_BCT_PBPC_CONTROLLER has no exception.

Method CONVERT_TH_ROW_TO_FLAT Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Exporting	E_STRING	Call by reference	☐	Type reference (TYPE)	STRING			20051209
2	Importing	IT_FIELDS	Call by reference	☐	Type reference (TYPE)	RSBCT_PBPC_T_TH_FIELD		List of fields in TH	20051209
3	Importing	I_TH	Call by reference	☐	Type reference (TYPE)	ANY			20051209

Method CONVERT_TH_ROW_TO_FLAT on class RS_BCT_PBPC_CONTROLLER has no exception.

Method CREATE_FIELD_LIST_TAB Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	IT_TH_COMBINED	Call by reference	☐	Type reference (TYPE)	STANDARD TABLE			20051209

Method CREATE_FIELD_LIST_TAB on class RS_BCT_PBPC_CONTROLLER has no exception.

Method CREATE_SUBSET_ITAB Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	I_TH_DATA	Call by reference	☐	Type reference (TYPE)	HASHED TABLE		Data passed to planning function	20051118

Method CREATE_SUBSET_ITAB on class RS_BCT_PBPC_CONTROLLER has no exception.

Method DO_CALCULATION Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Changing	C_TH_DATA	Call by reference	☐	Type reference (TYPE)	HASHED TABLE		Planning data	20051209
2	Importing	IT_SORT_FIELDS	Call by reference	☐	Type reference (TYPE)	ABAP_SORTORDER_TAB		Table for SORT itab BY (ABAP_SORTORDER_TAB)	20051209
3	Importing	IT_TH_COMBINED	Call by reference	☐	Type reference (TYPE)	STANDARD TABLE		Combined reference and TH data	20051209

Method DO_CALCULATION on class RS_BCT_PBPC_CONTROLLER has no exception.

Method GET_BRF_CONTROLLER Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Returning	RE_BRF_CONTROLLER	Value transfer	☐	Object reference (TYPE REF TO)	IF_CONTROLLER_BRF		BRF: Controller	20080423

Method GET_BRF_CONTROLLER on class RS_BCT_PBPC_CONTROLLER has no exception.

Method GET_BRF_CONTROLLER_EVENT Signature

Method GET_BRF_CONTROLLER_EVENT on class RS_BCT_PBPC_CONTROLLER has no parameter.
Method GET_BRF_CONTROLLER_EVENT on class RS_BCT_PBPC_CONTROLLER has no exception.

Method GET_SUBSET_TABLE_REF Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Returning	ER_SUBSET	Value transfer	☐	Object reference (TYPE REF TO)	DATA		Subset data table reference	20051118
2	Importing	IR_EVENT	Call by reference	☐	Object reference (TYPE REF TO)	IF_EVENT_BRF		BRF Event	20051118

Method GET_SUBSET_TABLE_REF on class RS_BCT_PBPC_CONTROLLER has no exception.

Method GET_UNRESTRICTED_VALUE Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Exporting	ER_DATA	Call by reference	☐	Type reference (TYPE)	ANY		Unrestricted values line	20051118
2	Importing	IR_EVENT	Call by reference	☐	Object reference (TYPE REF TO)	IF_EVENT_BRF		BRF Event	20051118

Method GET_UNRESTRICTED_VALUE on class RS_BCT_PBPC_CONTROLLER has no exception.

Method LOAD_TH_FROM_FLAT Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Exporting	ET_TH_DATA	Call by reference	☐	Type reference (TYPE)	HASHED TABLE		TH Data	20051209
2	Importing	IT_TH_STRING	Call by reference	☐	Type reference (TYPE)	RSBCT_PBPC_T_STRING		TH Data as table of strings	20051209

Method LOAD_TH_FROM_FLAT on class RS_BCT_PBPC_CONTROLLER has no exception.

Method PROCESS_SUBSET Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Changing	C_TH_DATA	Call by reference	☐	Type reference (TYPE)	HASHED TABLE		Data passed to planning function	20051118

#	Exception	Resumable	Description	Created on
1	BRF_ERROR	☐	Error during BRF processing	20051125

Method RECEIVE_RFC_RESULT Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	P_TASK	Call by reference	☐	Type reference (TYPE)	CLIKE			20051209

Method RECEIVE_RFC_RESULT on class RS_BCT_PBPC_CONTROLLER has no exception.

Method UPDATE_SUBSET_ROW Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Changing	C_CHA_CHANGED	Call by reference	☐	Type reference (TYPE)	BOOLE_D		Change in Characteristic value?	20051223
2	Changing	C_KF_CHANGED	Call by reference	☐	Type reference (TYPE)	BOOLE_D		Change in Key Figure value?	20051223
3	Changing	C_SUBSET	Call by reference	☐	Type reference (TYPE)	ANY		Subset table line	20051223
4	Importing	I_IS_KEYFIGURE	Call by reference	☐	Type reference (TYPE)	BOOLE_D		Is the infoobject a Key Figure	20051205
5	Importing	I_IS_NEW_ROW	Call by reference	☐	Type reference (TYPE)	BOOLE_D		Are we inserting a new row	20051222
6	Importing	I_NEW_VALUE	Call by reference	☐	Type reference (TYPE)	ANY		Value calculated by BRF	20051205
7	Importing	I_TARGET_IOBJNM	Call by reference	☐	Type reference (TYPE)	RSIOBJNM		InfoObject	20051205

#	Exception	Resumable	Description	Created on
1	INVALID_TARGET_FIELD	☐	Infoobject to update does not exist	20051223

Method UPDATE_SUBSET_TABLE Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	IT_EXPRESSIONS	Call by reference	☐	Type reference (TYPE)	RSBCT_PBPC_APRM_RUNTIME_T		Update target/value expressions	20051129
2	Importing	I_RESTRICT_EXPR	Call by reference	☐	Type reference (TYPE)	RSBCT_PBPC_APRM_RESULT		Expression data for restrction expression	20051222
3	Importing	I_UPDATE_SETTINGS	Call by reference	☐	Type reference (TYPE)	RSBCT_PBPC_AUPD		Update Action settings for BRF	20051222

#	Exception	Resumable	Description	Created on
1	ERROR_INSERT_NOT_ALLOWED	☐	Action definition requests error when row does not exist	20051223
2	INVALID_PARAMETERS	☐	Invalid parameter values	20051129

Method WRITE_TH_TO_FLAT Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Exporting	ET_TH_STRING	Call by reference	☐	Type reference (TYPE)	RSBCT_PBPC_T_STRING		TH data in string table	20051209
2	Importing	IT_TH_COMBINED	Call by reference	☐	Type reference (TYPE)	STANDARD TABLE		Input itab in normal structure	20051209

Method WRITE_TH_TO_FLAT on class RS_BCT_PBPC_CONTROLLER has no exception.

History

Last changed by/on	SAP	20141101
SAP Release Created in	703