Difference between revisions of "UseGlobalHelp"

From SAP Enable Now Wiki
 
Line 3: Line 3:
  
 
==Scope==
 
==Scope==
Web Assistant parameter, specified either in the URL or in the Web Assistant parameters in the linked application.
+
SAP Companion parameter, specified either in the URL or in the SAP Companion parameters in the linked application.
  
 
==Purpose==
 
==Purpose==
This property is specific to support for SAPGui for HTML and WebDynpro apps running in the Fiori Launchpad. If no default Web Assistant content is available for these apps (as is usually the case) then setting this parameter to '''<tt>true</tt>''' will result in a specific (single, pre-defined, built-in) help tile being displayed that explain how to access help for the respective system. This appears in the Carousel as follows:
+
This property is specific to support for SAPGui for HTML and WebDynpro apps running in the Fiori Launchpad. If no default SAP Companion content is available for these apps (as is usually the case) then setting this parameter to '''<tt>true</tt>''' will result in a specific (single, pre-defined, built-in) help tile being displayed that explain how to access help for the respective system. This appears in the Carousel as follows:
  
 
[[File:UseGlobalHelp Tile.png|center|Example of the generic help tile displayed in the Carousel when useGlobalHelp=true.]]
 
[[File:UseGlobalHelp Tile.png|center|Example of the generic help tile displayed in the Carousel when useGlobalHelp=true.]]
Line 20: Line 20:
 
  useGlobalHelp=[true|'''false''']
 
  useGlobalHelp=[true|'''false''']
  
[[Category: Web Assistant parameter]]
+
[[Category: SAP Companion parameter]]

Latest revision as of 14:04, 14 July 2023


Scope

SAP Companion parameter, specified either in the URL or in the SAP Companion parameters in the linked application.

Purpose

This property is specific to support for SAPGui for HTML and WebDynpro apps running in the Fiori Launchpad. If no default SAP Companion content is available for these apps (as is usually the case) then setting this parameter to true will result in a specific (single, pre-defined, built-in) help tile being displayed that explain how to access help for the respective system. This appears in the Carousel as follows:

Example of the generic help tile displayed in the Carousel when useGlobalHelp=true.

Clicking on this Tile then displays the following help bubble:

Example of the Bubble displayed when clicking on the generic 'global help' tile.

If this parameter is set to true then the noHelpMode parameter should also be used, and set to carousel.

Usage

Specified as:

useGlobalHelp=[true|false]