Functionality
Data can be read from BW-BPS with this module. This data is returnedin a tabular structure; this structure is defined by a planning layout.In this way, this module formats the data in a similar form to how itwould also appear within BW-BPS in manual planning (this means thedata in its formatting corresponds to the settings in the layout inrelation to scaling, decimal places and reverse sign). In this way,formatting work is removed to a large extent for a client program,which is set up on this API.
This API function explicitly does not assume any installation of aSAPGUI, since no API module sends a dialog. This results in therestriction for the module, that the header characteristics of theplanning layout, can only have one single value as a selection. Thisway the combination of header characteristics is clearly definite atthe point of the selection. Therefore (in contrast to manual planning),no user intervention is necessary to ascertain a header combination.
For reasons of simplicity, the API does not support some of thefunctions of manual planning:

• The API does not support the display of BW hierarchies or
characteristic hierarchies. These settings in the planning layout areoverridden locally in the API. If a BW hierarchy is defined in the leadcolumn of a layout, the API only delivers the leaves of the hierarchy(in the order defined by the hierarchy).
The API also supports totals and subtotals, if the corresponding optionsare set in the planning layout used. Compare here the information on theparameters ETK_ROW and ETK_DATA further below.
The indicator 'form-based lead columns, which can be set in theplanning layout, is also supported by API. If this indicator is set, nonew physical lines can be generated. Also compare here thedocumentation of the parameter ES_INFO (see below).

Parameters


• I_AREA: Planning area


• I_PLEVEL: Planning level


• I_PACKAGE: Planning package


• I_LAYOUT: Planning layout


• I_READ_ONLY: If this parameter is set to 'X', then no locks are set
when reading the data. This parameter should always then be set whenthe selected plan data should not be changed.

• E_SUBRC: This return parameter contains the value 0, if the function
was executed without errors, otherwise the value of the returnparameter is greater than 0.

• ES_INFO: The structure contains additional information. The indicator
es_info-insert is set (this means the same as 'X'), when new rows canbe inserted, this means in the tables etk_row and etk_data records canbe added to new rows (compare parameter etk_row-row) and aretransferred later to the module API_SEMBPS_SETDATA. If es_info-insertis initial, then rows cannot be inserted. Such new rows are ignored inthe module API_SEMBPS_SETDATA. The indicator 'leadcol_compl' providesinformation, whether the planning layout contains simple lead columns(' ') or a complex lead column (this means every row is definedindividually in the layout, leadcol_compl = 'X').

• 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; if the characteristic ishidden, then it has the value 'X'.

• ETK_HEAD: The table contains the header characteristics of the planning
layout with their current value in external format and the appropriatetexts on the characteristic. This table corresponds to the header areain manual planning. The header characteristics appear in the order inwhich they are defined in the planning layout.

• 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_ROW: The table contains the physical rows (etk_row-row) with their
characteristic values in external format and the texts corresponding tothe characteristic value. This table corresponds to the area of thelead columns in manual planning. This table is sorted according toetk_row-row and contains the characteristics in the order in which theyare defined in the planning layout. Since release 3.1A, totals andsubtotals are also supported; for such rows the field etk_row-chanm isinitial.

• ETK_COL_INFO: This table contains exactly the characteristics, which
were set in the data columns of the planning layout; CHANM is thetechnical characteristic name again here.

• ETK_ROW_TEXT: The table contains per physical row a text for the row.
This table is only filled when the planning layout has a complex leadcolumn, this means every row is determined individually in the layout.This table corresponds exactly to the data contained in the complexlead columns in manual planning.

• ETK_COL: The table contains per physical data column, the column
characteristics with their value and the corresponding characteristictext. This data is not visible in manual planning.

• ETK_COL_TEXT: The table contains per physical data column, the heading
of the data column. Therefore it corresponds to the column to thecolumn headings for the data area in manual planning.

• ETK_DATA: The table contains per physical row and data column the cell
value in external format. Additionally in the field etk_data-input itis defined whether the data cell is ready for input ( etk_data-input ='1') or not (etk_data-input = '0'). This table is delivered sortedaccording to the fields row and col (in this order). Since release 3.1Avalues on totals or subtotals can also be contained in this table;these are never ready for input. If now totals cells can be calculated(if when you should add up key figure values with inhomogeneous units,then the field etk_data-value is initial.

• ETK_RETURN: This structure can contain a message. In the case of
E_SUBRC <> 0 it contains an error message, in the case of E_SUBRC = 0an information message can be in the structure.