Show TOC

Referencing a Launchpad Configuration FileLocate this document in the navigation structure

For the settings in a launchpad configuration file to take effect, you must create a reference to this file.

You can reference a launchpad configuration file in one of the following ways:

  • In a URL parameter
  • In the FioriLaunchpad.html file
Referencing a Launchpad Configuration File in a URL Parameter

The URL parameter for referencing a launchpad configuration file has the following syntax:

sap-ushell-config-url=<path>

The path must be in the same subdomain as the FioriLaunchpad.html file.

In the FioriLaunchpad.html file, the path must be included in the configurationFileFolderWhitelist parameter.

Example: sap-ushell-config-url=/sap/ushell_config/MyLaunchpadConfig.json

For addressing a launchpad configuration file, use one of the following URLs:
  • https://<server>:<port>/sap/bc/ui2/flp/?sap-ushell-config-url=/sap/ushell_config/<config>.json
  • https://<server>:<port>/sap/bc/ui2/flp/index.html?sap-ushell-config-url=/sap/ushell_config/<config>.json
  • https://<server>:<port>/sap/bc/ui2/flp/FioriLaunchpad.html?sap-ushell-config-url=/sap/ushell_config/<config>.json
Referencing a Launchpad Configuration File in the FioriLaunchpad.html File

If you specify a lauchpad configuration file in the FioriLaunchpad.html file, the system ignores URL parameter sap-ushell-config-url. This allows you to enforce the use of a specific launchpad configuration file.

Caution

The FioriLaunchpad.html file is delivered by SAP. If you modify this file, your changes might be overwritten when you upgrade your system to a new release or support package. For this reason, remember to create a backup copy of the FioriLaunchpad.html file before upgrading.

Configuration example in FioriLaunchpad.html file

// platform-specific (ABAP) launchpad configuration
"launchpadConfiguration" :  {
    "configurationFile" : {
        "sap-ushell-config-url" : "/sap/ushell_config/MyLaunchpadConfig.json"
        "configurationFileFolderWhitelist": {
            "" : false,
            "cfg/" : false,
            "cfg/sap/" : false,
            "/sap/ushell_config/" : true,
            "/sap/bc/ui5_demokit/test-resources/sap/ushell/demoapps/LaunchpadConfigFileExamples/" : false
        }
    }
}