Ansicht
Dokumentation

UPX_API_SEMBPS_GETDATA - Plandaten lesen

CPI1466 during Backup   Addresses (Business Address Services)  
Diese Dokumentation steht unter dem Copyright der SAP AG.

Funktionalität

Mit diesem Baustein können Daten aus SEM-BPS gelesen werden. Diese Daten werden in einer tabellenartigen Struktur zurückgeliefert; diese Struktur wird durch ein Planungslayout festgelegt. Damit bereitet dieser Baustein die Daten in einer ähnlichen Form auf, wie sie innerhalb von SEM-BPS auch in der manuellen Planung erscheinen würden (d.h., die Daten entsprechen in ihrer Aufbereitung den im Layout herrschenden Einstellungen in Bezug auf Skalierung, Dezimalstellen und Vorzeichenumkehr). Für ein Client-Programm, das auf diesem API aufsetzt, entfallen somit die meisten Formatierungsarbeiten.

Diese API-Funktion setzt ausdrücklich keine Installation eines SAPGUI voraus, da kein Baustein des API einen Dialog sendet. Dies hat für den Baustein die Einschränkung zur Folge, daß die Kopfmerkmale des Planungslayouts nur einen Einzelwert als Selektion besitzen dürfen. Damit steht zum Zeitpunkt der Selektion die Kombination der Kopfmerkmale eindeutig fest. Es ist also (im Gegensatz zur manuellen Planung) kein Benutzereingriff erforderlich, um eine Kopfkombination zu erfragen.

Aus Gründen der Einfachheit unterstützt das API auch einige Funktionen der manuellen Planung nicht:

• Das API unterstützt nicht die Anzeige von BW-Hierarchien oder Merkmalshierarchien. Diese Einstellungen im Planungslayout werden im API lokal übersteuert. Ist in der Schlüsselspalte eines Layouts eine BW-Hierarchie hinterlegt, so liefert das API nur die Blätter der Hierarchie (und zwar in der durch die Hierarchie festgelegten Reihenfolge).

Seit Release 3.1A unterstützt das API auch Gesamtsummen und Zwischensummen, wenn die entsprechenden Optionen im verwendeteten Planungslayout gesetzt sind. Vergleiche hierzu auch die Information zu den Parametern ETK_ROW und ETK_DATA weiter unten.

Das Kennzeichen 'formularbasierte Schlüsselspalten', das im Planungslayout gesetzt werden kann, wird auch vom API unterstützt. Ist dieses Kennzeichen gesetzt, so können keine neuen physischen Zeilen erzeugt werden. Vergleiche hierzu auch die Dokumentation des Parameters ES_INFO (siehe unten).

Beispiel

Hinweise

Parameter

• I_AREA: Planungsgebiet

• I_PLEVEL: Planungsebene

• I_PACKAGE: Planungspaket

• I_LAYOUT: Planungslayout

• I_READ_ONLY: Wird dieser Parameter auf 'X' gesetzt, so werden beim Lesen der Daten keine Sperren gesetzt. Dieser Parameter sollte immer dann gesetzt werden, wenn die selektierten Plandaten nicht geändert werden sollen.

• E_SUBRC: Dieser Rückgabe-Parameter enthält den Wert 0, wenn die Funktion ohne Fehler ausgeführt werden konnte, sonst ist der Wert des Rückgabe-Parameters größer als 0.

• ES_INFO: Die Struktur enthält Zusatzinformationen. Das Kennzeichen es_info-insert ist gesetzt (d.h. gleich 'X'), wenn neue Zeilen hinzugefügt werden können, d.h. in den Tabellen etk_row und etk_data können Sätze zu neuen Zeilen hinzukommen (vgl. Parameter etk_row-row) und später dem Baustein API_SEMBPS_SETDATA übergeben werden. Ist es_info-insert initial, so ist das Hinzufügen von Zeilen nicht möglich. Im Baustein API_SEMBPS_SETDATA werden solche neuen Zeilen ignoriert. Das Kennzeichen 'leadcol_compl' stellt die Information bereit, ob das Planungslayout einfache Schlüsselspalten (' ') oder eine komplexe Schlüsselspalte enthält (d.h. jede Zeile ist im Layout einzeln definiert, leadcol_compl = 'X').

• ETK_HEAD_INFO: Diese Tabelle enthält alle Merkmale, die im Kopfbereich des Planungslayouts enthalten sind. CHANM enthält den technischen Merkmalsnamen, das Kennzeichen HIDE ist initial, wenn das Kopfmerkmal im Layout nicht ausgeblendet ist; wenn das Kopfmerkmal ausgeblendet ist, hat es dagegen den Wert 'X'.

• ETK_HEAD: Die Tabelle enthält die Kopfmerkmale des Planungslayouts mit ihren aktuellen Werten im externen Format und den zugehörigen Texten zum Merkmal. Diese Tabelle entspricht dem Kopfbereich in der manuellen Planung. Die Kopfmerkmale erscheinen in derjenigen Reihenfolge, in der sie im Planungslayout hinterlegt sind.

• ETK_ROW_INFO: Diese Tabelle enthält alle Merkmale der Schlüsselspalte(n). CHANM enthält den technischen Merkmalsnamen. PRES enthält die folgende Information über die Darstellung der Merkmalswerte (vergleiche auch hierzu die Festwerte der Domäne UPC_Y_PRES):

• initial, falls es sich um eine komplexe Schlüsselspalte handelt,

• '0', für die Kombination Merkmalswert und Text,

• '1' für Text,

• '2' für Merkmalswert,

• '3' für die Kombination Text und Merkmalswert.

• ETK_ROW: Die Tabelle enthält die physischen Zeilen (etk_row-row) mit ihren Merkmalswerten im externen Format und den zugehörigen Texten zum Merkmalswert. Diese Tabelle entspricht dem Bereich der Schlüsselspalten in der manuellen Planung. Diese Tabelle ist nach etk_row-row sortiert und enthält die Merkmale in derjenigen Reihenfolge, in der sie im Planungslayout hinterlegt sind. Seit Release 3.1A sind auch Gesamtsummen und Zwischensummen unterstützt; für solche Zeilen ist das Feld etk_row-chanm initial.

• ETK_COL_INFO: Diese Tabelle enthält genau die Merkmale, die in den Datenspalten des Planungslayouts eingestellt wurden; CHANM ist hier wieder der technische Merkmalsname.

• ETK_ROW_TEXT: Die Tabelle enthält pro physische Zeile einen Text zur Zeile. Diese Tabelle ist nur gefüllt, wenn das Planungslayout eine komplexe Schlüsselspalte besitzt, d.h. in dem Layout ist jede Zeile einzeln statisch festgelegt. Diese Tabelle entspricht genau den in der komplexen Schlüsselspalte enthaltenen Daten in der manuellen Planung.

• ETK_COL: Die Tabelle enthält pro physische Datenspalte die Spaltenmerkmale mit ihrem Wert und dem zugehörigen Merkmalstext. Diese Daten sind in der manuellen Planung nicht sichtbar.

• ETK_COL_TEXT: Die Tabelle enthält pro physische Datenspalte die Überschrift der Datenspalte. Sie entspricht also den Spaltenüberschriften für den Datenbereich in der manuellen Planung.

• ETK_DATA: Die Tabelle enthält pro physischer Zeile und Datenspalte den Zellwert im externen Format. Zusätzlich ist im Feld etk_data-input hinterlegt, ob die Datenzelle eingabebereit ist ( etk_data-input = '1' ) oder nicht (etk_data-input = '0'). Diese Tabelle wird sortiert nach den Feldern row und col (in dieser Reihenfolge) angeliefert. Seit Release 3.1A können in dieser Tabelle auch Werte zu Gesamtsummen oder Zwischensummen enthalten sein; diese sind nie eingabebereit. Können keine Summenzellen errechnet werden (etwa dann, wenn über Kennzahlwerte mit inhomogenen Einheiten summiert werden soll), so ist das Feld etk_data-value initial.

• ETK_RETURN: Diese Struktur kann eine Nachricht enthalten. Im Fall E_SUBRC <> 0 enthält sie die Fehlernachricht, im Fall E_SUBRC = 0 kann in dieser Struktur eine Informationsmeldung stehen.

Weiterführende Informationen

Parameter

ES_INFO
ETK_COL
ETK_COL_INFO
ETK_COL_TEXT
ETK_DATA
ETK_HEAD
ETK_HEAD_INFO
ETK_RETURN
ETK_ROW
ETK_ROW_INFO
ETK_ROW_TEXT
E_SUBRC
I_AREA
I_LAYOUT
I_PACKAGE
I_PLEVEL
I_READ_ONLY

Ausnahmen

Funktionsgruppe

UPX_KAM_OFFLINE

ABAP Short Reference   PERFORM Short Reference  
Diese Dokumentation steht unter dem Copyright der SAP AG.

Length: 8731 Date: 20240523 Time: 035429     sap01-206 ( 189 ms )