API for Fiori Launchpad Navigation

The IF_WD_FLP_API API enables the navigation mechanism of the SAP Fiori launchpad to be used for Web Dynpro applications.

With the IF_WD_FLP_API API you can navigate from a Web Dynpro application embedded in the SAP Fiori launchpad (FLP) to another application. To do this, you specify a semantic object and an action.

Class CL_WD_FLP_API has method GET_API. This method requires the reference to the current view of type IF_WD_VIEW_CONTROLLER, and returns a reference of type IF_WD_FLP_API.

Interface IF_WD_FLP_API provides the following methods For FLP services.

Table 1: Methods Definition in Interface IF_WD_FLP_API
Method	Description
GET_SEMANTIC_OBJECT_LINKS	Returns a table with links to an object. If no object is specified, all the links and their descriptions are sent back.
IS_INTENT_SUPPORTED	Checks whether an intent or multiple intents are supported.
GET_HREF_FOR_EXTERNAL	Returns the reference to an object and action.
NAVIGATE_TO_OBJECT	Navigates to an object and action.

Import Parameters

Table 2: Import Parameters for Method: GET_SEMANTIC_OBJECT_LINKS
Parameter	Type	Description
OBJECT	STRING	An FLP object name can be specified. In this case only links to this object are identified. If no object is specified, all available links are delivered.
PARAMETERS	WDR_SIMPLE_NAME_VALUE_LISTT	The parameters list is appended to the links as a URL parameter list. The PARAMETERS parameter is only included if the OBJECT parameter was set.
ON_ACTION	STRING	Name of an application action that is to be called from the framework. The action is passed to the list of links.
VIEW	IF_WD_VIEW	View containing the action.

Table 3: Import Parameters for Method: IS_INTENT_SUPPORTED
Parameter	Type	Description
INTENTS	WDR_SIMPLE_STRING_TABLE	List of intents that are to be checked.
ON_ACTION	STRING	Name of an application action that is to be called from the framework. The list of links is passed to the action.
VIEW	IF_WD_VIEW	View containing the action.

Table 4: Import Parameters for Method: GET_HREF_FOR_EXTERNAL
Parameter	Type	Description
OBJECT	STRING	An FLP object name can be specified. In this case only links to this object are identified. If no object name is specified, all available links are returned.
ACTION	STRING	FLP action for the object.
PARAMETERS	WDR_SIMPLE_NAME_VALUE_LIST	The parameter list is optional. If a parameter list is passed, the parameters are attached to the reference as a URL parameter list.
ON_ACTION	STRING	Name of an application action that is to be called from the framework. The reference is passed to the action.
VIEW	IF_WD_VIEW	View containing the action.

Table 5: Import Parameters for Method: NAVIGATE_TO_OBJECT
Parameter	Type	Description
OBJECT	STRING	FLP object name. Transfers a semantic object. Together with the action this forms the navigation target.
ACTION	STRING	FLP action for the object. This together with the semantic object forms the navigation target.
PARAMETERST	WDR_SIMPLE_NAME_VALUE_LIST	The parameter list is optional. If a parameter list is passed, all parameters are passed during navigation.
ON_ACTION	STRING	Name of an application action that is to be called from the framework. The action is passed whether the navigation was successful or not.
IF_WD_VIEW	VIEW	View containing the action.
SAP_XAPP_STATE	STRING	This parameter can be used to send large datasets that are transported from one application to another application in a Fiori Launchpad. The string is in JSON format. To receive large datasets, see SAP_XAPP_STATE. SAP URL Parameters

Return Parameters

Parameters VIEW and ON_ACTION are required if the application would like to receive a confirmation. This is always the case for methods GET_HREF_FOR_EXTERNAL, GET_SEMANTIC_OBJECT_LINKS, and IS_INTENT_SUPPORTED. NAVIGATE_TO_OBJECT only returns a notification in the event if the user's navigation was successful.

Table 6: Return Parameters for All Four Methods
Parameter	Type	Description
REQUEST_ID	STRING	Required to assign the request to the event. A unique request ID is created for each request (one of the four methods). The response or the event of a request also contains this ID.

Action Parameters

A WDEVENT parameter is passed to each action. This contains a PARAMETERS attribute with a name and value table.

Table 7: Action Parameters for Method: GET_SEMANTIC_OBJECT_LINKS
Parameter	Type	Description
STATUS	STRING	The values are set by FLP. "Success" if confirmation is successful. "Error" if an error occurs.
SERVICE	STRING	sap.ushell.services.CrossApplicationNavigation.getSemanticObjectLinks
REQUESTID	STRING	For example, WDFLP1
SEMANTICOBJECTLINKS	WDR_SIMPLE_NAME_VALUE_LIST	Returns an internal table with the identified intents.

Table 8: Action Parameters for Method: IS_INTENT_SUPPORTED
Parameter	Type	Description
STATUS	STRING	The values are set by FLP. "Success" if confirmation is successful. "Error" if an error occurs.
SERVICE	STRING	sap.ushell.services.CrossApplicationNavigation.isIntentSupported
REQUESTID	STRING	For example, WDFLP2
INTENTSSUPPORTED	WDR_SIMPLE_NAME_VALUE_LIST	Returns an internal table with the result. If this is not supported, value X is returned.

Table 9: Action Parameters for Method: GET_HREF_FOR_EXTERNAL
Parameter	Type	Description
STATUS	STRING	The values are set by FLP. "Success" if confirmation is successful. "Error" if an error occurs.
SERVICE	STRING	sap.ushell.services.CrossApplicationNavigation.hrefForExternal
REQUESTID	STRING	For example, WDFLP2
HREFFOREXTERNAL	WDR_SIMPLE_NAME_VALUE_LIST	Returns the external reference.

Table 10: Action Parameters for Method: NAVIGATE_TO_OBJECT
Parameter	Type	Description
STATUS	STRING	The values are set by FLP. "Success" if confirmation is successful. "Error" if an error occurs.
SERVICE	STRING	sap.ushell.services.CrossApplicationNavigation.toExternal!
REQUESTID	STRING	For example, WDFLP2

Test Application

The test application is WDR_TEST_FLP_NAVIGATION. An FLP environment with this test application and intents that can be queried and navigated to must be set up for the tester. Application WDR_TEST_FLP_NAVIGATION must be started from SAP Fiori Launchpad.

More Information

For more information about navigating with the SAP Fiori launchpad, see the SAP Library for SAP NetWeaver on SAP Help Portal at http://help.sap.com/nw_platform. In the application help search for Configuring Launchpad Navigation.