Die API IF_WD_FLP_API erlaubt es, die Navigationsmechanismen des SAP Fiori Launchpad für
Web-Dynpro-Anwendungen zu nutzen.
Über die API IF_WD_FLP_API können Sie von einer in das
SAP Fiori Launchpad (FLP) eingebetteten Web-Dynpro-Anwendung zu einer anderen Anwendung
navigieren. Dafür geben Sie ein semantisches Objekt und eine Aktion an.
Die Klasse CL_WD_FLP_API hat die Methode
GET_API. Diese Methode benötigt die
Referenz auf den aktuellen View vom Typ
IF_WD_VIEW_CONTROLLER und liefert eine
Referenz vom Typ IF_WD_FLP_API.
Für die Services des FLP stellt das Interface
IF_WD_FLP_API folgende Methoden bereit.
Tabelle 1: Methoden-Definition im Interface
IF_WD_FLP_API
| Methode |
Beschreibung |
|---|
| GET_SEMANTIC_OBJECT_LINKS |
Liefert eine Tabelle mit Links zu einem Objekt. Wenn kein Objekt angegeben ist werden
alle Links und deren Beschreibung zurück geschickt. |
| IS_INTENT_SUPPORTED |
Prüft ob ein Intent oder mehrere Intents unterstützt werden. |
| GET_HREF_FOR_EXTERNAL |
Liefert die Referenz zu einem Objekt und Aktion. |
| NAVIGATE_TO_OBJECT |
Navigiert zu einem Objekt und Aktion. |
Import Parameter
Tabelle 2: Import Parameter für die Methode: GET_SEMANTIC_OBJECT_LINKS
| Parameter |
Typ |
Beschreibung |
|---|
| OBJECT |
STRING |
Ein FLP Objekt Name kann angegeben werden. Dann werden nur Links zu diesem Objekt
ermittelt. Wenn kein Ojekt angegeben wird, werden alle verfügbaren
Links geliefert. |
| PARAMETERS |
WDR_SIMPLE_NAME_VALUE_LISTT |
Die Parameter Liste wird als URL Parameter Liste an die Links angehängt. Der Parameter
PARAMETERS wird nur
berücksichtigt, wenn der Parameter
OBJECT gesetzt
wurde. |
| ON_ACTION |
STRING |
Der Name einer Aktion der Anwendung, die vom Framework gerufen werden soll. Die Atkion
wird an die Liste der Links übergeben. |
| VIEW |
IF_WD_VIEW |
View, der die Aktion enthält. |
Tabelle 3: Import Parameter für die Methode: IS_INTENT_SUPPORTED
| Parameter |
Typ |
Beschreibung |
|---|
| INTENTS |
WDR_SIMPLE_STRING_TABLE |
Liste der Intents, die geprüft werden sollen. |
| ON_ACTION |
STRING |
Der Name einer Aktion der Anwendung, die vom Framework gerufen werden soll. Der Aktion
wird die Liste der Links übergeben. |
| VIEW |
IF_WD_VIEW |
View, der die Aktion enthält. |
Tabelle 4: Import Parameter für die Methode: GET_HREF_FOR_EXTERNAL
| Parameter |
Typ |
Beschreibung |
|---|
| OBJECT |
STRING |
Ein FLP Object Name kann angegeben werden. Dann werden nur Links zu diesem Objekt
ermittelt. Wenn nicht, dann werden alle verfügbaren Links geliefert. |
| ACTION |
STRING |
FLP Aktion zum Objekt. |
| PARAMETERS |
WDR_SIMPLE_NAME_VALUE_LIST |
Die Parameter Liste ist optional. Wird eine Parameter Liste übergeben, dann werden
die Parameter als UR -Parameter Liste an die Referenz
angehängt. |
| ON_ACTION |
STRING |
Der Name einer Aktion der Anwendung, die vom Framework gerufen werden soll. Die
Aktion wird die Referenz übergeben. |
| VIEW |
IF_WD_VIEW |
View, der die Aktion enthält. |
Tabelle 5: Import Parameter für die Methode: NAVIGATE_TO_OBJECT
| Parameter |
Typ |
Beschreibung |
|---|
| OBJECT |
STRING |
FLP Objekt Name. Übergibt ein semantisches Objekt. Dieses bildet zusammen mit der
Aktion das Navigationsziel. |
| ACTION |
STRING |
FLP Aktion zum Objekt. Diese bildet zusammen mit dem semantischen Objekt das
Navigationsziel. |
| PARAMETERST |
WDR_SIMPLE_NAME_VALUE_LIST |
Die Parameter Liste ist optional. Wird eine Paramerter Liste übergeben, dann werden
die Parameter bei der Navigation übergeben. |
| ON_ACTION |
STRING |
Der Name einer Aktion der Anwendung, die vom Framework gerufen werden soll. Der
Aktion wird übergeben, ob die Navigation erfolgreich war oder
nicht. |
| IF_WD_VIEW |
VIEW |
View, der die Aktion enthält. |
| SAP_XAPP_STATE |
STRING |
Der Parameter kann genutzt werden um große Datenmengen zu senden, die von einer
Anwendung zu einer anderen Anwendung in einem SAP Fiori Launchpad
transportiert werden. Es wird ein String im JSON Format erwartet. Um
große Datenmengen zu empfangen, siehe
SAP_XAPP_STATE unter
SAP-URL-Parameter |
Rückgabe Parameter
Die Parameter VIEW und
ON_ACTION werden benötigt, wenn die
Anwendung eine Rückmeldung erhalten soll. Für die Methoden
GET_HREF_FOR_EXTERNAL,
GET_SEMANTIC_OBJECT_LINKS und
IS_INTENT_SUPPORTED wird das immer der
Fall sein. NAVIGATE_TO_OBJECT gibt im Event
nur zurück falls erfolgreich ‘navigiert’ wurde.
Tabelle 6: Rückgabe Parameter für aller vier Methoden
| Parameter |
Typ |
Beschreibung |
|---|
| REQUEST_ID |
STRING |
Notwendig für die Zuordnung des Requests zum Event. Bei jedem Request (eine der vier
Methoden) wird eine eindeutige Request ID erzeugt. Die Response oder
das Event zu einer Request enthält ebenfalls diese ID. |
Action Parameter
Jeder Aktion wird ein Parameter WDEVENT übergeben. Dieser enthält ein Attribut PARAMETERS mit
einer Name-Value-Tabelle.
Tabelle 7: Action Parameter für die Methode: GET_SEMANTIC_OBJECT_LINKS
| Parameter |
Typ |
Beschreibung |
|---|
| STATUS |
STRING |
Die Werte werden vom FLP gesetzt. "Success" bei erfolgreicher Rückmeldung. "Error"
bei einem auftretenden Fehler. |
| SERVICE |
STRING |
sap.ushell.services.CrossApplicationNavigation.getSemanticObjectLinks |
| REQUESTID |
STRING |
z. B. WDFLP1 |
| SEMANTICOBJECTLINKS |
WDR_SIMPLE_NAME_VALUE_LIST |
Liefert eine interne Tabelle mit den ermittelten Intents. |
Tabelle 8: Action Parameter für die Methode: IS_INTENT_SUPPORTED
| Parameter |
Typ |
Beschreibung |
|---|
| STATUS |
STRING |
Die Werte werden vom FLP gesetzt. "Success" bei erfolgreicher Rückmeldung. "Error" bei
einem auftretenden Fehler. |
| SERVICE |
STRING |
sap.ushell.services.CrossApplicationNavigation.isIntentSupported |
| REQUESTID |
STRING |
z. B.'WDFLP2 |
| INTENTSSUPPORTED |
WDR_SIMPLE_NAME_VALUE_LIST |
Liefert eine interne Tabelle mit dem Ergebnis. Wenn dieser unterstütz ist, wird ein
Wert X zurückgegeben. |
Tabelle 9: Action Parameter für die Methode: GET_HREF_FOR_EXTERNAL
| Parameter |
Typ |
Beschreibung |
|---|
| STATUS |
STRING |
Die Werte werden vom FLP gesetzt. "Success" bei erfolgreicher Rückmeldung. "Error" bei
einem auftretenden Fehler. |
| SERVICE |
STRING |
sap.ushell.services.CrossApplicationNavigation.hrefForExternal |
| REQUESTID |
STRING |
z. B. WDFLP2 |
| HREFFOREXTERNAL |
WDR_SIMPLE_NAME_VALUE_LIST |
Liefert die externe Referenz. |
Tabelle 10: Action Parameter für die Methode: NAVIGATE_TO_OBJECT
| Parameter |
Typ |
Beschreibung |
|---|
| STATUS |
STRING |
Die Werte werden vom FLP gesetzt. "Success" bei erfolgreicher Rückmeldung. "Error" bei
einem auftretenden Fehler. |
| SERVICE |
STRING |
sap.ushell.services.CrossApplicationNavigation.toExternal! |
| REQUESTID |
STRING |
z. B. WDFLP2' |
Testanwendung
Die Testanwendung ist WDR_TEST_FLP_NAVIGATION. Es muss jedoch für den Tester eine FLP-Umgebung
mit dieser Testanwendung und Intents, die erfragt und zu denen navigiert werden
können, eingerichtet sein. Die Anwendung WDR_TEST_FLP_NAVIGATION muss aus dem SAP
Fiori Launchpad gestartet werdden.
Weitere Informationen
Weitere Informationen zur Navigation mit dem SAP
Fiori Launchpad finden Sie in der SAP Bibliothek von SAP NetWeaver auf dem SAP Help
Portal unter
http://help.sap.com/nw_platform. In der Application Help suchen Sie nach
Configuring Launchpad Navigation.
