Navigation

Navigation action type allows to open URL or performs intent-based navigation supported by the host environment. Parameters determine whether it is intent-based, or opens a URL.

Navigation Using a URL

This is the generic type navigation with provided URL. The optional target parameter defines if the given URL should be opened in a new or in the same window.

Default behavior: opens the given URL in the specified target.

Parameters

Property Type Default Value Required Description Schema Version Since
url string Yes The URL to navigate to. 1.15.0 1.65
target string "_blank" No If the given url should be opened in a new or the same window. Possible values are "_blank" and "_self". 1.15.0 1.65

See navigation example.

Intent-Based Navigation

The intent-based navigation mechanism allows to launch applications or perform actions over semantic objects by using abstract intents. In order for this mechanism to work, it is essential that the host environment supports it and the card developer knows exactly what parameters the host environment expects. It is supported by environments like SAP Fiori Launchpad and SAP Work Zone.

Note: This navigation strongly depends on the host environment.

Parameters

Property Type Default Value Required Description Schema Version Since
ibnTarget IBNTarget Yes Target for intent-based navigation. 1.41.0 1.102
ibnParams Object<string,string> or Object<string,[string]> No Map of parameters for intent-based navigation that define an instance of the semantic object. The parameter value can be a string or an array of strings.
For example { "employeeID": "4" } 		1.41.0 1.102

Properties for IBNTarget

Property Type Default Value Required Description Schema Version Since
semanticObject string Yes Defines the business entity, which will be the target of the action. For example "Employee". 1.41.0 1.102
action string No Defines what operation to be performed on the semantic object. For example "display". 1.41.0 1.102

See intent-based navigation example.

Related information

Examples

Header level navigation action with static URL:

{
	"sap.card": {
		"header": {
			"title": "Some title",
			"actions": [
				{
					"type": "Navigation",
					"parameters": {
						"url": "/some/url",
						"target": "_self"
					}
				}
			]
		},
		...
	}
}

Intent-based navigation:

{
	"sap.card": {
		"type": "List",
		"content": {
			...
			"item": {
				"title": "{Name}",
				"actions": [
					{
						"type": "Navigation",
						"parameters": {
							"ibnTarget": {
								"semanticObject": "Application",
								"action": "display"
							},
							"ibnParams": {
								"applicationName": "{Name}"
							}
						}
					}
				]
			}
		}
	}
}
Try it Out