Help ID
Since version 1.124, the rendered card has an attribute data-help-id
on its root element. Its default value is equal to the sap.app/id
from the card's manifest.
This data-help-id
is useful when connecting the card with a help system for the end user, e.g. "SAP Companion".
The data-help-id
can be overwritten by the card developer (in the card manifest), or by the host environment.
The order of priority is:
- Host environment with
oCard.data("help-id", "your-help-id", true);
. It overwrites all other options. - Card manifest
sap.card/configuration/helpId
. - Card manifest
sap.app/id
. (Default)
Example
In card manifest:{ "sap.app": { "id": "card.explorer.helpId.card", "type": "card" }, "sap.card": { "type": "List", "configuration": { "helpId": "your-help-id" }, "header": { "title": "Example with Help ID" } } }In host environment:
oCard.data("help-id", "your-help-id", true);