Difference between revisions of "Link Target"

From SAP Enable Now Wiki
(Redirected page to Link)
Tag: New redirect
 
Line 1: Line 1:
__NOTOC__
+
#REDIRECT [[Link]]
==Where to find it==
 
* ''Web Assistant Project'' > ''Text Editor'' > ''Insert Link'' dialog box > '''{{PAGENAME}}''' 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 {{PAGENAME}} 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:
 
{| class="wikitable"
 
|-
 
! Link Target !! Purpose !! Example
 
|-
 
! style="text-align:left;" | Help4.API.+ !!   !!
 
|-
 
| '''enableWhatsNew('''''value''''')'''  || Activate or deactivate What's New. ''value'' can be '''true'''&#124;'''false'''&#124;'''toggle'''. || <tt>Help4.API.enableWhatsNew(true)</tt>
 
|-
 
| '''openLearningApp('''''value''''')''' || Open or close the '''Learning''' section. ''value'' can be '''true'''&#124;'''false'''. || <tt>Help4.API.openLearningApp(true)</tt>
 
|-
 
| '''openWA('''''value''''')''' || Open or close the Web Assistant (Carousel?). ''value'' can be '''true'''&#124;'''false'''&#124;'''toggle'''. || <tt>Help4.API.openWA(false)</tt>
 
|-
 
| '''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. || <tt>Help4.API.selectHelpTile(3)<br />Help4.API.selectHelpTile('MAC_XXXXXXXXXX')</tt>
 
|-
 
| '''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. || <tt>Help4.API.selectTourStep(7)<br />Help4.API.selectTourStep('MAC_XXXXXXXXXX')</tt>
 
|-
 
| '''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. || <tt>Help4.API.showHelpBubble(3)<br />Help4.API.showHelpBubble('MAC_XXXXXXXXXX')</tt>
 
|-
 
| '''startProject('''''tour'',''value''''')''' || Start a specific Guided Tour. ''tour'' is the UID of the Guided Tour, and ''value'' is one of: <ul><li>'''true''': The Guided Tour is opened only if it is Published</li><li>'''false''': The Guided Tour is opened only if it is ''not'' published</li><li>'''all''': The Guided Tour is opened regardless of its Published state</li></ul>  || <tt>Help4.API.startProject(PR_XXXXXXXXXX,all)</tt>
 
|-
 
| '''tourNextStep()''' || Advance to the next step in the current Guided Tour || <tt>Help4.API.tourNextStep()</tt>
 
|-
 
| '''tourPrevStep()''' || Advance to the previous step in the current Guided Tour || <tt>Help4.API.tourPrevStep()</tt>
 
|}
 

Latest revision as of 02:15, 28 October 2021

Redirect to: