Hierarchy
SAP_BW (Software Component) SAP Business Warehouse⤷
BW-PLA-BPS (Application Component) Business Planning and Simulation⤷
UPC (Package) SEM-BPS: General Functions
Basic Data
| Data Element | UPC_Y_USER_EXIT |
| Short Description | Function Module Name |
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 | LIB | |
| Default Component name | ||
| Change document | ||
| No Input History | ||
| Basic direction is set to LTR | ||
| No BIDI Filtering |
Field Label
| Length | Field Label | |
| Short | 10 | Funct.name |
| Medium | 15 | Function module |
| Long | 20 | Function module |
| Heading | 55 | Function module name |
Documentation
Definition
This field contains the name of the function module, which implements the variable exit. The interfaces of the exit modules differ for the individual variable types.
Function group UPFX contains examples of individual variable types for a variable exit: UPF_VARIABLE_USER_EXIT_CHAR, UPF_VARIABLE_USER_EXIT_ATTR, UPF_VARIABLE_USER_EXIT_HIER and UPF_VARIABLE_USER_EXIT_NUM.
Note that the fields and tables in the interfaces of the function modules must contain values in the internal format.
Variable of the Type 'Characteristic Values'
FUNCTION ZEXIT_CHA_VAR.
*"----------------------------------------------------------------------
*"*"Local Interface:
*" IMPORTING
*" REFERENCE(I_AREA) TYPE UPC_Y_AREA
*" REFERENCE(I_VARIABLE) TYPE UPC_Y_VARIABLE
*" REFERENCE(I_CHANM) TYPE UPC_Y_CHANM
*" REFERENCE(ITO_CHANM) TYPE UPC_YTO_CHA
*" EXPORTING
*" REFERENCE(ETO_CHARSEL) TYPE UPC_YTO_CHARSEL
*" EXCEPTIONS
*" FAILED
*"----------------------------------------------------------------------
Meaning of Parameters:
- I_AREA contains the planning area
- I_VARIABLE contains the technical name of the variable
- I_CHANM only contains the technical name of the characteristic if exactly one characteristic was defined in the variable maintenance
- ITO_CHANM contain all technical names of the characteristics which were defined in the variable maintenance.
- ETO_CHARSEL contains the selection options for the characteristics listed in table ITO_CHANM. If table ITO_CHANM contains more than one characteristic, then the characteristic values related to a characteristic combination are to be indicated using a common number in field SEQNO. In this case the follwing must apply to the fields SIGN and OPT: SIGN = 'I' and OPT = 'EQ'.
- If you cannot fill the selections in table ETO_CHARSEL, then trigger an exception with the statement message ... raising FAILED if the exception 'FAILED' was declared as in the module above.
Variable of the Type 'Hierarchy Node'
FUNCTION ZEXIT_HIE_VAR.
*"----------------------------------------------------------------------
*"*"Local Interface:
*" IMPORTING
*" REFERENCE(I_TYPE) TYPE UPC_Y_VAR_TYPE
*" REFERENCE(I_AREA) TYPE UPC_Y_AREA
*" REFERENCE(I_VARIABLE) TYPE UPC_Y_VARIABLE
*" REFERENCE(IS_HIE_KEY) TYPE UPC_YS_HIE_KEY
*" EXPORTING
*" REFERENCE(ET_HIE_NODES) TYPE UPC_YT_HIESEL
*" EXCEPTIONS
*" FAILED
*"----------------------------------------------------------------------
Meaning of Parameters:
- I_TYPE contains the variable type: Compare the related constants 'upcfw_cs_var_type-hierarchy' in type group UPCFW.
- I_AREA contains the planning area
- I_VARIABLE contains the technical name of the variable
- IS_HIE_KEY contains the hierarchy key
- ET_HIE_NODES contains the hierarchy nodes. A hierarchy node is uniquely described by the fields of the hierarchy key (see IS_HIE_KEY) and the hierarchy node: HIECHA is the characteristic for node, NODENAME the characteristic value of the node. TO_CHADEP is to be filled with the characteristic values for the higher-level characteristics if the characteristic is compounded in HIECHA. You use the indicator DUMMY_LEAF to distinguish in hierarchies with postable nodes the postable nodes from the (dummy) end node with the same characteristic value.
- If you cannot fill the hierarchy nodes in table ET_HIE_NODES, then trigger an exception with the statement message ... raising FAILED if the exception 'FAILED' was declared as in the module above.
Variable of the Type 'Attributes'
FUNCTION ZEXIT_ATTR_VAR.
*"----------------------------------------------------------------------
*"*"Local Interface:
*" IMPORTING
*" REFERENCE(I_AREA) TYPE UPC_Y_AREA
*" REFERENCE(I_VARIABLE) TYPE UPC_Y_VARIABLE
*" REFERENCE(I_CHANM) TYPE UPC_Y_CHANM
*" REFERENCE(ITO_CHANM) TYPE UPC_YTO_CHA
*" REFERENCE(ITO_ATTR) TYPE UPC_YTO_ATTR
*" EXPORTING
*" REFERENCE(ETO_CHARSEL) TYPE UPC_YTO_CHARSEL
*" EXCEPTIONS
*" FAILED
*"----------------------------------------------------------------------
Meaning of Parameters:
- I_AREA contains the planning area
- I_VARIABLE contains the technical name of the variable
- I_CHANM contains the technical name of the characteristic of the variable
- ITO_CHANM also contains the technical name of the characteristic of the variable
- ITO_ATTR contains the attributes defined for the characteristic in variable maintenance
- ETO_CHARSEL contains the selectionen for the characteristic (it does not contain any selections for attributes for the characteristic)
- If you cannot fill the selections for table ETO_CHARSEL, then trigger an exception with the statement message ... raising FAILED if the exception 'FAILED' was declared as in the module above.
Variable of the Type 'Numeric Values'
FUNCTION ZEXIT_NUM_VAR.
*"----------------------------------------------------------------------
*"*"Local Interface:
*" IMPORTING
*" REFERENCE(I_AREA) TYPE UPC_Y_AREA
*" REFERENCE(I_VARIABLE) TYPE UPC_Y_VARIABLE
*" EXPORTING
*" REFERENCE(E_NUM_VALUE) TYPE UPC_Y_VAR_NUMBER
*" REFERENCE(E_NUM_NO_VALUE) TYPE BOOLE_D
*" EXCEPTIONS
*" FAILED
*"----------------------------------------------------------------------
Meaning of Parameters:
- I_AREA contains the planning area
- I_VARIABLE contains the technical name of the variable
- E_NUM_VALUE contais the numeric value
- E_NUM_NO_VALUE contains the value 'X', if no numeric value was set in E_NUM_VALUE, otherwise E_NUM_NO_VALUE is returned initial.
History
| Last changed by/on | SAP | 20130604 |
| SAP Release Created in | 3.0A |
