SAP ABAP Class /RPM/CL_KPI_API (KPI Calculation API)
Hierarchy
CPRXRPM (Software Component) SAP Portfolio and Project Management 6.0
   PPM-PFM (Application Component) Portfolio Management
     /RPM/UI_LOGIC (Package) RPM UI Logic for ABAP WD
Properties
Class /RPM/CL_KPI_API  
Short Description KPI Calculation API    
Super Class    
Instantiability of a Class 2  Public 
Final    
General Data
Message Class    
Program status     
Category 0   
Package /RPM/UI_LOGIC   RPM UI Logic for ABAP WD 
Created 20130227   SAP 
Last change 20141109    
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)
Interfaces
Class /RPM/CL_KPI_API has no interface implemented.
Friends
Class /RPM/CL_KPI_API has no friend class.
Attributes
# Attribute Level Visibility Read only Typing Associated Type Initial Value Description Created on
1 MS_DATES Instance attribute Private Type reference (TYPE) TY_S_DATES Relevant time period 20130228
2 MS_FIN_KPI Instance attribute Private Type reference (TYPE) /RPM/TS_FIN_KPI Financial KPIs 20130411
3 MS_ITEM_D_API Instance attribute Private Type reference (TYPE) /RPM/TS_ITEM_D_API Portfolio Item Attributes; external 20130227
4 MTH_Q_RATES_CUM Instance attribute Private Type reference (TYPE) TY_TH_PERIOD_Q_RATE Cumulative q rates 20130228
5 MT_CASHFLOW_COST Instance attribute Private Type reference (TYPE) /RPM/TT_FIN_PLAN_SUM Cashflow: Cost only 20130515
6 MT_CASHFLOW_NET Instance attribute Private Type reference (TYPE) /RPM/TT_FIN_PLAN_SUM Cashflow: Net 20130515
7 MT_CASHFLOW_REVENUE Instance attribute Private Type reference (TYPE) /RPM/TT_FIN_PLAN_SUM Cashflow: Revenue only 20130515
8 MT_FIN_PLAN Instance attribute Private Type reference (TYPE) /RPM/TT_FIN_PLAN_SUM Financial Planning Total 20130227
9 MT_FIN_VIEWMAP Instance attribute Private Type reference (TYPE) /RPM/TT_FIN_VIEWMAP Portfolio type and Financial view mapping 20130227
10 MT_FIN_VIEWS Instance attribute Private Type reference (TYPE) /RPM/TT_FIN_VIEWS Financial Planning View Types 20130227
11 MT_INTEREST_RATES Instance attribute Private Type reference (TYPE) /RPM/TT_INTEREST_RATES Reference Interest Rates 20130228
12 MT_Q_RATES Instance attribute Private Type reference (TYPE) TY_T_Q_RATE Q rates 20130228
13 MV_CALCULATION_SCOPE Instance attribute Private Type reference (TYPE) /RPM/TV_KPI_CALCULATION_SCOPE KPI Calculation Scope 20130325
14 MV_CALC_ENV_IS_SET Instance attribute Private Type reference (TYPE) BOOLE_D Fin KPI Environment has been set 20130325
15 MV_DISCOUNT_AT_END_OF_PERIOD Instance attribute Private Type reference (TYPE) BOOLE_D Discount with ref to end of period ("nachschüssig") 20130313
16 MV_FY_ACTIVE Instance attribute Private Type reference (TYPE) BOOLE_D Fiscal Year is active 20130312
17 MV_FY_VARIANT Instance attribute Private Type reference (TYPE) PERIV Fiscal Year Variant 20130312
18 MV_INTEREST_FREQUENCY Instance attribute Private Type reference (TYPE) TFM_AMMRHYZV Interest Settlement Frequency for Exponential Interest Calc. 20130312
19 MV_OBJECT_TYPE Instance attribute Private Type reference (TYPE) /RPM/OBJECT_TYPE Object Type 20130227
20 MV_PORTFOLIO_TYPE Instance attribute Private Type reference (TYPE) /RPM/TV_PORTFOLIO Portfolio Type 20130227
21 SR_INSTANCE Static Attribute Private Object reference (TYPE REF TO) /RPM/CL_KPI_API Calculate KPI 20130227
22 SV_INFINITE_VALUE Static Attribute Private Type reference (TYPE) NUM6 999999 IRR, Payback: Initite value 20130325
23 SV_IRATE_TYPE_IRR Static Attribute Private Type reference (TYPE) REFERENZ 'RPM_IRR' Interest Rate Type: IRR Calculation 20130324
24 SV_IRATE_TYPE_NPV Static Attribute Private Type reference (TYPE) REFERENZ Interest Rate Type: NPV Calculation 20130324
25 SV_IRR_ACCURACY Static Attribute Private Type reference (TYPE) NUMC5 1000 IRR calculation: Accuracy 20130325
26 SV_IRR_MAXNO_ITERATIONS Static Attribute Private Type reference (TYPE) NUMC5 1000 IRR calculation: Maximum Number of Iterations 20130325
27 SV_SWITCH_CALCULATE_KPI Static Attribute Private Type reference (TYPE) BOOLE_D Execute the KPI calculation at all 20130325
Methods
# Method Level Visibility Method type Description Created on
1 CALCULATE_ECV Instance method Private Method Calculate Expected Commercial Value 20130306
2 CALCULATE_FIN_KPI Instance method Public Method Calculate Financial KPI 20130227
3 CALCULATE_IRR Instance method Private Method Calculate Internal Rate of Return 20130306
4 CALCULATE_NPV Instance method Private Method Calculate Net Present Value 20130228
5 CALCULATE_PAYBACK Instance method Private Method Calculate Payback Period 20130320
6 CALCULATE_ROI Instance method Private Method Calculate Return on Investment 20130306
7 CLASS_CONSTRUCTOR Static method Public Constructor CLASS_CONSTRUCTOR (Get global customizing...) 20130324
8 CONSTRUCTOR Instance method Public Constructor CONSTRUCTOR 20130324
9 DISCOUNT_CASHFLOW Instance method Private Method Discount given cashflow 20130313
10 FILTER_FIN_VIEWS_AND_PLAN Instance method Private Method Filter financial views and planning data 20130227
11 FREE_INSTANCE Instance method Public Method Free instance 20130517
12 GET_CALCULATION_SCOPE Instance method Private Method Get calculation scope 20130515
13 GET_DATES Instance method Private Method Get relevant date info 20130228
14 GET_FIN_KPI Instance method Private Method Return financial KPIs 20130227
15 GET_FIN_PLAN Instance method Private Method Get financial plan data 20130227
16 GET_FIN_VIEWMAP Instance method Private Method Get financial views mapped to portfolio type 20130227
17 GET_FIN_VIEWS Instance method Private Method Get financial views 20130227
18 GET_FY_VARIANT Instance method Private Method Get fiscal year variant settings 20130312
19 GET_INSTANCE Static method Public Method Get instance 20130227
20 GET_INTEREST_RATES Instance method Private Method Get interest rates 20130227
21 GET_ITEM_DETAILS Instance method Private Method Get item detail data 20130227
22 GET_OBJECT_TYPE Instance method Private Method Get object type 20130227
23 GET_PORTFOLIO_TYPE Instance method Private Method Get portfolio type 20130227
24 GET_Q_RATES Instance method Private Method Get q rates (q = 1 + 1) 20130228
25 IS_CALCULATION_ENVIRONMENT_SET Instance method Private Method Environment is set successfully 20130325
26 IS_CALCULATION_POSSIBLE Instance method Private Method Is calculation of KPI possible (e.g. missing start date)? 20130325
27 SET_CALCULATION_ENVIRONMENT Instance method Private Method Set processing environment for calculation 20130325
28 SET_CALCULATION_SCOPE Instance method Private Method Set calculation scope 20130325
29 SET_COMPOUND_INTEREST_FREQ Instance method Private Method Set compound interest settlement frequency 20130312
30 SET_CUMULATED_Q_RATES Instance method Private Method Set cumulated q rates per period 20130313
31 SET_FIN_KPI Instance method Private Method Set calculated KPIs 20130313
32 SET_Q_RATE Instance method Private Method Set specific q rate (q = 1 + i) 20130313
33 SPLIT_FIN_PLAN_INTO_CASHFLOWS Instance method Private Method Split fin plan into cashflows by amount type 20130313
Events
Class /RPM/CL_KPI_API has no event.
Types
# Type Visibility Typing Associated Type Description Created on Type Source
1 TY_S_DATES Private See coding 20130228 BEGIN OF ty_s_dates, planned_start TYPE rpm_tv_plan_start, planned_finish TYPE rpm_tv_plan_finish, actual_start TYPE rpm_tv_actual_start, actual_finish TYPE rpm_tv_actual_finish, forecast_start TYPE rpm_tv_forecast_start, forecast_finish TYPE rpm_tv_forecast_finish, forecast_cutoff TYPE rpm_tv_forecast_start, END OF ty_s_dates
2 TY_S_PERIOD_Q_RATE Private See coding 20130228 BEGIN OF ty_s_period_q_rate, rate_type TYPE referenz, period TYPE /rpm/tv_period, "q_start TYPE /rpm/tv_dec_26_8, "q_current TYPE /rpm/tv_dec_26_8, "q_finish TYPE /rpm/tv_dec_26_8, q_start TYPE f, q_current TYPE f, q_finish TYPE f, END OF ty_s_period_q_rate
3 TY_S_Q_RATE Private See coding 20130228 BEGIN OF ty_s_q_rate, rate_type TYPE referenz, period TYPE begda, q_fraction TYPE /rpm/tv_dec_26_8, END OF ty_s_q_rate
4 TY_TH_PERIOD_Q_RATE Private See coding 20130228 ty_th_period_q_rate TYPE HASHED TABLE OF ty_s_period_q_rate WITH UNIQUE KEY rate_type period
5 TY_T_Q_RATE Private See coding 20130228 ty_t_q_rate TYPE STANDARD TABLE OF ty_s_q_rate
Method Signatures

Method CALCULATE_ECV Signature

Method CALCULATE_ECV on class /RPM/CL_KPI_API has no parameter.
Method CALCULATE_ECV on class /RPM/CL_KPI_API has no exception.

Method CALCULATE_FIN_KPI Signature

# Type Parameter Pass Value Optional Typing Method Associated Type Default value Description Created on
1 Exporting ES_FIN_KPI Call by reference Type reference (TYPE) /RPM/TS_FIN_KPI Calculate KPI 20130227
2 Importing IS_ITEM_D_API Call by reference Type reference (TYPE) /RPM/TS_ITEM_D_API Portfolio Item Attributes; external 20130227
3 Importing IT_FIN_PLAN Call by reference Type reference (TYPE) /RPM/TT_FIN_PLAN_SUM Financial Planning Total 20130227
4 Importing IV_ITEM_DETAIL_GUID Call by reference Type reference (TYPE) /RPM/TV_GUID Guid for application objects 20130227

Method CALCULATE_FIN_KPI on class /RPM/CL_KPI_API has no exception.

Method CALCULATE_IRR Signature

Method CALCULATE_IRR on class /RPM/CL_KPI_API has no parameter.
Method CALCULATE_IRR on class /RPM/CL_KPI_API has no exception.

Method CALCULATE_NPV Signature

Method CALCULATE_NPV on class /RPM/CL_KPI_API has no parameter.
Method CALCULATE_NPV on class /RPM/CL_KPI_API has no exception.

Method CALCULATE_PAYBACK Signature

Method CALCULATE_PAYBACK on class /RPM/CL_KPI_API has no parameter.
Method CALCULATE_PAYBACK on class /RPM/CL_KPI_API has no exception.

Method CALCULATE_ROI Signature

Method CALCULATE_ROI on class /RPM/CL_KPI_API has no parameter.
Method CALCULATE_ROI on class /RPM/CL_KPI_API has no exception.

Method CLASS_CONSTRUCTOR Signature

Method CLASS_CONSTRUCTOR on class /RPM/CL_KPI_API has no parameter.
Method CLASS_CONSTRUCTOR on class /RPM/CL_KPI_API has no exception.

Method CONSTRUCTOR Signature

Method CONSTRUCTOR on class /RPM/CL_KPI_API has no parameter.
Method CONSTRUCTOR on class /RPM/CL_KPI_API has no exception.

Method DISCOUNT_CASHFLOW Signature

# Type Parameter Pass Value Optional Typing Method Associated Type Default value Description Created on
1 Importing IT_CASHFLOW Call by reference Type reference (TYPE) /RPM/TT_FIN_PLAN_SUM Cashflow 20130313
2 Importing IV_IRATE_TYPE Call by reference Type reference (TYPE) REFERENZ Reference Interest Rate 20130411
3 Returning RV_TOTAL Value transfer Type reference (TYPE) /RPM/TV_DEC_26_8 Total value 20130313

Method DISCOUNT_CASHFLOW on class /RPM/CL_KPI_API has no exception.

Method FILTER_FIN_VIEWS_AND_PLAN Signature

Method FILTER_FIN_VIEWS_AND_PLAN on class /RPM/CL_KPI_API has no parameter.
Method FILTER_FIN_VIEWS_AND_PLAN on class /RPM/CL_KPI_API has no exception.

Method FREE_INSTANCE Signature

# Type Parameter Pass Value Optional Typing Method Associated Type Default value Description Created on
1 Importing IV_ALL Call by reference Type reference (TYPE) BOOLE_D ABAP_TRUE Clear all instances 20130517

Method FREE_INSTANCE on class /RPM/CL_KPI_API has no exception.

Method GET_CALCULATION_SCOPE Signature

# Type Parameter Pass Value Optional Typing Method Associated Type Default value Description Created on
1 Returning RV_CALCULATION_SCOPE Value transfer Type reference (TYPE) /RPM/TV_KPI_CALCULATION_SCOPE KPI Calculation Scope 20130515

Method GET_CALCULATION_SCOPE on class /RPM/CL_KPI_API has no exception.

Method GET_DATES Signature

# Type Parameter Pass Value Optional Typing Method Associated Type Default value Description Created on
1 Returning RS_DATES Value transfer Type reference (TYPE) TY_S_DATES Dates relevant for calculation 20130228

Method GET_DATES on class /RPM/CL_KPI_API has no exception.

Method GET_FIN_KPI Signature

# Type Parameter Pass Value Optional Typing Method Associated Type Default value Description Created on
1 Returning RS_FIN_KPI Value transfer Type reference (TYPE) /RPM/TS_FIN_KPI Financial KPIs 20130227

Method GET_FIN_KPI on class /RPM/CL_KPI_API has no exception.

Method GET_FIN_PLAN Signature

# Type Parameter Pass Value Optional Typing Method Associated Type Default value Description Created on
1 Importing IT_FIN_PLAN Call by reference Type reference (TYPE) /RPM/TT_FIN_PLAN_SUM Financial Planning Total 20130227
2 Returning RT_FIN_PLAN Value transfer Type reference (TYPE) /RPM/TT_FIN_PLAN_SUM Financial Planning Total 20130227

Method GET_FIN_PLAN on class /RPM/CL_KPI_API has no exception.

Method GET_FIN_VIEWMAP Signature

# Type Parameter Pass Value Optional Typing Method Associated Type Default value Description Created on
1 Returning RT_FIN_VIEWMAP Value transfer Type reference (TYPE) /RPM/TT_FIN_VIEWMAP Porrtfolio type and Financial view mapping 20130227

Method GET_FIN_VIEWMAP on class /RPM/CL_KPI_API has no exception.

Method GET_FIN_VIEWS Signature

# Type Parameter Pass Value Optional Typing Method Associated Type Default value Description Created on
1 Returning RT_FIN_VIEWS Value transfer Type reference (TYPE) /RPM/TT_FIN_VIEWS Financial Planning View Types 20130227

Method GET_FIN_VIEWS on class /RPM/CL_KPI_API has no exception.

Method GET_FY_VARIANT Signature

# Type Parameter Pass Value Optional Typing Method Associated Type Default value Description Created on
1 Exporting EV_FY_ACTIVE Call by reference Type reference (TYPE) BOOLE_D Fiscal Year Variant Active 20130312
2 Exporting EV_FY_VARIANT Call by reference Type reference (TYPE) PERIV Fiscal Year Variant 20130312

Method GET_FY_VARIANT on class /RPM/CL_KPI_API has no exception.

Method GET_INSTANCE Signature

# Type Parameter Pass Value Optional Typing Method Associated Type Default value Description Created on
1 Returning RR_INSTANCE Value transfer Object reference (TYPE REF TO) /RPM/CL_KPI_API Calculate KPI 20130227

Method GET_INSTANCE on class /RPM/CL_KPI_API has no exception.

Method GET_INTEREST_RATES Signature

# Type Parameter Pass Value Optional Typing Method Associated Type Default value Description Created on
1 Returning RT_INTEREST_RATES Value transfer Type reference (TYPE) /RPM/TT_INTEREST_RATES Reference Interest Rates 20130227

Method GET_INTEREST_RATES on class /RPM/CL_KPI_API has no exception.

Method GET_ITEM_DETAILS Signature

# Type Parameter Pass Value Optional Typing Method Associated Type Default value Description Created on
1 Importing IS_ITEM_D_API Call by reference Type reference (TYPE) /RPM/TS_ITEM_D_API Portfolio Item Attributes; external 20130227
2 Importing IV_ITEM_DETAIL_GUID Call by reference Type reference (TYPE) /RPM/TV_GUID Guid for application objects 20130227
3 Returning RS_ITEM_D_API Value transfer Type reference (TYPE) /RPM/TS_ITEM_D_API Portfolio Item Attributes; external 20130227

Method GET_ITEM_DETAILS on class /RPM/CL_KPI_API has no exception.

Method GET_OBJECT_TYPE Signature

# Type Parameter Pass Value Optional Typing Method Associated Type Default value Description Created on
1 Returning RV_OBJECT_TYPE Value transfer Type reference (TYPE) /RPM/OBJECT_TYPE Object type 20130227

Method GET_OBJECT_TYPE on class /RPM/CL_KPI_API has no exception.

Method GET_PORTFOLIO_TYPE Signature

# Type Parameter Pass Value Optional Typing Method Associated Type Default value Description Created on
1 Returning RV_PORTFOLIO_TYPE Value transfer Type reference (TYPE) /RPM/TV_PORTFOLIO Portfolio Type 20130227

Method GET_PORTFOLIO_TYPE on class /RPM/CL_KPI_API has no exception.

Method GET_Q_RATES Signature

# Type Parameter Pass Value Optional Typing Method Associated Type Default value Description Created on
1 Exporting ET_Q_RATES Value transfer Type reference (TYPE) TY_T_Q_RATE 20130228

Method GET_Q_RATES on class /RPM/CL_KPI_API has no exception.

Method IS_CALCULATION_ENVIRONMENT_SET Signature

# Type Parameter Pass Value Optional Typing Method Associated Type Default value Description Created on
1 Returning RV_CALC_ENV_IS_SET Value transfer Type reference (TYPE) BOOLE_D Environment is set 20130325

Method IS_CALCULATION_ENVIRONMENT_SET on class /RPM/CL_KPI_API has no exception.

Method IS_CALCULATION_POSSIBLE Signature

# Type Parameter Pass Value Optional Typing Method Associated Type Default value Description Created on
1 Returning RV_CALC_IS_POSSIBLE Value transfer Type reference (TYPE) BOOLE_D Calculation is possible 20130325

Method IS_CALCULATION_POSSIBLE on class /RPM/CL_KPI_API has no exception.

Method SET_CALCULATION_ENVIRONMENT Signature

# Type Parameter Pass Value Optional Typing Method Associated Type Default value Description Created on
1 Importing IS_ITEM_D_API Call by reference Type reference (TYPE) /RPM/TS_ITEM_D_API Portfolio Item Attributes; external 20130325
2 Importing IT_FIN_PLAN Call by reference Type reference (TYPE) /RPM/TT_FIN_PLAN_SUM Financial Planning Total 20130325
3 Importing IV_ITEM_DETAIL_GUID Call by reference Type reference (TYPE) /RPM/TV_GUID Guid for application objects 20130325
4 Returning RV_CALC_ENV_IS_SET Value transfer Type reference (TYPE) BOOLE_D Environment is set successfully 20130325

Method SET_CALCULATION_ENVIRONMENT on class /RPM/CL_KPI_API has no exception.

Method SET_CALCULATION_SCOPE Signature

Method SET_CALCULATION_SCOPE on class /RPM/CL_KPI_API has no parameter.
Method SET_CALCULATION_SCOPE on class /RPM/CL_KPI_API has no exception.

Method SET_COMPOUND_INTEREST_FREQ Signature

Method SET_COMPOUND_INTEREST_FREQ on class /RPM/CL_KPI_API has no parameter.
Method SET_COMPOUND_INTEREST_FREQ on class /RPM/CL_KPI_API has no exception.

Method SET_CUMULATED_Q_RATES Signature

# Type Parameter Pass Value Optional Typing Method Associated Type Default value Description Created on
1 Importing IV_IRATE_TYPE Value transfer Type reference (TYPE) REFERENZ SV_IRATE_TYPE_NPV Reference Interest Rate 20130324

Method SET_CUMULATED_Q_RATES on class /RPM/CL_KPI_API has no exception.

Method SET_FIN_KPI Signature

# Type Parameter Pass Value Optional Typing Method Associated Type Default value Description Created on
1 Importing IS_FIN_KPI Call by reference Type reference (TYPE) /RPM/TS_FIN_KPI Financial KPIs 20130313

Method SET_FIN_KPI on class /RPM/CL_KPI_API has no exception.

Method SET_Q_RATE Signature

# Type Parameter Pass Value Optional Typing Method Associated Type Default value Description Created on
1 Importing IV_I_RATE Call by reference Type reference (TYPE) /RPM/TV_DEC_26_8 Interest Rate 20130313
2 Importing IV_PERIOD Call by reference Type reference (TYPE) BEGDA Start Date 20130313
3 Importing IV_RATE_TYPE Call by reference Type reference (TYPE) REFERENZ Reference Interest Rate 20130313

Method SET_Q_RATE on class /RPM/CL_KPI_API has no exception.

Method SPLIT_FIN_PLAN_INTO_CASHFLOWS Signature

Method SPLIT_FIN_PLAN_INTO_CASHFLOWS on class /RPM/CL_KPI_API has no parameter.
Method SPLIT_FIN_PLAN_INTO_CASHFLOWS on class /RPM/CL_KPI_API has no exception.
History
Last changed by/on SAP  20141109 
SAP Release Created in 600_740