SAP ABAP Class CL_KF_HELPER (Helper Class for Generic Key Figure Monitor)
Hierarchy
SAP_BASIS (Software Component) SAP Basis Component
   BC-MUS-KFM (Application Component) Key Figure Monitor
     GENERIC_KEY_FIGURE_MONITOR (Package) Generic Key Figure Monitor
Properties
Class CL_KF_HELPER  
Short Description Helper Class for Generic Key Figure Monitor    
Super Class    
Instantiability of a Class 2  Public 
Final    
General Data
Message Class    
Program status     
Category 0   
Package GENERIC_KEY_FIGURE_MONITOR   Generic Key Figure Monitor 
Created 20050203   SAP 
Last change 20110908   SAP 
Shared Memory-enabled    
Fixed point arithmetic    
Unicode checks active    
Forward declarations
Class CL_KF_HELPER has no forward declaration.
Interfaces
Class CL_KF_HELPER has no interface implemented.
Friends
# Friend Modeled only Created on Description
1 CL_KF_MONITOR 20050203 Application Class Key Figure Monitor
2 CL_KF_TREND 20050203 Trend Display for Key Figure
Attributes
# Attribute Level Visibility Read only Typing Associated Type Initial Value Description Created on
1 GC_ALERT_IS_RED Constant Public Type reference (TYPE) KFM_KF_ALERT '3' Alert when key figure status 'red' 20050215
2 GC_ALERT_IS_YELLOW Constant Public Type reference (TYPE) KFM_KF_ALERT '5' Alert when key figure status 'yellow' 20050215
3 GC_ALERT_TO_RED Constant Public Type reference (TYPE) KFM_KF_ALERT '2' Alert when key figure status changes to 'red' 20050215
4 GC_ALERT_TO_YELLOW Constant Public Type reference (TYPE) KFM_KF_ALERT '4' Alert when key figure status changes to 'yellow' 20050215
5 GC_COLOR_DOMINATING Constant Public Type reference (TYPE) WDUI_TABLE_CELL_DESIGN '15' WebDynpro:TableCellDesign 20050926
6 GC_COLOR_INVALID Constant Public Type reference (TYPE) WDUI_TABLE_CELL_DESIGN '07' WebDynpro:TableCellDesign 20050926
7 GC_COMMENTS_NO Constant Public Type reference (TYPE) KFM_KF_COMMENT_SETTING '0' Settings for Comments 20050221
8 GC_COMMENTS_PERSONAL Constant Public Type reference (TYPE) KFM_KF_COMMENT_SETTING '1' Settings for Comments 20050221
9 GC_COMMENTS_PUBLIC Constant Public Type reference (TYPE) KFM_KF_COMMENT_SETTING '2' Settings for Comments 20050221
10 GC_COMP_DIFF Constant Public Type reference (TYPE) KFM_CMP_OPERATION '1' Difference for Key Figure Comparison 20050322
11 GC_COMP_PROZ Constant Public Type reference (TYPE) KFM_CMP_OPERATION '2' Difference for Key Figure Comparison in Percent 20050322
12 GC_DIRECTION_BIDIRECTIONAL Constant Public Type reference (TYPE) KFM_KF_DIRECTION '3' Key Figure Direction: Bidirectional 20050203
13 GC_DIRECTION_NEGATIVE Constant Public Type reference (TYPE) KFM_KF_DIRECTION '2' Key Figure Direction: Negative 20050203
14 GC_DIRECTION_POSITIVE Constant Public Type reference (TYPE) KFM_KF_DIRECTION '1' Key Figure Direction: Positive 20050203
15 GC_GROUP_AVERAGE Constant Public Type reference (TYPE) CHAR1 '3' Constants with Value '3' 20050302
16 GC_GROUP_MAXIMUM Constant Public Type reference (TYPE) CHAR1 '5' Constants with Value '5' 20050302
17 GC_GROUP_MINIMUM Constant Public Type reference (TYPE) CHAR1 '4' Constants with Value '4' 20050302
18 GC_GROUP_SUM Constant Public Type reference (TYPE) CHAR1 '2' Constant with Value '2' 20050302
19 GC_GROUP_WORST_STATUS Constant Public Type reference (TYPE) CHAR1 '1' Constant with Value 1 20050302
20 GC_INVISIBLE Constant Public Type reference (TYPE) WDUI_VISIBILITY '01' WD element invisible 20050216
21 GC_KF_NOT_PERSONALIZABLE Constant Public Type reference (TYPE) KFM_KF_PERS_TYPE '0' Indicator: Personalization Type of Key Figure 20050221
22 GC_KF_PERSONALIZABLE Constant Public Type reference (TYPE) KFM_KF_PERS_TYPE '1' Indicator: Personalization Type of Key Figure 20050309
23 GC_NO_ALERT Constant Public Type reference (TYPE) KFM_KF_ALERT '1' No Alert 20050215
24 GC_PERIOD_DAY Constant Public Type reference (TYPE) KFM_PERIOD '2' Period Type for Key Figure 20050310
25 GC_PERIOD_HOUR Constant Public Type reference (TYPE) KFM_PERIOD '1' Period Type for Key Figure 20050310
26 GC_PERIOD_MONTH Constant Public Type reference (TYPE) KFM_PERIOD '4' Period Type for Key Figure 20050310
27 GC_PERIOD_WEEK Constant Public Type reference (TYPE) KFM_PERIOD '3' Period Type for Key Figure 20050310
28 GC_PERIOD_YEAR Constant Public Type reference (TYPE) KFM_PERIOD '5' Period Type for Key Figure 20050310
29 GC_SOURCE_BW Constant Public Type reference (TYPE) KFM_KF_SOURCE_TYPE '2' Source System Type of Key Figure 20050317
30 GC_SOURCE_EXT Constant Public Type reference (TYPE) KFM_KF_SOURCE_TYPE '3' Source System Type of Key Figure 20050317
31 GC_SOURCE_NW_BW Constant Public Type reference (TYPE) KFM_KF_SOURCE_TYPE '4' Source System Type of Key Figure 20091022
32 GC_SOURCE_R3 Constant Public Type reference (TYPE) KFM_KF_SOURCE_TYPE '1' Source System Type of Key Figure 20050317
33 GC_STATUS_GREEN Constant Public Type reference (TYPE) KFM_KF_STATUS '3' Status 'Green' 20050203
34 GC_STATUS_RED Constant Public Type reference (TYPE) KFM_KF_STATUS '1' Status 'Red' 20050203
35 GC_STATUS_UNDEFINED Constant Public Type reference (TYPE) KFM_KF_STATUS '0' Status 'Undefined' 20050203
36 GC_STATUS_YELLOW Constant Public Type reference (TYPE) KFM_KF_STATUS '2' Status 'Yellow' 20050203
37 GC_TREND_CONSTANT Constant Public Type reference (TYPE) KFM_KF_TREND '0' Current Trend of a Key Figure 20060929
38 GC_TREND_DECREASING Constant Public Type reference (TYPE) KFM_KF_TREND '-' Current Trend of a Key Figure 20060929
39 GC_TREND_INCREASING Constant Public Type reference (TYPE) KFM_KF_TREND '+' Current Trend of a Key Figure 20060929
40 GC_TRISTATE_FALSE Constant Public Type reference (TYPE) WDUI_TRI_STATE '02' WebDynpro:TriState 20050920
41 GC_TRISTATE_TRUE Constant Public Type reference (TYPE) WDUI_TRI_STATE '01' WebDynpro:TriState 20050920
42 GC_TRISTATE_UNDECIDED Constant Public Type reference (TYPE) WDUI_TRI_STATE '00' WebDynpro:TriState 20050920
43 GC_TYPE_COMPARE Constant Public Type reference (TYPE) KFM_KF_TYPE '3' Constants 'Key Figure Comparison' with Value '3' 20050207
44 GC_TYPE_GROUP Constant Public Type reference (TYPE) KFM_KF_TYPE '2' Constants 'Key Figure Group' With Value '2' 20050207
45 GC_TYPE_SINGLE Constant Public Type reference (TYPE) KFM_KF_TYPE '1' Constants: ''Simple Key Figure' with Value '1' 20050225
46 GC_VALUE_EPSILON Constant Public Type reference (TYPE) KFM_VALUE '000000000000000.00001' Value of Key Figure 20050610
47 GC_VALUE_MAX Constant Public Type reference (TYPE) KFM_VALUE '999999999999999.99999' Value of Key Figure 20050321
48 GC_VALUE_MIN Constant Public Type reference (TYPE) KFM_VALUE '-999999999999999.99999' Value of Key Figure 20050321
49 GC_VISIBLE Constant Public Type reference (TYPE) WDUI_VISIBILITY '02' WD Element Visible 20050216
Methods
# Method Level Visibility Method type Description Created on
1 CURRENT_TIMESTAMP_GET Static method Public Method Generate Current Time Stamp 20050208
2 GUID_16_CREATE Static method Public Method Return GUID in RAW15 Format 20050207
3 INTERNAL_TABLE_FROM_XML_GET Static method Public Method Read Contents of XML File in Internal Table 20050309
4 KF_DIFFERENCES_COMPUTE Static method Public Method Calculate Absolute and Percentage Difference 20050203
5 KF_PERIOD_GET_SECONDS Static method Public Method 20050713
6 KF_STATUS_DETERMINE Static method Public Method Determine Key Figure Status 20050203
7 KF_STATUS_ICON_TOOLTIP_GET Static method Public Method Returns Icon Name and Tooltip 20050203
8 KF_TIMESTAMP_TO_TEXT Static method Public Method Format Time Stamp in Text 20050203
9 KF_TXT_2_VALUE Static method Public Method Conversion of Prepared Value Acc. to Value 20050920
10 KF_VALIDITY Static method Public Method Calculate Start of Validity Period 20050228
11 KF_VALUE_ROUNDING Static method Public Method 20050928
12 KF_VALUE_TXT Static method Public Method Text-Based Formatting for Numeric Values 20050208
13 RAISE_EXCEPTION Static method Public Method Trigger Exception of Error Class CX_KF_MONITOR 20050228
14 TIMESTAMP_LOCAL_ZONE_2_UTC Static method Public Method "Converted" TIMESTAMP from a Specified Timezone in UTC 20051018
15 TIMESTAMP_UTC_2_LOCAL_ZONE Static method Public Method "Converted" TIMESTAMP from UTC in a Specified Time Zone 20050915
Events
Class CL_KF_HELPER has no event.
Types
Class CL_KF_HELPER has no local type.
Method Signatures

Method CURRENT_TIMESTAMP_GET Signature

# Type Parameter Pass Value Optional Typing Method Associated Type Default value Description Created on
1 Returning R_TIMESTAMP Value transfer Type reference (TYPE) TIMESTAMP UTC-Zeitstempel in Kurzform (JJJJMMTThhmmss) 20050426

Method CURRENT_TIMESTAMP_GET on class CL_KF_HELPER has no exception.

Method GUID_16_CREATE Signature

# Type Parameter Pass Value Optional Typing Method Associated Type Default value Description Created on
1 Returning R_GUID Value transfer Type reference (TYPE) SYSUUID_X UUID in X-Form (binär) 20050216

Method GUID_16_CREATE on class CL_KF_HELPER has no exception.

Method INTERNAL_TABLE_FROM_XML_GET Signature

# Type Parameter Pass Value Optional Typing Method Associated Type Default value Description Created on
1 Changing CS_TABLE_STRUCTURE Call by reference Type reference (TYPE) ANY 20050309
2 Changing CT_TABLE Call by reference Type reference (TYPE) ANY TABLE 20050309
3 Importing I_MIME_URL Call by reference Type reference (TYPE) STRING 20050309
4 Importing I_TABLE_NAME Call by reference Type reference (TYPE) STRING 20050309

Method INTERNAL_TABLE_FROM_XML_GET on class CL_KF_HELPER has no exception.

Method KF_DIFFERENCES_COMPUTE Signature

# Type Parameter Pass Value Optional Typing Method Associated Type Default value Description Created on
1 Changing C_DIFF_ABSOLUTE Call by reference Type reference (TYPE) KFM_VALUE Wert einer Kennzahl 20050203
2 Changing C_DIFF_PERCENTAGE Call by reference Type reference (TYPE) KFM_VALUE Wert einer Kennzahl 20050203
3 Importing I_TARGET Call by reference Type reference (TYPE) KFM_VALUE Wert einer Kennzahl 20050203
4 Importing I_VALUE Call by reference Type reference (TYPE) KFM_VALUE Wert einer Kennzahl 20050203

Method KF_DIFFERENCES_COMPUTE on class CL_KF_HELPER has no exception.

Method KF_PERIOD_GET_SECONDS Signature

# Type Parameter Pass Value Optional Typing Method Associated Type Default value Description Created on
1 Importing I_NUMBER_OF_PERIODS Call by reference Type reference (TYPE) KFM_NUM_PERIODS Anzahl der Perioden (Gültigkeit der Kennzahlenwerte) 20050713
2 Importing I_PERIOD Call by reference Type reference (TYPE) KFM_PERIOD Periodentyp der Kennzahl 20050713
3 Returning R_SECONDS Value transfer Type reference (TYPE) I 20050713

Method KF_PERIOD_GET_SECONDS on class CL_KF_HELPER has no exception.

Method KF_STATUS_DETERMINE Signature

# Type Parameter Pass Value Optional Typing Method Associated Type Default value Description Created on
1 Changing C_STATUS Call by reference Type reference (TYPE) KFM_KF_STATUS Aktueller Status einer Kennzahl 20050203
2 Changing C_STATUS_ICON Call by reference Type reference (TYPE) KFM_KF_STATUS_ICON Ikone aktueller Status einer Kennzahl 20050203
3 Changing C_STATUS_TOOLTIP Call by reference Type reference (TYPE) KFM_KF_STATUS_TOOLTIP Tooltip aktueller Status einer Kennzahl 20050203
4 Importing I_DIRECTION Call by reference Type reference (TYPE) KFM_KF_DIRECTION Ausrichtung einer Kennzahl 20050203
5 Importing I_G2YGATE Call by reference Type reference (TYPE) KFM_G2YGATE_VAL grün->gelb Schwellenwert der Kennzahl 20050203
6 Importing I_R2YGATE Call by reference Type reference (TYPE) KFM_R2YGATE_VAL Rot->Gelb Schwellenwert der Kennzahl 20050203
7 Importing I_VALUE Call by reference Type reference (TYPE) KFM_VALUE Wert einer Kennzahl 20050203
8 Importing I_Y2GGATE Call by reference Type reference (TYPE) KFM_Y2GGATE_VAL Gelb->Grün Schwellenwert der Kennzahl 20050203
9 Importing I_Y2RGATE Call by reference Type reference (TYPE) KFM_Y2RGATE_VAL gelb->rot Schwellenwert der Kennzahl 20050203

Method KF_STATUS_DETERMINE on class CL_KF_HELPER has no exception.

Method KF_STATUS_ICON_TOOLTIP_GET Signature

# Type Parameter Pass Value Optional Typing Method Associated Type Default value Description Created on
1 Changing C_STATUS_ICON Call by reference Type reference (TYPE) KFM_KF_STATUS_ICON Ikone aktueller Status einer Kennzahl 20050203
2 Changing C_STATUS_TOOLTIP Call by reference Type reference (TYPE) KFM_KF_STATUS_TOOLTIP Tooltip aktueller Status einer Kennzahl 20050203
3 Importing I_STATUS Call by reference Type reference (TYPE) KFM_KF_STATUS Aktueller Status einer Kennzahl 20050203
# Exception Resumable Description Created on
1 NO_VALID_STATUS Falscher Kennzahlenstatus 20050203

Method KF_TIMESTAMP_TO_TEXT Signature

# Type Parameter Pass Value Optional Typing Method Associated Type Default value Description Created on
1 Changing C_TIMESTAMP_TXT Call by reference Type reference (TYPE) KFM_TIMESTAMP_TXT Aufbereiteter Zeitstempel des Kennzahlenwerts 20050203
2 Importing I_TIMESTAMP Call by reference Type reference (TYPE) KFM_TIMESTAMP Zeitstempel des Kennzahlenwerts 20050203

Method KF_TIMESTAMP_TO_TEXT on class CL_KF_HELPER has no exception.

Method KF_TXT_2_VALUE Signature

# Type Parameter Pass Value Optional Typing Method Associated Type Default value Description Created on
1 Exporting E_VALUE Call by reference Type reference (TYPE) KFM_VALUE Wert einer Kennzahl 20050920
2 Importing I_DECIMALS Call by reference Type reference (TYPE) KFM_KF_DECIMALS Anzahl der Dezimalstellen für Kennzahlenanzeige 20050920
3 Importing I_VALUE_TXT Call by reference Type reference (TYPE) KFM_VALUE_TXT Aufbereitete Anzeige eines Werts einer Kennzahl 20050920
# Exception Resumable Description Created on
1 CX_WDR_CONVERSION_EXCEPTION Konvertierungsfehler 20050920

Method KF_VALIDITY Signature

# Type Parameter Pass Value Optional Typing Method Associated Type Default value Description Created on
1 Importing I_NUMBER_OF_PERIODS Call by reference Type reference (TYPE) KFM_NUM_PERIODS Anzahl der Perioden (Gültigkeit der Kennzahlenwerte) 20050228
2 Importing I_PERIOD Call by reference Type reference (TYPE) KFM_PERIOD Periodentyp der Kennzahl 20050228
3 Importing I_TIMESTAMP Call by reference Type reference (TYPE) KFM_TIMESTAMP Zeitstempel 20050531
4 Returning R_TIMESTAMP Value transfer Type reference (TYPE) KFM_TIMESTAMP Zeitstempel des Kennzahlenwerts 20050228

Method KF_VALIDITY on class CL_KF_HELPER has no exception.

Method KF_VALUE_ROUNDING Signature

# Type Parameter Pass Value Optional Typing Method Associated Type Default value Description Created on
1 Importing I_DECIMALS Call by reference Type reference (TYPE) KFM_KF_DECIMALS Anzahl der Dezimalstellen für Kennzahlenanzeige 20050928
2 Importing I_VALUE Call by reference Type reference (TYPE) KFM_VALUE Wert einer Kennzahl 20050928
3 Returning R_VALUE Value transfer Type reference (TYPE) KFM_VALUE Wert einer Kennzahl 20050928

Method KF_VALUE_ROUNDING on class CL_KF_HELPER has no exception.

Method KF_VALUE_TXT Signature

# Type Parameter Pass Value Optional Typing Method Associated Type Default value Description Created on
1 Changing C_VALUE_TXT Call by reference Type reference (TYPE) KFM_VALUE_TXT Aufbereitete Anzeige eines Werts einer Kennzahl 20050208
2 Importing I_CURR Call by reference Type reference (TYPE) KFM_CURR Währung der Kennzahl 20050221
3 Importing I_DECIMALS Call by reference Type reference (TYPE) KFM_KF_DECIMALS Anzahl der Dezimalstellen für Kennzahlenanzeige 20050208
4 Importing I_UNIT Call by reference Type reference (TYPE) KFM_UNIT Mengeneinheit der Kennzahl 20050221
5 Importing I_VALUE Call by reference Type reference (TYPE) KFM_VALUE Wert einer Kennzahl 20050208

Method KF_VALUE_TXT on class CL_KF_HELPER has no exception.

Method RAISE_EXCEPTION Signature

# Type Parameter Pass Value Optional Typing Method Associated Type Default value Description Created on
1 Importing EXCEPTION_ID Value transfer Type reference (TYPE) SOTR_CONC Schlüssel zum logischen Objekt im OTR 20050228
2 Importing MESSAGE_TYPE Value transfer Type reference (TYPE) CHAR1 Art der Meldung 20050228
# Exception Resumable Description Created on
1 CX_KF_MONITOR Ausnahmeklasse Generischer Kennzahlenmonitor 20050228

Method TIMESTAMP_LOCAL_ZONE_2_UTC Signature

# Type Parameter Pass Value Optional Typing Method Associated Type Default value Description Created on
1 Importing I_TIMESTAMP_LOCAL Call by reference Type reference (TYPE) KFM_TIMESTAMP Zeitstempel 20051018
2 Importing I_TIME_ZONE Call by reference Type reference (TYPE) TZNZONE Zeitzone 20051018
3 Returning R_TIMESTAMP_UTC Value transfer Type reference (TYPE) KFM_TIMESTAMP Zeitstempel 20051018

Method TIMESTAMP_LOCAL_ZONE_2_UTC on class CL_KF_HELPER has no exception.

Method TIMESTAMP_UTC_2_LOCAL_ZONE Signature

# Type Parameter Pass Value Optional Typing Method Associated Type Default value Description Created on
1 Importing I_TIMESTAMP_UTC Call by reference Type reference (TYPE) KFM_TIMESTAMP Zeitstempel 20050915
2 Importing I_TIME_ZONE Call by reference Type reference (TYPE) TZNZONE Zeitzone 20050915
3 Returning R_TIMESTAMP_LOCAL Value transfer Type reference (TYPE) KFM_TIMESTAMP Zeitstempel 20050915

Method TIMESTAMP_UTC_2_LOCAL_ZONE on class CL_KF_HELPER has no exception.
History
Last changed by/on SAP  20110908 
SAP Release Created in 600