Fonction SAP API_SEMBPS_LAYOUT_GETDETAIL - Detail Information on Planning Layout

Paramètre Reférence Type Long. Valeur par déf. Facultatif Description
I_AREA UPC_AREA-AREA C 8 Planning Area
I_LAYOUT UPP_PARAM-PARAM C 8 Parameter Group
I_PLEVEL UPC_PLEVEL-PLEVEL C 8 Planning Level

Paramètre Reférence Type Long. Description
E_LEADCOL_COMPL UPC_YS_API_INFO-LEADCOL_COMPL C 1 Data Element for Domain BOOLE: TRUE (="X") and FALSE (=" ")
E_SUBRC SYST-SUBRC I 4 Return Value, Return Value After ABAP Statements

Paramètre Reférence Long. Facultatif Description
ETK_COL_INFO UPC_YS_API_COL_INFO 30 X API: Information on Column Characteristics
ETK_HEAD_INFO UPC_YS_API_HEAD_INFO 31 X API: Information on Header Characteristics
ETK_RETURN BAPIRET2 548 X Return Parameter
ETK_ROW_INFO UPC_YS_API_ROW_INFO 31 X API: Information on Row Characteristics

Functionality
It is possible to read some detailed information on a planning layoutwith this module. Only static determined attributes can be madeavailable, there are no attributes, which are deterimined first withtransaction data (decimal places or a variable replacement, whichdetermine one characteristic value in the data column, belong to this).The module delivers the characteristics, which were defined in theheader area of the layout, in the area of the lead colums and the datacolumns. This information is then useful, when you want to write newdata directly with the module API_SEMBPS_SETDATA (or the moduleAPI_SEMBPS_GETDATA could not deliver any transaction data), for withthe module API_SEMBPS_LAYOUT_GETDETAIL the characteristics of the leadcolumns can be determined first. This module is also useful todetermine whether a package is usable in connection with the modulesAPI_SEMBPS_GETDATA or API_SEMBPS_SETDATA. At the same time, youdetermine with API_SEMBPS_LAYOUT_GETDETAIL first the headercharacteristics of the planning layout and then check whether thesecharacteristics in the data package have only a single value as aselection.

Parameters

  • I_AREA: Planning area

  • I_PLEVEL: Planning level

  • I_LAYOUT: Planning layout

  • E_SUBRC. is greater than zero, when an error has occurred

  • E_LEADCOL_COMPL: Indicator is set (therefore the same as 'X'), when the
    • layout has a complex lead column, otherwise it is initial.
    • ETK_HEAD_INFO: This table contains all characteristics, which were set
      • in the header area of the planning layout. CHANM contains the technicalcharacteristic names, the indicator HIDE is initial when the headercharacteristic is not hidden in the layout, when it is hidden it hasthe value 'X'.
      • ETK_ROW_INFO: This table contains all characteristics of the lead
        • column(s). CHANM contains the technical characteristic names. PREScontains the following information about the format of thecharacteristic values (also compare here the fixed values of the domainUPC_Y_PRES):
        initial, if it concerns a complex lead column
        '0', for the combination characteristic value and text,
        '1' for text,
        '2' for characteristic value,
        '3' for the combination text and characteristic value.
        • ETK_COL_INFO: This table contains exactly those characteristics, which
          • were set in the data columns of the planning layout; CHANM is thetechnical characteristic name again here.
          • ETK_RETURN: This structure can contain a message. In the case E_SUBRC
            • <> 0 it contains an error message, in the case E_SUBRC = 0 aninformation message can be in this structure.
            The technical descriptions on characteristics in the tables above arethose, which are used in SAP BW. The 'dimension values', therefore thekey figure dimension, is an exception. This 'dimension' is treated as anormal 'characteristic' within the API modules API_SEMBPS_GETDATA ,API_SEMBPS_SETDATA and API_SEMBPS_LAYOUT_GETDETAIL, although it doesnot exist as a characteristic in SAP BW nicht. The string '_BKENNZAHL'is used as technical description for the dimension values within themodules API_SEMBPS_GETDATA and API_SEMBPS_SETDATA.