SAP ABAP Data Element UPF_Y_CSFCT (Planning function: Function module for cust. enhancements)
Hierarchy
☛ SAP_BW (Software Component) SAP Business Warehouse
   ⤷ BW-PLA-BPS (Application Component) Business Planning and Simulation
     ⤷ UPF (Package) SEM-BPS: Planning Functions
Basic Data
Data Element UPF_Y_CSFCT
Short Description Planning function: Function module for cust. enhancements  
Data Type
Category of Dictionary Type D   Domain
Type of Object Referenced     No Information
Domain / Name of Reference Type FUNCNAME    
Data Type CHAR   Character String 
Length 30    
Decimal Places 0    
Output Length 30    
Value Table TFDIR    
Further Characteristics
Search Help: Name    
Search Help: Parameters    
Parameter ID   
Default Component name    
Change document    
No Input History    
Basic direction is set to LTR    
No BIDI Filtering    
Field Label
  Length  Field Label  
Short 10 FM 
Medium 15 Function module 
Long 20 Function module 
Heading 30 Function Module 
Documentation

Definition

The exit function modules enable you to use planning functions that cannot be used with the planning functions delivered. The function modules are handled just as the planning functions delivered by SAP, that is, they are called up or appear on the end user's interface in the same way. You assign at least one and at most two function modules to every exit function:

  • A function module to initialize the planning function. This function module is optional. It is only required if new transaction data records are to be generated in the planning function that are different, in terms of the combinations of values, to characteristics in the previous transaction data that are not to be changed. The keys for these new transaction data records are delivered by the function module in the table ETO_CHAS. The keys are supplemented by the keys of the transaction data that already exist. The data objects for which the planning function is called up are formed from these keys. They also influence how often and with which combinations of transaction data the second function module is called up.
  • A function module that is called up several times and that changes transaction data records. This function module receives a package of transaction data records in each case. These differ only in their characteristics to be changed. They have the same values as far as all other characteristics are concerned. The transaction data is in table XTH_DATA. Only the existing records are transferred. If key combinations were returned by the initialization function module, and no transaction data exists for these, then table XTH_DATA is empty. The key combination is in the table ITO_CHASEL.

The function module for initialization has the following parameters:

  1. I_AREA = the planning area (Type UPC_Y_AREA ).
  2. I_PLEVEL = the planning level (Type UPC_Y_PLEVEL ).
  3. I_PACKAGE = the planning package (Type UPC_Y_PACKAGE ).
  4. I_METHOD = the planning function (Type UPC_Y_METHOD ).
  5. I_PARAM = parameter group of the planning function (Type UPC_Y_PARAM).
  6. IT_EXITP = the table of parameter values (Type UPC_YT_EXITP ).
  7. ITO_CHASEL = the selection conditions for the planning package (Type UPC_YTO_CHASEL ).
  8. ITO_CHA = the characteristics of the planning level (Type UPC_YTO_CHA).
  9. ITO_KYF = the key figures of the planning level (Type UPC_YTO_KYF ).

The function module supplies the following information:

  1. ETO_CHAS = Keys of objects. The type of this table depends on the planning area. You can obtain information on planning areas using the global class CL_SEM_PLANAREA_ATTRIBUTES. An object of this class has the information on the type name of the key table in the attribute TYPENAME_TO_CHAS. This type is stored in the Data Dictionary.
  2. ET_MESG = error messages or messages for the end user (Type UPC_YT_MESG ).

The function module that changes the data has the following parameters:

  1. I_AREA = the planning area (Type UPC_Y_AREA ).
  2. I_PLEVEL = the planning level (Type UPC_Y_PLEVEL ).
  3. I_PACKAGE = the planning package (Type UPC_Y_PACKAGE ).
  4. I_METHOD = the planning function (Type UPC_Y_METHOD ).
  5. I_PARAM = the parameter group of the planning function (Type UPC_Y_PARA).
  6. IT_EXITP = the table of parameter values (Type UPC_YT_EXITP ).
  7. ITO_CHASEL = the selection for the package (Type UPC_YTO_CHASEL ).
    Note: This parameter differs from the parameter for the initialization module. The selection conditions are transferred here that describe the current object.
  8. ITO_CHA = the characteristics of the planning level (Type UPC_YTO_CHA).
  9. ITO_KYF = the key figures of the planning level (Type UPC_YTO_KYF ).

The function module returns the following information:

  1. ET_MESG = error messages or messages for the end user (Type UPC_YT_MESG ).

The function module changes the following table:

  1. XTH_DATA = the transaction data records that are to be changed. The structure of the table can also be determined using the global class CL_SEM_PLANAREA_ATTRIBUTES. The name of the type is stored in the attribute TYPENAME_TH_DATA. The type is stored in the Data Dictionary.

Below are some lines of coding used to determine the information:
DATA: lr_iobj TYPE REF TO cl_sem_planarea_attributes,
tabnm TYPE tabname.
CALL METHOD cl_sem_planarea_attributes=>get_instance
EXPORTING i_area = 'TEST'
RECEIVING er_instance = lr_iobj.
tabnm = lr_iobj->typename_th_data.

For the planning area 'TEST', the name of the transaction data table is determined and placed in the variable tabnm.

History
Last changed by/on SAP  20130604 
SAP Release Created in