8.06 onUIEvents()

Purpose

With onUIEvents() command, you can trigger processes or function codes.

This command is applicable to any process user will perform in an SAP screen with the sole exception of pushbutton clicks. There are a number of possible ways of writing this command, as shown in the examples below.

Syntax

onUIEvents["action"]=process_name;

onUIEvents["action"]={"process":function_name};
				

onUIEvents["action"]={"fcode":"functioncode","process":function_name};
				

onUIEvents["action"]={"fcode":"functioncode","process":function_name, "using":{parameter:"Parameter_value"}};

Options

You can use the following options with the onUIEvents() event handler command.

Option Details

Example

The following examples demonstrate the usage of onUIEvents() command:

Executing a process

In the following example, we are going to use the onUIEvents() command to trigger a process based on a user action. The transaction where the process will occur is specified using the 'fcode' option. Specifically, when a user presses the Enter key, the user will be transported to the VA02 transaction and a function will execute.

1. Open the Easy Access script file (SAPLSMTR_NAVIGATION.E0100.sjs) and enter the following code. Create the file if it does not already exist.

   del ("X[IMAGE_CONTAINER]");
   onUIEvents['Enter']={"fcode":"/nva02","process":test_UIEvent};
   text([4,1],'This example includes the execution of UI action Enter. Hit Enter  to execute process');

2. Now add the function code that will execute when the VA02 transaction launches. An example function is shown below:

   function test_UIEvent(){
   	onscreen 'SAPMV45A.0102'
   		set("F[Order]","14200");
   	enter();
   	onscreen 'SAPMV45A.4001'
   	enter();
   }

3. Save the changes.
4. Launch SAP and navigate to the Easy Access transaction.
5. Press the enter key to initiate the process from the Easy Access screen. On execution of the process, the screen appears, as shown:
   

Passing parameters to onUIEvents

In the following example, we will pass some parameters to the onUIEvents command with the 'using' option. To demonstrate this, please do the following.

1. Open the Easy Access script file (SAPLSMTR_NAVIGATION.E0100.sjs) and enter the following code:

   onUIEvents['/1']={"fcode":"/nva02","process":test_UIEvent, "using":{param_1:15965}};
   text([4,1],'This example includes the execution of UI action F1. Hit F1 to execute process');
   			

2. Now create a function that will actually do the work of passing the parameter. An example is shown below:

   function test_UIEvent(param){
   	onscreen 'SAPMV45A.0102'
   		set("F[Order]",param.param_1);
   	enter();
   	onscreen 'SAPMV45A.4001'
   	enter();
   }
   			

3. Save your changes.
4. Launch SAP and navigate to the Easy Access screen to initiate the process by clicking the enter button.
5. The function executes and the screen appears as shown:
   

Usage Details

• Get required sales order data from SAP table with onUIEvents()

• File operations with onUIEvents()

• Get server name using _ashost variable and onUIEvents()

• Read selected grid data with onUIEvents()

• new Reebok with onUIEvents()

• Get message, message type, message number, and message id using _message, _msgtype, _msgno, and _msgid  with onUIEvents()

• Add a column into an SAP table with onUIEvents()

• Change readonly status dynamically with onUIEvents()

• Searchhelp using Function Module with onUIEvents()

• Display custom pop-up with onUIEvents()

• Resizing groupbox for sales order with onUIEvents()