Configuring SAP Gateway and SAP Fiori

Objective

After completing this lesson, you will be able to configure SAP Gateway and SAP Fiori

Task List SAP_GW_FIORI_ERP_ONE_CLNT_SETUP

Figure shows an example of the Task List SAP_GW_FIORI_ERP_ONE_CLNT_SETUP

One of the prerequisites of task list SAP_FIORI_FOUNDATION_S4 is the execution of task list SAP_GW_FIORI_ERP_ONE_CLNT_SETUP.

Caution

Apply the latest version of SAP Notes 2510134 and 2639552 before executing task list SAP_GW_FIORI_ERP_ONE_CLNT_SETUP.

Task list SAP_GW_FIORI_ERP_ONE_CLNT_SETUP is for embedded deployments only. You use this task list to configure SAP Gateway and SAP Fiori on the same client where the business logic is located. The task list consists of tasks that are available with the following task lists:

  • SAP_GATEWAY_BASIC_CONFIG
  • SAP_FIORI_LAUNCHPAD_INIT_SETUP
  • /UI5/SCHEDULE_JOB_UPDATE_CACHE
  • SAP_GATEWAY_ACTIVATE_ODATA_SERV
  • SAP_BASIS_ACTIVATE_ICF_NODES

Some selected tasks of task list SAP_GW_FIORI_ERP_ONE_CLNT_SETUP are explained in more detail in the following sections.

Task: Configuration of SAP Web Dispatcher (HTTPURLLOC)

Use this configuration setting to define a URL that points to SAP Web Dispatcher instead of the current server.

This configuration setting is relevant, for example, if you want to start the FLP (transaction /UI2/FLP) or FLPD (transaction /UI2/FLPD_CONF resp. /UI2/FLPD_CUST) using SAP GUI.

Example of Task: URL of SAP Web Dispatcher, which is labeled

You need to be able to define a URL on the front-end server that does not point to the current system but to SAP Web Dispatcher. For this, the system administrator defines the hostname and port of SAP Web Dispatcher to be used in the start URL using transaction HTTPURLLOC (which will enter the maintenance of table HTTPURLLOC).

You may also maintain table HTTPURLLOC using table maintenance (transaction SM30) or data browser (transaction SE16).

Note

See SAP Note 2780619 for details on maintenance of table HTTPURLLOC.
Illustration of Task: Activate SAP Gateway

Before you can use SAP Gateway functionality, you have to activate it globally in your FES system. You can activate and deactivate SAP Gateway. When you deactivate it, all SAP Gateway services stop running, no consumer servers can communicate with it, and an error message is sent to any system that calls for the services.

You have multiple options to activate SAP Gateway in an SAP system:

  • In the Customizing (transaction SPRO), choose ABAP Platform→UI Technologies→SAP Fiori→Initial Setup→Connection Settings (Front-End Server to ABAP Back-End Server)→Activate SAP Gateway.

  • Start transaction /IWFND/IWF_ACTIVATE.

  • Alternatively, you can use the task list SAP_GATEWAY_BASIC_CONFIG to perform basic SAP Gateway settings, including the activation.

Figure shows Task: Create System Alias LOCAL (Maintenance using /IWFND/ROUTING)

The system alias is the result of the routing for an inbound request on SAP Gateway. It can be a remote or a local system. If that system alias is flagged as a Local GW (Local Gateway) instance, it means that the system that is responsible for processing (managing and storing) the data of an inbound request is the local SAP Gateway instance itself.

You have multiple options to maintain system aliases in an SAP system:

  • In the Customizing (transaction SPRO), choose ABAP Platform→UI Technologies→SAP Fiori→Initial Setup→Manual Setup without Task Lists→Connection Settings (Front-End Server to ABAP Back-End Server)→Define SAP System Alias.

  • Start transaction /UI2/GW_SYS_ALIAS.

  • In the Customizing (transaction SPRO), choose ABAP Platform→SAP Gateway→OData Channel→Configuration→Connection Settings→SAP Gateway to SAP System→Manage SAP System Aliases.

  • Enter transaction /IWFND/ROUTING.

  • Alternatively, you can use the task list SAP_GATEWAY_ADD_SYSTEM_ALIAS to add a system alias or task list SAP_GATEWAY_ADD_SYSTEM to add a back-end system, including the maintenance of a system alias.

Regardless of which tool you choose, system aliases are stored in view /IWFND/V_DFSYAL.

Figures shows an example of Task: Create System Alias LOCAL (Maintenance using /UI2/GW_SYS_ALIAS)

The last section on system alias LOCAL was added to this material for your reference. In an embedded hub scenario with up-to-date task lists, typically the processing mode Co-Deployed is used for SAP Gateway services.

The optimization for service processing in a co-deployed system is realized for a fast data transfer between the SAP Gateway system and the IW_BEP component on the local system. Using this processing mode, the routing configuration is not used and the OData request is directly passed to the IW_BEP component.

Note

In the context of this training, system alias LOCAL will be used:
  • By the reference apps (see the lesson Configuring Reference Apps)
  • As SAP back-end system alias (see the lesson Configuring Notifications)
Figure shows Task: Register SAP Gateway Services for FLP

These are the relevant SAP Gateway services for the SAP Fiori launchpad resp. the SAP Fiori launchpad designer:

/UI2/PAGE_BUILDER_CONF
This is used by the launchpad designer.
/UI2/PAGE_BUILDER_CUST

This is used by the launchpad designer.

/UI2/PAGE_BUILDER_PERS

This is used by the launchpad.

/UI2/TRANSPORT

This is used by the launchpad designer.

/UI2/INTEROP

This is used by the launchpad and launchpad designer.

You can use transaction /IWFND/MAINT_SERVICE to register (or check the registration status of) SAP Gateway services.

Figure shows Tasks: Activate ICF Services for FLP and UI5

In addition to the SAP Gateway services mentioned above, the launchpad and launchpad designer also need ICF services for the application resources. To activate them, you can use:

  • Transaction SICF to activate them separately

  • Task list SAP_FIORI_LAUNCHPAD_INIT_SETUP, task Activate HTTP Services for SAP Fiori Launchpad (SICF)

The task with description Activate HTTP Services for SAP Fiori Launchpad (SICF) of task list SAP_FIORI_LAUNCHPAD_INIT_SETUP tries to active those ICF services, which are stored with technical name /UI2/FIORI in table ICFINSTACT:

  • /sap/bc/ui2/start_up

  • /sap/bc/ui5_ui5/sap/ar_srvc_news

  • /sap/bc/ui5_ui5/sap/arsrvc_upb_admn

  • /sap/bc/ui5_ui5/ui2/ushell

  • /sap/public/bc/ui2

  • /sap/public/bc/ui5_ui5

  • /sap/bc/ui2/flp

  • /sap/bc/ui2/smi/rest_tunnel

  • /sap/bc/rest/themes

  • /sap/bc/ui2/app_index

  • /sap/bc/ui5/index

  • /sap/bc/lrep

SAPUI5 needs these ICF services for the application resources:

  • /sap/public/bc/ui5_ui5

  • /sap/bc/ui5_ui5/ui2

To activate them, you can use:

  • Transaction SICF to activate them separately

  • Task list SAP_FIORI_LAUNCHPAD_INIT_SETUP, task Activate HTTP Services for UI5 (SICF)

Task: Customize the Launchpad URL for Cache Buster

Web browsers store static resources, like JavaScript files, style sheets, and images in the browser cache. When these resources are changed on the server in a software upgrade, you want the browser to load the new resources from the server rather than from the cache, without having to manually clear the browser cache.

Cache buster techniques cause web browsers to load content from the server rather than from the browser cache when new resources are available on the server.

The cache buster for the SAP Fiori launchpad and SAP Fiori apps is based on versioned URLs. Cache buster tokens are added to the URLs of the resources. After a software update, URLs containing new tokens are used, which means that the browser considers these URLs as initial requests and loads the new resources from the server.

The advantage of this approach is that resources in the cache are only reloaded when a new version is available. Rather than simply limiting the time a resource may remain in the browser cache, the system invalidates the cache only when resources are actually updated on the server.

The task Customize Launchpad URL for Cache Buster of task list SAP_GW_FIORI_ERP_ONE_CLNT_SETUP creates an external alias /sap/bc/ui5_ui5/ui2/ushell/shells/abap referring to ICF service /sap/bc/ui2/flp.

Figure shows Task: Schedule Job for SAPUI5 Application Index Calculation

To use this indexing and caching mechanism for SAPUI5 applications, components, and libraries, you have to schedule the report /UI5/APP_INDEX_CALCULATE as a background job.

The SAPUI5 application index provides an indexing and caching mechanism for information related to SAPUI5 applications, components, and libraries that are contained in SAPUI5 repositories on the AS ABAP. This makes it possible to retrieve and find this information significantly faster than when carrying out the calculations each time it is requested.

The cached information consists of calculation results related to the back-end support for cache busting on SAPUI5 repository level. The indexing refers specifically to SAPUI5 applications or SAPUI5 components with a SAPUI5 component ID.

Figure shows an example of Invalidating Client Caches

You can use the program /UI2/INVALIDATE_CLIENT_CACHES on the front-end server to invalidate resources of SAP Fiori apps in client caches. This is only required if resources that are not included in the application index are updated as part of a patch.

Configure SAP Gateway and SAP Fiori using Task List SAP_GW_FIORI_ERP_ONE_CLNT_SETUP

Business Example

In this exercise, you will perform the required steps to configure SAP Gateway and SAP Fiori.

Note

In this exercise, when an object name or value contains ##, replace ## with the number your trainer assigns to you.

Task 1: Analyze Task List SAP_GW_FIORI_ERP_ONE_CLNT_SETUP

Steps

  1. In your SAP S/4HANA system, generate a task run for task list SAP_GW_FIORI_ERP_ONE_CLNT_SETUP (transaction STC01).

    Caution

    Do not execute the task list yet.

    1. Log on to your SAP system using the train-## user.

    2. Start transaction STC01.

    3. As Task List, select SAP_GW_FIORI_ERP_ONE_CLNT_SETUP and choose Generate Task List Run (F8).

    4. Do not execute this task list yet, but keep this SAP GUI window open.

  2. Read the help for the following task: Configuration of SAP Web Dispatcher (HTTPURLLOC). In a new SAP GUI window, analyze the current content of table, HTTPURLLOC.

    1. Choose the Help icon for the task with the description, Configuration of SAP Web Dispatcher (HTTPURLLOC).

    2. According to the help, this task can add an entry to table, HTTPURLLOC.

    3. In a new SAP GUI window, start transaction HTTPURLLOC.

    4. The table should be empty.

    5. Close this SAP GUI window to ensure that you hold no lock.

  3. Read the help for task Activate HTTP Services for NW Gateway (SICF). In a new SAP GUI window, analyze the activation status of some of the listed ICF services.

    1. Choose the Help icon for the task with the description, Activate HTTP Services for NW Gateway (SICF).

    2. According to the help, this task activates the following ICF services:

      • /SAP/OPU/ODATA/*
      • /SAP/PUBLIC/ICMAN
      • /SAP/PUBLIC/ICF_INFO/*

    3. In a new SAP GUI window, start transaction SICF.

    4. Choose Execute (F8).

    5. Navigate to some of the listed ICF services and note their activation status.

      Note

      ICF services colored black are active; ICF services colored gray or blue are inactive.

  4. Read the help for task Gateway Activation (/IWFND/IWF_ACTIVATE). In a new SAP GUI window, analyze the activation status of SAP Gateway.

    1. Choose the Help icon for the task with the description, Gateway Activation (/IWFND/IWF_ACTIVATE).

    2. According to the help, this task activates SAP Gateway.

    3. In a new SAP GUI window, start transaction /IWFND/IWF_ACTIVATE.

    4. A popup informs you about the SAP Gateway activation status. Make sure that it is deactivated:

      • If SAP Gateway is deactivated, choose Cancel.
      • If it SAP Gateway activated, choose Deactivate.

  5. Read the help for task Activate Gateway OData Services for Launchpad (/IWFND/MAINT_SERVICE). In a new SAP GUI window, analyze the activation status of SAP Gateway.

    1. Choose the Help icon for the task with the description, Activate Gateway OData Services for Launchpad (/IWFND/MAINT_SERVICE).

    2. According to the help, this task activates the following SAP Gateway services:

      • /UI2/INTEROP
      • /UI2/PAGE_BUILDER_PERS
      • /UI2/PAGE_BUILDER_CONF
      • /UI2/PAGE_BUILDER_CUST
      • /UI2/TRANSPORT

    3. In a new SAP GUI window, enter transaction /IWFND/MAINT_SERVICE.

    4. Select the Filter.

    5. As External Service Name, enter the base name of one of the listed SAP Gateway services (for example, INTEROP) and select Continue.

      An empty list indicates that no SAP Gateway service matching the filter criteria has been registered.

  6. Read the help for task Activate HTTP Services for SAP Fiori Launchpad (SICF). In a new SAP GUI window, analyze the activation status of some of the ICF services in scope.

    1. Choose the Help icon for the task with the description, Activate HTTP Services for SAP Fiori Launchpad (SICF).

    2. According to the help, this task activates the ICF services listed in table ICFINSTACT with group /UI2/FIORI.

    3. In a new SAP GUI window, enter transaction SM30.

    1. Enter view name ICFINSTACT and select Display (F6).

    2. Note all ICF services grouped with technical name /UI2/FIORI.

      Result: These ICF services are in scope:

      • /sap/bc/ui2/start_up

      • /sap/bc/ui5_ui5/sap/ar_srvc_news

      • /sap/bc/ui5_ui5/sap/arsrvc_upb_admn

      • /sap/bc/ui5_ui5/ui2/ushell

      • /sap/public/bc/ui2

      • /sap/public/bc/ui5_ui5

      • /sap/bc/ui2/flp

      • /sap/bc/ui2/smi/rest_tunnel

      • /sap/bc/rest/themes

      • /sap/bc/ui2/app_index

      • /sap/bc/ui5/index

      • /sap/bc/lrep

    1. In a new SAP GUI window, enter transaction SICF.

    2. Choose Execute (F8).

    3. Navigate to some of the listed ICF services (for example, /sap/bc/ui2/flp) and note their activation status.

      ICF services colored black are active; ICF services colored gray or blue are inactive.

Task 2: Execute Task List SAP_GW_FIORI_ERP_ONE_CLNT_SETUP

Steps

  1. In your SAP S/4HANA system, execute task list SAP_GW_FIORI_ERP_ONE_CLNT_SETUP (transaction STC01) in background mode with the following parametrization:

    • Select the task Configuration of SAP Web Dispatcher (HTTPURLLOC) and add the following entry:
      FieldValue
      Sort/Match Seq.1
      Host NameFill the qualified hostname of your SAP Web Dispatcher
      PortHTTPS port of your SAP Web Dispatcher
      Application Name/SAP/BC/UI2/FLP
    • Deselect the task Report /IWFND/R_COF_VIRUS_PROFILE - SAP Gateway Virus Scan Profile Configuration.

    Caution

    Make sure not to hold further locks before starting the execution; you may use transaction SM12 to list locks.

    1. Return to the SAP GUI window with the prepared task list run for task list SAP_GW_FIORI_ERP_ONE_CLNT_SETUP.

    2. Select Execute (first column of the table) for the task with description Configuration of SAP Web Dispatcher (HTTPURLLOC), then select Fill Parameters for this task.

    3. In the section, Create SAP Web Dispatcher Entry, enter the following:

      FieldValue
      Sort/Match Seq.1
      Host Name

      • Q team: fsqhost.wdf.sap.corp

      • P team: fsphost.wdf.sap.corp

      Port

      • Q team: 44320

      • P team: 44330

      Application Name/SAP/BC/UI2/FLP
      To save your settings, select Save, and choose Back.

    4. Deselect task Report /IWFND/R_COF_VIRUS_PROFILE - SAP Gateway Virus Scan Profile Configuration (note the flags in the column Execute, far left).

    5. Keep all settings unchanged and choose Start/Resume Task List Run in Background (F9).

    6. You may choose Auto (Set Auto Refresh Timer) to auto-refresh the task list run. Do not change the 60 seconds interval.

      Expect a runtime of about 10 minutes.

  2. After the task list was executed, analyze the content of table HTTPURLLOC.

    1. Enter transaction HTTPURLLOC.

    2. Note the entry performed by task Configuration of SAP Web Dispatcher (HTTPURLLOC).

  3. Analyze the activation status of some of the following ICF services:

    • /SAP/OPU/ODATA/*
    • /SAP/PUBLIC/ICMAN
    • /SAP/PUBLIC/ICF_INFO/*

    1. Enter transaction SICF.

    2. Choose Execute (F8).

    3. Navigate to some of the listed ICF services and note their activation status.

  4. Analyze the activation status of SAP Gateway.

    1. Start transaction /IWFND/IWF_ACTIVATE.

    2. A popup informs you about the SAP Gateway activation status. Do not change it!

  5. Analyze the activation status of some of the following SAP Gateway services:

    • /UI2/INTEROP
    • /UI2/PAGE_BUILDER_PERS
    • /UI2/PAGE_BUILDER_CONF
    • /UI2/PAGE_BUILDER_CUST
    • /UI2/TRANSPORT

    1. Enter transaction /IWFND/MAINT_SERVICE.

    2. Select the Filter.

    3. As External Service Name, enter the base name of one of the listed SAP Gateway services (for example, INTEROP) and select Continue.

  6. Analyze the activation status of some of the following ICF services:

    • /sap/bc/ui2/start_up

    • /sap/bc/ui5_ui5/sap/ar_srvc_news

    • /sap/bc/ui5_ui5/sap/arsrvc_upb_admn

    • /sap/bc/ui5_ui5/ui2/ushell

    • /sap/public/bc/ui2

    • /sap/public/bc/ui5_ui5

    • /sap/bc/ui2/flp

    • /sap/bc/ui2/smi/rest_tunnel

    • /sap/bc/rest/themes

    • /sap/bc/ui2/app_index

    • /sap/bc/ui5/index

    • /sap/bc/lrep

    1. Enter transaction SICF.

    2. Choose Execute (F8).

    3. Navigate to some of the listed ICF services (for example, /sap/bc/ui2/flp) and note their activation status.

Launch SAP Fiori Launchpad

Business Example

In this exercise, you will launch the SAP Fiori launchpad.

Note

In this exercise, when an object name or value contains ##, replace ## with the number your trainer assigned to you.

Task 1: SAP Secure Login Client

Steps

  1. To receive an X.509 client certificate, log on to the SAP Secure Login Server using the SAP Secure Login Client.

    1. You are connected to the WTS as Microsoft Windows user TRAIN-##.

    2. Launch the SAP Secure Login Client in the Microsoft Windows tray (the blue diamond icon).

    3. Right-click the entry SAP AS Java Authentication (UME) SLC (smhost.wdf.sap.corp) and choose Log In.

    4. Enter the credentials of your train-## user (provide the logon data of your train-## user in client 100 of system SMA, to which the UME of system SMJ is connected to).

      Figure shows a screenshot from the system - example of login

      In case the password of your train-## user in client 100 of system SMA is still initial, you have to provide a new password that meets the following requirements:

      Code Snippet
      1234
      login/min_password_lng = 10
login/min_password_lowercase = 1
login/min_password_uppercase = 1
login/min_password_digits = 1

    5. Close the SAP Secure Login Client window.

  2. Verify that you received an X.509 client certificate in the Microsoft Edge browser.

    1. You are connected to the WTS as Windows user TRAIN-##.

    2. Start Microsoft Edge.

    3. Open the Settings and more menu (using the three dots in the upper-right corner).

    4. Choose Settings.

    5. Navigate to Privacy, search, and services→Security→Manage certificates.

    6. On the Personal tab, an entry for your train-## user should show up.

    7. Double-click the entry for your train-## for further certificate details.

Task 2: SAP Fiori Launchpad in a Web Browser

Steps

  1. Launch the FLP using a Web Browser.

    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

    4. In case your web browser offers to use a certificate (with user TRAIN-##) for authentication, select it and choose OK.

      Figures shows screenshot of certificate for user authentication

    Result

    The FLP is displayed, but is empty.

Task 3: SAP Fiori Launchpad in SAP Business Client

Steps

  1. Create a new entry for your FLP in the SAP Business Client.

    1. You are connected to the WTS as Windows user TRAIN-##.

    2. Start the SAP Business Client.

    3. Choose Show Explorer View in the upper-left corner.

    4. In the tree at the left, select your area (20 Quality Assurance or 30 Production).

    5. Choose Create→New System Connection (SAP Fiori Launchpad).

    6. Keep User-specified system selected and choose Next.

    7. For Type, choose Web Dispatcher.

    8. 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

    9. Choose Finish.

      Figure shows the screens leading up to choosing Finish

  2. Launch the FLP in the SAP Business Client.

    1. You are connected to the WTS as Windows user TRAIN-##.

    2. Start the SAP Business Client.

    3. Double-click the entry you just created.

      SAP Home screen in figures

    Result

    The FLP is displayed, but is empty.

Launchpad URL

Figure shows a graphical outline of the configuration area in which the Launchpad URL is customized

After activating the SICF service for the launchpad with the cache buster, you can create an external alias for the default URL of the launchpad. This enables your users to use the same URL.

Alternatively, you can make the launchpad available under a short URL of your choice within your domain.

Screenshot from system showing the external alias for FLP

Using transaction SICF, you can create an external alias of your choice. For the target, choose /sap/bc/ui2/flp.

Learning

SAP FacebookSAP YoutubeSAP LinkedIn