Updated: November 11, 2016

SAPUI5 Version 1.28

Services

Intro

The SAP Fiori launchpad provides apps the following services:

Settings
Save as Tile option
User Preferences setting
Contact Support
Give Feedback option
About dialog for launchpad
About dialog for apps
Log in/SSO/Log out
Navigation

Find out more about each service below.

Settings

You can set app-specific settings for each of the apps in the launchpad. If you implement the API for the settings service, a Settings entry appears in the Options menu. You’ll need to design the settings dialog for your app yourself. Make sure that you only have one Settings entry in the menu to give the user access to all app settings, and avoid having multiple menu entries per app.

For simple use cases, you can use one dialog with a basic set of options, as in the example on the right.

Example of a simple settings dialog

For more complex use cases, you can use a structured Settings dialog. The second example shows a list of settings options, each of which has a dialog containing the respective settings entries.

Example of a complex settings dialog (1)

Selecting a line in the complex settings dialog takes the user to the individual setting entries.

Example of a complex settings dialog (2)

Save as Tile

The Save as Tile option lets the user save a snapshot of the app in its current state. In the Save as Tile dialog, the user can enter a title, a subtitle, and a description of the new tile.

This option is accessible through the Share menu in the footer toolbar. When the user chooses OK, a new tile is added to the first section of the launchpad. It displays the title, subtitle, and description entered by the user, and triggers navigation to the app snapshot. All the app settings that were part of the URL will be reflected, such as an item selection in the master list.

Save as Tile action

Save as Tile dialog

User Preferences

The User Preferences dialog contains the following attributes:

User name
Theme selector
Server name
Language
User profiling (if implemented)

User Preferences dialog

Loading Indicator and Error Messages in User Preferences Dialog

A menu entry should not be shown if its corresponding parameters are not available.

If a particular parameter is still loading while others have already been loaded, show a Loading… message in the corresponding line.
If a value fails to load, display an error message in that line.
If parameters are still loading on the details screen, show a busy indicator inside the dialog.
If parameters cannot be received, show an error message in the relevant place.

Contact Support

The Contact Support dialog offers a description field for entering a problem. Users can also display the technical data that should be sent to the support team. The Send button will be activated if there is an entry in the description field. Note that this feature is only available if the customer activates it.

The Contact Support dialog

Give Feedback

The Give Feedback dialog gives users an opportunity to rate their experience and give written feedback. Users can also display the technical data that will be sent to the support team. Note that this feature is only available if the customer activates it.

Give Feedback dialog

About

The About dialog for the launchpad displays the following information:

SAP Fiori icon or specific icon to represent the launchpad
Official SAP Fiori name or a specific launchpad name
Technical information (similar structure to that used in apps) or other specific information relevant for the launchpad

About dialog for the launchpad

The About dialog for apps displays the following information:

App icon (as specified in the component)
Official app name, as specified in the component (config titleResource)
Full technical app name
App version
Build ID
SAPUI5 version
User agent details

The About dialog for apps

Logout

To log out, the user selects the Log Out entry in the Options menu on the shell bar. This opens the logout confirmation dialog.