Tell us what you think

We want to create the best possible experience for our learners. Your feedback helps us to improve the experience for everyone.

Configuring In-App Help

Objective

After completing this lesson, you will be able to configure In-App Help

SAP Enable Now and SAP Companion

Provide the knowledge your employees need to succeed exactly where and when it is needed with SAP Enable Now. Advanced capabilities help you improve productivity, user adoption, and the end-user experience. Easily create, maintain, and deliver performance support, learning material, and documentation content.

SAP Companion by SAP Enable Now is a help system to provide you with context-sensitive user assistance. It enables you to get started quickly and to find all relevant information easily without needing to leave the respective application. SAP Companion provides additional information directly on top of the current application screen.

SAP Companion is everything you’ve ever wished for as a software user:

Embedded in-application help at the point of need
Free standard content to get you started
Guidance through difficult processes to take the load off you
Tips and tricks from key users
Links out to other helpful repositories like the SAP Community
Multimedia training at your fingertips so you can pick the way you learn best
Always stay up-to-date with the What’s New content
And much more!

An introduction to SAP Companion is provided in the blog, Introducing: SAP Companion – Your Adoption and Productivity Layer, at https://community.sap.com/t5/human-capital-management-blogs-by-sap/introducing-sap-companion-your-adoption-and-productivity-layer/ba-p/13546849.

Note

The in-app help in the SAP Fiori launchpad is also based on the SAP Companion technology by SAP Enable Now.

For more information on SAP Enable Now, visit the product page at https://help.sap.com/docs/SAP_ENABLE_NOW. For the integration into the SAP Fiori launchpad, note the SAP Companion Integration guide on the SAP Enable Now product page.

SAP Companion supports different scenarios for providing help content for your apps and needs:

Standard Content Scenario: Provides SAP standard content for your apps.

Extended Content Scenario: Provides SAP standard content for your apps. Allows you to customize the standard content and to add user-defined content.

Custom Content Scenario: Allows you to add user-defined content for your apps.

For more on SAP Enable Now, refer to the following:

SAP Enable Now product page at https://help.sap.com/docs/SAP_ENABLE_NOW?locale=en-US
SAP Enable Now Learning Journeys at https://help.sap.com/learning-journeys/b238ea240fd24b5995f7efb524e5142e
SAP classes starting with SEN - for example, SEN100, SEN200, and SEN300

Figure shows SAP Companion, a component of SAP Enable Now

Depending on the context in the FLP, the context-sensitive Recommended Learning or the non-context-sensitive Learning Center will open when a user selects Open Help. From the Recommended Learning pop-up, users can also navigate to the Learning Center.

An introduction to this topic is provided in the blog, SAP Fiori for SAP S/4HANA – How to setup the User Assistant in your S/4HANA Fiori launchpad, at https://community.sap.com/t5/technology-blogs-by-sap/sap-fiori-for-sap-s-4hana-how-to-setup-the-user-assistant-in-your-s-4hana/ba-p/13448214.

In-App Help Plugin

Figure shows a graphical outline for In-App Help – Configuration Areas

To enable the in-app help for the SAP Fiori launchpad, the in-app help plugin (part of the Central UI) has to be configured. The help content ("content server") and the rendering logic ("script server") reside on web servers outside the SAP system. Customers may refer to web servers operated by SAP, or set up their own web servers.

These web servers are either accessed by the FES system, or by an SAP Web Dispatcher. The use of SAP Web Dispatcher for the enabling of in-app help is mandatory

in case of a SAP_UI release lower than 7.55 SP02 (see SAP Note 3022494)
if the FES system has no network access to the designated web servers

Once you have correctly configured the help settings, the context-sensitive user assistance will be available on the SAP Fiori launchpad and back-end help links to the product assistance will work.

Options to Configure the In-App Help

Figure outlines the options that allow you to configure In-App Help

The product and release of the displayed in-app help are controlled by the in-app help plugin. At first approximation, there are two options to configure the in-app help plugin:

Using FLP configuration
Using target mapping

In-App Help – FLP Configuration

In-App Help Plugin – Configuration using Task List

Task Configure Help Settings (SHELP_CONFIG) of task list SAP_FIORI_FOUNDATION_S4 configures the in-app help plugin by executing transaction SHELP_CONFIG with the default settings.

Figure shows In-App Help Plugin – Configuration using Transaction SHELP_CONFIG

Transaction SHELP_CONFIG enables customers to automatically configure back-end settings relevant for documentation on SAP Help Portal (propagated to transaction SR13) and front-end settings, which are relevant for in-app help in an embedded or hub deployment scenario (propagated to transaction /UI2/FLP_CUS_CONF).

Note

Transaction SHELP_CONFIG is the successor of transaction HELP_CONFIG.

For more details on this simplified configuration of help links, refer to the blog Simplified Configuration of Help Links in SAP S/4HANA at https://community.sap.com/t5/technology-blogs-by-sap/simplified-configuration-of-help-links-in-sap-s-4hana/ba-p/13469280.

Figure shows In-App Help Plugin – Configuration using FLP Settings

The figure shows which settings are applied to the FLP plugin WEB_ASSISTANT_HELP_PLUGIN by executing transaction SHELP_CONFIG with the default settings.

In case of manual maintenance (so not through task list SAP_FIORI_FOUNDATION_S4), these settings can be performed on two configuration levels:

System-wide (cross-client) using transaction /UI2/FLP_SYS_CONF
Client-specific using transaction /UI2/FLP_CUS_CONF

Note

The setting VERSION = 2023.latest sets up the help to link to the latest published in-app help of the release. If you wish to link to user assistance for a specific release (for example to the version for SAP S/4HANA 2023 FPS02), please see SAP Note 2954479.

In-App Help – Target Mapping

Alternatively, you can prepare a target mapping for the Shell-plugin intent:

Figure shows an example of the In-App Help Plugin – Configuration using Target Mapping

In a catalog that is available for your end-users, create a target mapping with the following values:

Field/Object	Value
Semantic Object	Shell
Action	`plugin`
Application Type	SAPUI5 Fiori App
Title	`In-App Help Plugin`
URL	`/resources/sap/dfa/help/utils/adapters/fiori`
ID	`sap.dfa.help.utils.adapters.fiori`
Information	`User Assistance Plugin`
Device Types	Desktop / Tablet / Phone
Parameters
Name: `product`	Default Value: `SAP_S4HANA_ON-PREMISE`
Name: `version`	Default Value: `2023.latest`
Name: `editor`	Default Value: `false`

Note

The variant with the Shell-plugin intent requires an SAP Web Dispatcher with properly configured routing rules (see the next concept for details).

After you have made these settings, the user assistance icon is available in the SAP Fiori launchpad.

SAP Companion, a component of SAP Enable Now

This class will not cover the complete configuration SAP Companion, a component of SAP Enable Now. The following settings for the WEB_ASSISTANT_HELP_PLUGIN make the SAP standard content available for your users:

FLP Property ID	Property Value
`LEARNING_APP_BACKEND_URL`	`https://education.hana.ondemand.com/education`
`LEARNING_APP_WORKSPACE`	`s4`

Use In-App Help without SAP Web Dispatcher

Task 1: Check the Settings for In-App Help

Steps

In your SAP S/4HANA system, access the help text of the following activity:
Task list: SAP_FIORI_FOUNDATION_S4
Task: Configure Help Settings (SHELP_CONFIG)
1. Log on to your SAP system using the train-## user.
2. Enter transaction STC02.
3. In the Task List field, enter *s4.
4. Choose Start Search (F8).
5. In the list of task list runs, double-click the line for task list SAP_FIORI_FOUNDATION_S4.
6. Select the Help icon for the task with the description Configure Help Settings (SHELP_CONFIG). Read the text. When done, Close the pop-up.
Open the default help settings (transaction SHELP_CONFIG).
1. Continue working in your SAP system using the train-## user.
2. Enter transaction SHELP_CONFIG.
3. Note the default settings.
  Note
  Do not execute this configuration.
Open the current settings for the WEB_ASSISTANT_HELP_PLUGIN FLP Plugin.
1. Continue working in your SAP system using the train-## user.
2. Enter transaction /UI2/FLP_CUS_CONF (FLP Customer Settings).
3. In the Dialog Structure pane (at the left), double-click FLP Plugins.
4. In case of multiple configured plugins, double-click WEB_ASSISTANT_HELP_PLUGIN.
5. In the Dialog Structure pane (at the left), double-click Configuration.
6. Note the current settings (without modifying them).
  Note
  These settings were applied by task Configure Help Settings (SHELP_CONFIG) of task list SAP_FIORI_FOUNDATION_S4, which executed transaction SHELP_CONFIG with the default settings.

Task 2: Test the In-App Help

Steps

Launch the SAP Fiori launchpad of your SAP S/4HANA system and note the Open Help link in the upper-right area.
1. Start or reload the SAP Fiori launchpad of your SAP system in a client of your choice.
2. Select the Open Help link in the upper-right area.
3. The context-sensitive online documentation should be displayed.
4. Open some of your apps and note if the Open Help link is offered - for example, for the View Browser app.
  Note
  For some SAP Fiori apps (for example, all classic applications), no in-app help is available.
Open some content offered in the Learning Center.
1. Select the Open Help link in the upper-right area.
2. Select the Learning link (doctor hat icon) in the help pane.
3. Feel free to access some of the offered learning content.

Result

Users can access the in-app help in their FLP.

SAP Web Dispatcher Configuration

Using a SAP Web Dispatcher is mandatory for the enabling of in-app help:

in case of a SAP_UI release lower than 7.55 SP02 (see SAP Note 3022494)
if the FES system has no network access to the designated web servers ("content server" and "script server")

SAP Web Dispatcher is also a good choice if you want to keep the load caused by accessing in-app help out of your SAP system(s).

Screenshot related to In-App Help, more specifically, about SAP Web Dispatcher Settings

The assumption is that you have already installed and configured SAP Web Dispatcher for your FES system.

To enable the in-app help, add the following parameters to the SAP Web Dispatcher profile:

Code Snippet

12345
wdisp/system_<number> = SID=<SID1>, EXTSRV=https://cp.hana.ondemand.com, SRCURL=/sap/dfa/help/, SRCSRV=*:*, PROXY=<your proxy>:<your proxy port>, STANDARD_COOKIE_FILTER=OFF

wdisp/system_<number> = SID=<SID2>, EXTSRV=https://xray.hana.ondemand.com, SRCURL=/resources/sap/dfa/help/, SRCSRV=*:*, PROXY=<your proxy>:<your proxy port>, STANDARD_COOKIE_FILTER=OFF

icm/HTTP/mod_0 = PREFIX=/, FILE=$(DIR_PROFILE)/redirect.txt

Make sure that the numbers following wdisp/system_ are smaller than the numbers that you use for all your application server. The rules for the context-sensitive user assistance need to come before the rules for the application servers. Make sure that the SIDs are not the same as your system IDs.

Note

In case of customer-specific web servers, replace the URLs for the content server (here: https://cp.hana.ondemand.com) and the script server (here: https://xray.hana.ondemand.com) accordingly.

Create a redirect.txt file with the following content:

Code Snippet

12345678910111213141516
# disable HSTS by the "external" hosts
SetResponseHeader strict-transport-security max-age=0

# User Assistance Content Platform - rewrite rule
if %{SID} = <SID1>
begin
	SetHeader HOST cp.hana.ondemand.com
	RegRewriteRawUrl ^/sap/dfa/help/(.*) /dps/$1
end

# Script Server - rewrite rule
if %{SID} = <SID2>
begin
	SetHeader HOST xray.hana.ondemand.com/
	RegRewriteRawUrl ^/resources/sap/dfa/help/(.*) /xRayControls/resources/sap/dfa/help/$1
end

Make sure that the <SIDs> in the redirect.txt file is the same as in the SAP Web Dispatcher profile.

Configure In-App Help with SAP Web Dispatcher

Task 1: Configure Help Settings with SAP Web Dispatcher

Steps

Execute transaction SHELP_CONFIG for a scenario with SAP Web Dispatcher.
1. Log on to your SAP system using the train-## user.
2. Enter transaction SHELP_CONFIG.
3. In field Without Web Dispatcher, choose No.
4. Keep all other settings unchanged and choose Execute (F8).

Task 2: Test the In-App Help 1/2

Steps

Launch the SAP Fiori launchpad of your SAP S/4HANA system. Make sure to use the URL of your SAP Web Dispatcher.
1. You are connected to the WTS as Windows user TRAIN-##.
2. Start a web browser of your choice.
3. Enter the following URL:
  - Q team: https://fsqhost.wdf.sap.corp:44320/sap/bc/ui2/flp
  - P team: https://fsphost.wdf.sap.corp:44330/sap/bc/ui2/flp
Note the upper-right area of your browser window – is the Open Help icon being displayed?
1. Result: the Open Help icon does not show up.

Task 3: Access to User Assistance Content Platform and Script Server

Steps

Using an SSH connection in MobaXterm, log on to the operating system of your feature server. Use the virtual hostname fs<q|p>host.wdf.sap.corp and the operating system user wd<q|p>adm.
1. On the WTS, launch the application MobaXterm.
2. Within the MobaXterm main window, choose Session.
3. In the Connection settings dialog, choose SSH.
4. Enter the following:
  Remote host
  Q team: fsqhost.wdf.sap.corp
  P team: fsphost.wdf.sap.corp
  Specify username select this option
  Field right to Specify username
  Q team: wdqadm
  P team: wdpadm
5. Keep all other settings unchanged and choose OK.
6. Enter the password of the user wd<q|p>adm (which should be SAPWebDisp##).
  Hint
  There is no visual feedback while you are typing the password. After you entered the correct password, MobaXterm may ask if you want to store the password permanently. If you want to, you have to provide an arbitrary master password for MobaXterm (two times).
Open the generated instance profile (in folder /usr/sap/<SAP Web Disp SID>/SYS/profile) of your SAP Web Dispatcher with a text editor of your choice.
1. You are logged on to the operating system level of your feature server with operating system user wd<q|p>adm.
2. Open the generated instance profile of your SAP Web Dispatcher with a text editor of your choice.
  - Q team: /usr/sap/WDQ/SYS/profile/WDQ_W20_fsqhost
  - P team: /usr/sap/WDQ/SYS/profile/WDP_W30_fsphost
  Hint
  From an SSH session to your feature server, you can submit the following command to open the profile using the gedit editor:
  Q team: gedit /usr/sap/WDQ/SYS/profile/WDQ_W20_fsqhost
  P team: gedit /usr/sap/WDP/SYS/profile/WDP_W30_fsphost
  It may take a moment until the editor appears.
Replace the content of the Back-end system configuration section with the content offered in file S:\Courses\UX200_24\Configure_In-App_Help_with_SAP_Web_Dispatcher\for <Q|P> group.txt (at WTS operating system (Windows) level).
For your reference, here is the new content :
Code Snippet
```
123456789101112
wdisp/system_0 = SID=EX1, EXTSRV=https://cp.hana.ondemand.com:443, SRCURL=/sap/dfa/help/, SRCSRV=*:*, PROXY=proxy:8080, STANDARD_COOKIE_FILTER=OFF

wdisp/system_1 = SID=EX2, EXTSRV=https://xray.hana.ondemand.com:443, SRCURL=/resources/sap/dfa/help/, SRCSRV=*:*, PROXY=proxy:8080, STANDARD_COOKIE_FILTER=OFF

wdisp/system_2 = SID=S4Q, MSHOST=s4qhost.wdf.sap.corp, MSPORT=8120, SSL_ENCRYPT=2, SRCURL=/

# the following line is for the P teams
# wdisp/system_2 = SID=S4P, MSHOST=s4phost.wdf.sap.corp, MSPORT=8130, SSL_ENCRYPT=2, SRCURL=/

wdisp/system_conflict_resolution = FIRST_MATCH

icm/HTTP/mod_1 = PREFIX=/, FILE=$(DIR_PROFILE)/redirect.txt
```
Note
The lines contain breaks. This is due to the formatting of the handbook. Ignore the line breaks.
1. Delete (or comment out using a # sign as the first character of each line) the parameters in the Back-end system configuration section.
2. Open the S:\Courses\UX200_24\Configure_In-App_Help_with_SAP_Web_Dispatcher\for <Q|P> group.txt file with a text editor of your choice.
3. Copy the content of the for <Q|P> group.txt file into the Back-end system configuration section of the instance profile of your SAP Web Dispatcher.
4. Save your changes.
Create a new file redirect.txt in the profile directory of your SAP Web Dispatcher with the following content:
Code Snippet
```
12345678910111213141516
# disable HSTS by the "external" hosts
SetResponseHeader strict-transport-security max-age=0

# User Assistance Content Platform - rewrite rule
if %{SID} = EX1
beginSetHeader HOST cp.hana.ondemand.com:443
SetHeader HOST cp.hana.ondemand.com:443
RegRewriteRawUrl ^/sap/dfa/help/(.*) /dps/$1
end

# Script Server - rewrite rule
if %{SID} = EX2
begin
SetHeader HOST xray.hana.ondemand.com:443
RegRewriteRawUrl ^/resources/sap/dfa/help/(.*) /xRayControls/resources/sap/dfa/help/$1
end
```
Hint
Note the helper file offered at /kpstransfer/Courses/UX200_24/Configure_In-App_Help_with_SAP_Web_Dispatcher/redirect.txt (at Feature Server operating system (Linux) level).
1. Copy the helper file offered at /kpstransfer/Courses/UX200_24/Configure_In-App_Help_with_SAP_Web_Dispatcher/redirect.txt (at Feature Server operating system (Linux) level) to the folder /usr/sap/<SAP Web Disp SID>/SYS/profile.
  Hint
  From an SSH session to your feature server, you can submit the following command to copy the redirect.txt file:
  Q team: cp /kpstransfer/Courses/UX200_24/Configure_In-App_Help_with_SAP_Web_Dispatcher/redirect.txt /usr/sap/WDQ/SYS/profile/
  P team: cp /kpstransfer/Courses/UX200_24/Configure_In-App_Help_with_SAP_Web_Dispatcher/redirect.txt /usr/sap/WDP/SYS/profile/
Restart your SAP Web Dispatcher.
1. Restart your SAP Web Dispatcher system, for example, by using SAP MC or SAPcontrol.
  Hint
  From an SSH session to your feature server with user <SAP Web Disp SID>adm, you can submit the following command to restart your SAP Web Dispatcher system using SAPcontrol:
  Q team: sapcontrol -nr 20 -function RestartSystem ALL
  P team: sapcontrol -nr 30 -function RestartSystem ALL

Task 4: Trust with User Assistance Content Platform and Script Server

Steps

Open and log on to the Web Admin UI of your SAP Web Dispatcher.
1. On the WTS, start a web browser.
2. Enter the URL of the Web Admin UI of your SAP Web Dispatcher (https://<fully qualified SAP Web Dispatcher hostname>:443$$/sap/wdisp/admin).
  - Q team: https://fsqhost.wdf.sap.corp:44320/sap/wdisp/admin
  - P team: https://fsphost.wdf.sap.corp:44330/sap/wdisp/admin
  Note
  You may also use the browser favorite/bookmark prepared at the following:
  Q team: 20 Quality Assurance → fsqhost → 20 WDQ SAP Web Dispatcher Administration
  P team: 30 Production → fsphost → 30 WDP SAP Web Dispatcher Administration
3. When asked for credentials, provide the following:
  - User: webadm
  - Password: <your master password> (which should be SAPWebDisp##)
Import the Root Certificate of the User Assistance Content Platform and Script Server into the SAP Web Dispatcher Client PSE.
1. In the Web Admin UI of your SAP Web Dispatcher, navigate to EX1 → Monitor Application Servers. This will open the External System view.
2. Note the Name column, which shows the "application server" of the SAP Content Platform.
3. Select the Host Menu for this "application server" (by clicking on it), and choose Establish Trust.
4. In the line for certificate type Root Certificate, choose Import Certificate into SAPSSLC.pse (at the right, in the Actions column).
5. Choose Import.

Result

You have imported the Root Certificate of the User Assistance Content Platform and Script Server into the SAP Web Dispatcher Client PSE.

Task 5: Test the In-App Help 2/2

Steps

Launch the SAP Fiori launchpad of your SAP S/4HANA system. Make sure to use the URL of your SAP Web Dispatcher.
1. You are connected to the WTS as Windows user TRAIN-##.
2. Start a web browser of your choice.
3. Enter the following URL:
  - Q team: https://fsqhost.wdf.sap.corp:44320/sap/bc/ui2/flp
  - P team: https://fsphost.wdf.sap.corp:44330/sap/bc/ui2/flp
Note the upper-right area of your browser window – is the Open Help icon being displayed?
1. Result: the Open Help icon does show up (and should work as expected).

Next lesson