Maintaining UI-related Software Components

Objectives

After completing this lesson, you will be able to:
  • Perform an update to the latest Unified Rendering patch
  • Perform an update to the latest SAPUI5 patch

Update Unified Rendering

Unified Rendering (UR) is a high performance client- and server-side HTML5 and JavaScript based rendering UI library that is optimized for consumption of SAP legacy applications. It was continuously improved over the years and will be further enhanced. Unified Rendering combines flexibility with known SAP strengths such as enterprise readiness and full product standard support:

  • One consistent user experience for your applications

  • Desktop based browser support for Google Chrome, Apple Safari, Mozilla Firefox, Microsoft Edge and IE11 (Standards & Quirks Mode)

  • Feature-rich UI controls for handling complex UIs

  • Keyboard interaction support and accessibility features incl. ARIA support

  • Full translation support and right-to-left (RTL) enabled

  • Based on open standards like JavaScript, CSS, and HTML5

  • Support of all existing SAP themes including SAP Corbu, SAP Belize and High Contrast Themes for SAP Fiori use cases

  • Powerful theming support to customize look & feel using SAP Theme Designer

  • Integration of active content (depends on browser): Adobe Forms, MS Office, Flash, ActiveX, Java Applet

There are two variants of Unified Rendering available:

UR Lightspeed
  • Used by the UI frameworks Web Dynpro ABAP (Floorplan Manager), SAP GUI for HTML, Web Dynpro Java and others
  • Based on a release-independent codeline

  • Fixes and browser adaptions delivered once a month as cumulative patch (for example part of the Web Dynpro ABAP TCI Note or SAP Kernel for SAP GUI for HTML) to ensure high quality

  • Version identifier based on the schema <year><month> (for example "2109") and on technical CSS theming version (for example "10.30.7.336851.0")
  • New features are delivered indirectly by the UI frameworks, for example with a new AS ABAP release or Support Package (Stack)
UR Classic (deprecated)
  • Used by SAP Enterprise Portal (Knowledge Management), BSP, BI BEX
  • No support for modern styles (Corbu, Blue Crystal, Belize)

The components of the UR architecture are:

  • Control-Interface & Control-Renderer
    • Common definition of HTML Renderer written in XML
    • Compiled into various programming languages (ABAP, C++, Java, JavaScript)
    • Used by multiple programming models
  • JavaScript Framework
    • Small initial JS Framework
    • On-demand loading and lazy instantiation of control specific JavaScript
    • Lazy instantiate of JS Controls
    • Client side capabilities
  • Theming
    • Based on LessCSS Theming using Theme Designer
    • UI Framework independent parameters shared by all SAP UI technologies (for example SAPUI5)

The update procedure for UR Lightspeed depends on the UI framework:

  • An overall overview about the Unified Rendering Lightspeed patch process for all UI Frameworks is given in SAP Note 2500800 – UR: General information about cumulative patches for Unified Rendering

  • For SAP GUI for HTML, update the SAP Kernel (see SAP Note 2504011 – SAP GUI for HTML: Unified Rendering Update - Instructions and Forecasts)

  • For Web Dynpro ABAP, use the TCI Note mechanism (as described below)

To check the version of UR in an ABAP-based SAP system, execute program WDG_MAINTAIN_UR_MIMES (using transaction SA38, for example).

To update UR Lightspeed for Web Dynpro ABAP in an ABAP-based SAP system, perform the following steps:

  1. Check if your SAP system is enabled for Transport-based Correction Instructions (TCI). Consult SAP Note 2187425 – Information about SAP Note Transport based Correction Instructions (TCI) and carefully read the attachment TCI_for_Customer.pdf.

  2. If required: apply a SPAM/SAINT update.

  3. Consult the central SAP Note 2090746 – WD ABAP: Unified Rendering Update with TCI - Instructions and Related SAP Notes on Unified Rendering update with TCI to determine the most recent TCI Note for your SAP release.

  4. Download the proper note using transaction SNOTE.

  5. Import the TCI transport and the corresponding TCI UR SAP Note using transaction SNOTE.

  6. If you are using a custom theme, it might be necessary to install new theme meta data in the ABAP Backend or SAP Enterprise Portal and to regenerate the custom theme:

    • Using the Theme Designer in AS ABAP: meta data is shipped using Web Dynpro ABAP TCI Note.

    • Using Theme Designer in SAP Enterprise Portal: Themes are shipped with EP-BASIS.SCA respectively EP-FLP.sca.

Related Information

Update Unified Rendering (UR) using TCI

Business Example

Your company uses many Web browser-based functions offered by your SAP system. Some of them are based on Web Dynpro for ABAP.

As an administrator, you want to update Unified Rendering for Web Dynpro ABAP.

Steps

  1. Determine the UR version of your SAP S/4HANA system.

    1. Log on to your SAP system with the credentials of your course user that is provided by your instructor (for example user train-##).

    2. Start transaction SA38.

    3. As Program, enter WDG_MAINTAIN_UR_MIMES.

    4. Choose Execute (F8).

    5. If available, double-click Show Extended Info.

    6. In section Unified Rendering Attributes, note the values of urpatch and urversion (see the screenshot for an example). Keep this session open.

    Result

    You know the UR version before the update.

  2. Apply the latest UR file offered on the training share in subfolders of folder S:\Maintenance\s4Xhost\UR using SAP Note transport-based correction instructions (TCI). The subfolder naming schema is TCI_SAPnote<NoteNumber>-<Year><Month> (for example TCI_SAPnote3523554-2411 from November 2024).

    Note

    In this training, each stage (development, quality assurance and production) is treated as a separate system. In a real scenario, you would release the transport request in your development system and import it to quality assurance and production systems.

    1. Following the previous step, in your assigned SAP system open a new SAP GUI sesion and start transaction SNOTE.

    2. In the menu, choose Goto → Upload TCI.

    3. In the file select box, browse to the matching SAR file on the training share in folder S:\Maintenance\s4Xhost\UR\TCI_SAPnote<NoteNumber>-<Year><Month> (your instructor will provide details). Write down the SAP Note number (part of the name of the subfolder).

    4. Select that SAR file and choose Open. This will take some time.

    5. In the Content of the compressed file <filename> popup, choose Decompress.

    6. Back on the start screen of transaction SNOTE, in the menu, choose Goto → Download SAP Note.

    7. Enter the SAP Note number matching the TCI file (part of the name of the subfolder – see the following figure as an example). When done, choose Execute (F8).

    8. Mark the line with the SAP Note in the table at the bottom (on tab Download/Upload Results). Then choose SAP Note → Implement SAP Note (Ctrl+F1) (alternatively, choose Implement SAP Note in the table at the bottom).

    9. In the SAP Note Implementation <SAP Note Number> window, keep all default settings and choose Next.

      Note

      You may be required to implement one or multiple further SAP Notes as prerequisite. In this case, implement them as well. This is not described in this solution as the prerequisite SAP Notes may change over time.

    10. In case of an error message "Failed to extract file SIGNATURE_<SAPNoteNumber>.SMF in path /usr/sap/trans/tmp<SAPNoteNumber>.SAR. See the application log.":

      1. Log on with user install to the operating system level of your SAP S/4HANA system (s4qhost|s4phost).
      2. Delete the file /usr/sap/trans/tmp/<SAPNoteNumber>.SAR.

      Note

      The root cause is conflicting file permissions for the extracted SAP Note signature file. In real life scenarios, you would implement the SAP Note in your development system only.

    11. In the Prompt for local workbench request popup, choose Create Request (F8).

    12. In the Create Request popup, enter any Short Description (for example Update UR) and choose Save (Enter).

    13. In the Prompt for local workbench request popup, now choose Continue (Enter).

    14. In the SAP Note Implementation <SAP Note number> popup, choose Next.

      Note

      Be patient, the implementation will take a while (around 10 minutes).

      Maybe you need to confirm the implementation of additional notes first.

  3. Determine the UR version of your SAP S/4HANA system again.

    1. If you have not yet already done, log on to your SAP system with the credentials of your course user that is provided by your instructor (for example user train-##).

    2. Start transaction SA38.

    3. As Program, enter WDG_MAINTAIN_UR_MIMES.

    4. Choose Execute (F8).

    5. Double-click Deploy MIMEs (this may take some time).

    6. In section Unified Rendering Attributes, note the values of urpatch and urversion (see the following screenshot as an example) and compare them with the values that you have received in a previous task.

    Result

    You know the UR version after the update.

Result

Congratulations — you have updated UR successfully.

Apply a Patch to SAPUI5

Business Example

Your company uses many Web browser-based functions offered by SAP S/4HANA.

As an administrator, you want to apply a patch to SAPUI5.

Steps

  1. Determine the SAPUI5 version of your SAP S/4HANA system.

    1. In your training environment (on the WTS), open a Web browser.

    2. Enter the following URL:

      • Q team: https://s4qhost.wdf.sap.corp:44321/sap/bc/ui5/index
      • P team: https://s4phost.wdf.sap.corp:44331/sap/bc/ui5/index

    3. If required, provide credentials for your SAP system.

    4. Note the right-most column to determine the SAPUI5 version.

      The notation is major_version.minor_version.patch_level (for example 1.120.18 – see the following screenshot as an example).

    Result

    You know the SAPUI5 version before the update.

  2. Set profile parameter rdisp/scheduler/prio_high/max_runtime dynamically to 3h (three hours).

    1. If you have not yet already done so, log on to your SAP system with the credentials of your course user that is provided by your instructor (for example user train-##).

    2. Start transaction RZ11.

    3. As Parameter Name, enter rdisp/scheduler/prio_high/max_runtime.

    4. Choose Display (parameter).

    5. Choose Change Value from the application toolbar.

    6. As New Value, enter 3h.

    7. Select Switch on all servers.

    8. Choose Save (change).

    9. Choose Continue to confirm the popup.

    Result

    This (temporary) setting of rdisp/scheduler/prio_high/max_runtime ensures that no dialog work process timeouts occur. For details, see SAP Note 2918906 – Deprecation of Profile Parameter "rdisp/max_wprun_time".

  3. Create a new workbench request.

    Note

    In this training, each stage (development, quality assurance and production) is treated as a separate system. In a real scenario, you would release the transport request in your development system and import it to quality assurance and production systems.

    1. If you have not yet already done so, log on to your SAP system with the credentials of your course user that is provided by your instructor (for example user train-##).

    2. Start transaction SE09.

    3. Choose Create... (F6) in the application toolbar.

    4. As request type, select Workbench request.

    5. Choose Copy (Enter).

    6. In the Create Request popup, enter any Short Description (for example Patch SAPUI5) and choose Save (Enter).

    7. Copy the transport request number (not the task number) to you clipboard.

      Hint

      Choose Ctrl+Y to enable the copy function in SAP GUI for Windows.

  4. Run the patching of SAPUI5 in your SAP S/4HANA system using program /UI5/UI5_UPLOAD_PATCH_TO_MIME.

    Note

    Due to time constraints, omit a run in test mode.

    1. Following the previous task, open a new SAP GUI session in which you start transaction SA38.

    2. As Program, enter /UI5/UI5_UPLOAD_PATCH_TO_MIME.

    3. Choose Execute (F8).

    4. Ensure that option Presentation Server is selected.

    5. Use the select box for field File to select the proper patch file on the training share at S:Maintenance\s4Xhost\SAPUI5 (for example S:\Maintenance\s4Xhost\SAPUI5\UI5CLIENT120P_21-80000549.ZIP). Your instructor will provide details.

    6. Back on the SAP GUI screen, deselect the test mode checkbox.

      Note

      This is for the sake of simplicity here. In the "real world", you would like to select the test mode first before implementing the UI5 patch.

    7. In the Request/Task field, paste the transport request number.

    8. Choose Execute (F8).

      Note

      Be patient, this will take a while (about 35 minutes).

    9. In the result list, verify that no errors are shown (for example by checking the entries in column State).

    Result

    You have applied a patch to SAPUI5.

  5. Determine the SAPUI5 version of your SAP S/4HANA system again.

    1. In your training environment (on the WTS), open a Web browser.

    2. Enter the following URL:

      • Q team: https://s4qhost.wdf.sap.corp:44321/sap/bc/ui5/index
      • P team: https://s4phost.wdf.sap.corp:44331/sap/bc/ui5/index

    3. If required, provide credentials for your SAP system.

    4. Note the right-most column to determine the SAPUI5 version.

      The notation is major_version.minor_version.patch_level (for example 1.120.21 – see the following screenshot as an example).

    Result

    You know the SAPUI5 version after the update.

Result

Congratulations — you have patched SAPUI5 successfully.

Log in to track your progress & complete quizzes

Learning

SAP FacebookSAP YoutubeSAP LinkedIn