home-page-tiles-json-file-872d124.md

Home Page Tiles JSON File

The Home Page tiles JSON descriptor, for example, tiles.json, contains the definition of the Home Page tiles for the extension application.

Remember:

SAP Business Technology Platform, Neo environment will sunset on December 31, 2028, subject to terms of customer or partner contracts.

For more information, see SAP Note 3351844.

Tip:

This documentation refers to SAP Business Technology Platform, Neo environment. If you are looking for documentation about other environments, see SAP Business Technology Platform ↗️.

Note:

The support of the Home Page tiles in SAP SuccessFactors has been discontinued. See Home Page Tiles.

We recommend that you use the latest home page. See Migrating to the Latest Home Page.

Properties

Home Page Tile Properties
name	The name of the tile used to identify it. This name is used in the Home Page administration tools and it is not visible to end-users, but only to HR administrators.
metadata	Defines the localized tile title and description.
title	A metadata property. This is the title of the custom tile as it appears to end-users on the Home Page. The value en_US is mandatory. Otherwise, the value for other locales is not provided, and end-users will see a blank tile.
subTitle	A metadata property. This is a subtitle that appears on custom tiles under the tile title. Subtitles are optional. If you do not want to use a subtitle, you can leave the field blank.
locale	A metadata property. Using this propety, you can localize the title, and the subtitle.
type	Determines how the tile appears to end-users. Currently, only static type is supported. The value static is mandatory.
configuration	Contains the icon property.
icon	A configuration property. Contains the ID of the icon that you want to use for the custom tile. You can take its ID from SAP SuccessFactors system. Go to Admin Center > Manage Home Page > Add Custom Tile and then follow the wizard until you choose the icon in the Tile tab. Then, take its ID and place it in the tiles.json. For example, "sap-icon://add-product".
navigation	The tile navigation determines how the tile responds when a user clicks or selects it. You can choose from the following options: type: html-popover configuration: Contains two properties, "contentSize" and "content". "contentSize" defines the width of the popover window and has one of the following values: "responsive", "small", "medium", and "large". "content" defines the HTML content of the popover window and has a String value. You cannot localize the content of this type (unlike the SAP SuccessFactors custom popover tiles). type: iframe-popover configuration: Contains two properties, "contentSize" and "URL". "contentSize" defines the size of the popover window and has one of the following values: "responsive", "small", "medium", and "large". "URL" defines the relative to the application root of the iframe source and has a String value. type: url configuration: Contains the "url" property. "url" defines the URL link which will be opened and has a String value. For example, "index.html". The "url" is relative to the application root. type: no_target

For more details about the Home Page tiles properties, see Custom Tile Configuration Settings.

Note:

The tiles.json descriptor file must use UTF-8 encoding and its size must not exceed 100 KB.

Example

Example of a Home Page tile JSON descriptor.

[{
	"tileVersion": "NEW_HOME_PAGE",
	"tiles": [{
			"name": "New Test Application",
			"section": "news",
			"metadata": [{
				"title": "My new home page tile",
				"subTitle": "This is new home page tile",
				"locale": "en_US"
			}],
			"type": "static",
			"configuration": {
				"icon": "sap-icon://add-product"
			},
			"navigation": {
				"type": "url",
				"configuration": {
					"openInNewWindow": false,
					"url": "index.html"
				}
			}
		}]	
}]