Link

From SAP Enable Now Wiki
Revision as of 02:14, 28 October 2021 by Admin (talk | contribs) (Created page with "__NOTOC__ ==Where to find it== * ''Web Editor'' > ''Web Assistant Project'' > ''Text Editor'' > ''Insert Link'' dialog box > '''{{PAGENAME}}''' field ==Purpose== This field s...")
(diff) ← Older revision | Latest revision (diff) | Newer revision → (diff)

Where to find it

  • Web Editor > Web Assistant Project > Text Editor > Insert Link dialog box > Link field

Purpose

This field specifies the URL of the target of a hyperlink in a Guided Tour or Context Help Bubble.

Use

The format of the Link will depend upon the type of link selected on the rightmost side of the Insert Link dialog box. Refer to the sections below for details.

App Link

This category of link can be used to open a specific S/4HANA 'application'. It is specified as the application name, preceded by a hashtag ('#'). This can typically be retrieved from the end of URL for the application.

Example:

#PurchaseOrder-manage

Help4 API Link

This category of link can be used to control the help information that is shown. It can be one of the following:

Link Target Purpose Example
Help4.API.+  
enableWhatsNew(value) Activate or deactivate What's New. value can be true|false|toggle. Help4.API.enableWhatsNew(true)
openLearningApp(value) Open or close the Learning section. value can be true|false. Help4.API.openLearningApp(true)
openWA(value) Open or close the Web Assistant (Carousel?). value can be true|false|toggle. Help4.API.openWA(false)
selectHelpTile(tile) Select a specific Help Tile and open its bubble. tile is specified as either the tile sequence number (not recommended!), or the tile UID in single quotes. Help4.API.selectHelpTile(3)
Help4.API.selectHelpTile('MAC_XXXXXXXXXX')
selectTourStep(step) Jump to a specific Tour Step. step is specified as either the Step sequence number (not recommended!), or the Step's UID in single quotes. Help4.API.selectTourStep(7)
Help4.API.selectTourStep('MAC_XXXXXXXXXX')
showHelpBubble(tile) Open the Bubble for a specific Help Tile (without selecting the Help Tile in the Carousel). tile can be specified as either the tile sequence number (not recommended!), or the tile UID in single quotes. Help4.API.showHelpBubble(3)
Help4.API.showHelpBubble('MAC_XXXXXXXXXX')
startProject(tour,value) Start a specific Guided Tour. tour is the UID of the Guided Tour, and value is one of:
  • true: The Guided Tour is opened only if it is Published
  • false: The Guided Tour is opened only if it is not published
  • all: The Guided Tour is opened regardless of its Published state
Help4.API.startProject(PR_XXXXXXXXXX,all)
tourNextStep() Advance to the next step in the current Guided Tour Help4.API.tourNextStep()
tourPrevStep() Advance to the previous step in the current Guided Tour Help4.API.tourPrevStep()