Difference between revisions of "NoHelpMode"
(Created page with "__NOTOC__ {{DISPLAYTITLE: noHelpMode}} ==Scope== Web Assistant parameter, specified either in the URL or in the Web Assistant parameters in the linked application. ==Purpose...") |
(→Usage) |
||
| (6 intermediate revisions by the same user not shown) | |||
| Line 3: | Line 3: | ||
==Scope== | ==Scope== | ||
| − | + | SAP Companion parameter, specified either in the URL or in the SAP Companion parameters in the linked application. | |
==Purpose== | ==Purpose== | ||
| − | + | When the user navigates to an application page, SAP Enable Now checks the help content server to see if help is available for that specific page. The noHelpMode parameter determines what happens if no help is available (technically, if the '''onHelpAvailable''' event is triggered with a value of '''false'''). | |
| + | |||
| + | If you use a parameter of '''[[readCatalogue]]=false''' then this prevents the help content check from being made at the time the page is loaded, and defers it until the user clicks on the '''Help''' button. (This is often done in SuccessFactors, to prevent an additional authorization check being performed when the user first logs on.) This is obviously a problem if the '''Help''' button is not displayed, as the user has no way of calling up the help (actually, they can press '''F1''' but there is no indication that they can do this). Therefore, if you use '''[[readCatalogue]]=false''' you should also set '''[[noHelpMode]]''' to '''nothing''' or '''carousel''' (and '''carousel''' is recommended). | ||
==Usage== | ==Usage== | ||
Specified as: | Specified as: | ||
| − | noHelpMode=Carousel | + | noHelpMode=['''hidebutton'''|nothing|carousel] |
| − | + | or | |
| − | [[Category: | + | noHelp=['''hidebutton'''|nothing|carousel] |
| + | These values have the following effects: | ||
| + | {| class="wikitable" | ||
| + | |- | ||
| + | ! Value !! effect | ||
| + | |- | ||
| + | | <tt>hidebutton</tt> || The '''Help''' button is hidden when no help is available. | ||
| + | |- | ||
| + | | <tt>nothing</tt> || The '''Help''' button is displayed, even if not help is available. Clicking on it will display the "No help available" dialog box (which can be confusing for users, so this is not recommended). | ||
| + | |- | ||
| + | | <tt>carousel</tt> || The '''Help''' button is displayed, even if not help is available. Clicking on it will open the ''[[Carousel]]'', with either the ''Learning'' page displayed (if configured to display), or an empty ''Help Topics'' page. | ||
| + | |} | ||
| + | [[Category: SAP Companion parameter]] | ||
Latest revision as of 21:53, 9 November 2023
Scope
SAP Companion parameter, specified either in the URL or in the SAP Companion parameters in the linked application.
Purpose
When the user navigates to an application page, SAP Enable Now checks the help content server to see if help is available for that specific page. The noHelpMode parameter determines what happens if no help is available (technically, if the onHelpAvailable event is triggered with a value of false).
If you use a parameter of readCatalogue=false then this prevents the help content check from being made at the time the page is loaded, and defers it until the user clicks on the Help button. (This is often done in SuccessFactors, to prevent an additional authorization check being performed when the user first logs on.) This is obviously a problem if the Help button is not displayed, as the user has no way of calling up the help (actually, they can press F1 but there is no indication that they can do this). Therefore, if you use readCatalogue=false you should also set noHelpMode to nothing or carousel (and carousel is recommended).
Usage
Specified as:
noHelpMode=[hidebutton|nothing|carousel]
or
noHelp=[hidebutton|nothing|carousel]
These values have the following effects:
| Value | effect |
|---|---|
| hidebutton | The Help button is hidden when no help is available. |
| nothing | The Help button is displayed, even if not help is available. Clicking on it will display the "No help available" dialog box (which can be confusing for users, so this is not recommended). |
| carousel | The Help button is displayed, even if not help is available. Clicking on it will open the Carousel, with either the Learning page displayed (if configured to display), or an empty Help Topics page. |
