Liquid UI - WS Reference Library

WS Development Rules


WS Scripts are used for designing screen interface. Dictates how the screen appears to the user.

Running WS Scripts

User can run customized scripts either locally through guixt.dll or through Liquid UI Server.

Install Liquid UI for SAPGUI

Steps to install/ Upgrade the software:

  1. Close all SAP GUI sessions on your machine, including the SAP GUI logon pad.
  2. Navigate to the SAP GUI Installed folder on the machine.

    C:\Program Files\SAP\FrontEnd\SAPgui: 32 bit OS

    C:\Program Files(X86)\SAP\FrontEnd\SAPgui: 64 bit OS

  3. Take a backup of the following files
    • Guixt.dll
    • Webscript.dll
    • Guixt.sjs
  4. Run the downloaded GuiXTWSSetup.exe file as an administrator.
  5. Follow the installation wizard to install the new version of the software.
  6. Navigate to SAPgui folder and verify the version of guixt.dll file.
  7. Verify the configuration by reviewing the guixt.sjs file and if required, copy back the guixt.sjs file from step 3 into the SAP GUI folder to retain older configuration.
Things to do:

Prior to running the WS Scripts, the user’s system must have Liquid UI Server installed and configured to SAPGUI.

Liquid UI Server has 2 important files to be configured

  1. Sapproxy.ini: Contains the configuration of the SAP Server to which the user wants to connect.
  2. Guixt.sjs: Configuration of Liquid UI Server.

Click here to know more about Liquid UI Server Configuration.

Deploy the scripts under the path, which you specified in guixt.sjs file and run the scripts by opening SAPLogon.

Once you logged into SAP, you will get SAP Easy Access screen. Here, you can type the transaction code of the particular application and simultaneously, the scripts will get loaded in the background.

Note: The user can either navigate to the transaction from SAP Easy Access screen and as well from the transaction to other transaction.

If any changes are made to the script, the user has to close all the SAP sessions and re-login into SAP to see the changes on the Screen.

Script Naming Convention

All Liquid UI WS Scripts Files (development files) have .SJS extension.

SAP screen script names should not be altered. It is a must to keep the same name as the system suggested.  This is how Liquid UI WS scripts are linked to SAP Screen.

SAP screen script name:

SAPLSMTR_NAVIGATION.E0100.sjs, where

SAPLSMTR_NAVIGATION: Dynpro name of the screen
E: Language key
0100: 4 digit dynpro number
sjs: file extension

These script names indicate the module, package, role and program for which each screen is designed. Liquid UI will push screens onto a stack while navigating from one screen to another. At any point, Liquid UI will then draw the screen at the top of the stack on the stopped screen. This is how Liquid UI WS scripts are linked to SAP Screens. This allows Liquid UI to draw different layouts on the same screen based on some scenario or logical reasoning.

Typical Liquid UI Server Script name for XYZ App is shown below:

XYZ_app_module_package_prog.sjs, where

XYZ: Screen layout script for XYZ development
app: Application for which screen is created
module: Module for which screen is created
package: User group or package
prog: Screen description or program
Function Scripts

Purpose:

For screen processes, functions are called from various processes are listed in function script files. These files must be loaded before the actual execution of the process. In any application, the function scripts are loaded in to the system inside the esession.sjs file.

Typical Liquid UI WS Function script name:

proc_app_module_package_prog.sjs

proc: Indicates a process file, and not a screen file.
app: Application for which processes are written
module: Module for which processes are written
package: User group or package
prog: Generic process (prog) group for all functions in file.
Functions

WS Script’s functions facilitate synchronization of data with SAP Screens. Simplifies multiple screen navigation and screen level data validation.

Following naming convention is followed for functions:

Function proc_app_module_package_prog()

{
          //code here

}

Variable Naming Convention:

For all variables following naming convention is used:

z_tcode_field  
z Used as variable prefix
tcode Lower Case Transaction Code for which the variable refers to
  (Example: ie03 for display equipment)
field Lower Case field name referring to SAP field

(Example: selectedEquip for referring to equipmentNumber)

z_ie03_selectedEquip Variable is used to store the selected equipment number.

Note: Variable names are case sensitive.