ADD_UNKNOWN_FORM_GUESS Function

RAMP-TS

ADD_UNKNOWN_FORM_GUESS Function

Function keys to send when an unknown form appears during RAMP navigation. Only available in Windows.

Syntax

ADD_UNKNOWN_FORM_GUESS(sKeyName)

Parameters

SKeyName

Required.String that contains the name of the key. See Function Key Names for SENDKEY Function.

 

  

Return Value

None

Remarks

Use this function call in the session's sign-on script.

When an unknown 5250 screen is encountered, the Framework goes into a locked state if the Lock Framework when an unknown 5250 form is displayed property is turned on. The user will not be able to move around within the Framework until they navigate to a defined 5250 screen.

The ADD_UNKNOWN_FORM_GUESS function can help to work around such situation by specifying function keys to send as the user tries to execute a different Framework action (for example click on a different Application or Business Object, Command, etc.) without having to navigate to a defined 5250 screen. Before getting into a locked state, the Framework will send the added keys in the sequence they were added.

For example, your RAMP application may have many undefined F4=Prompt pop-up windows that are all closed by using F12=Cancel. You can instruct RAMP that when an unknown screen is on display (for example an F4=Prompt window) it should first try F12 (to see if it can close the window) before displaying the lock message.  

It's up to the unknown 5250 screen to support the usage of the sent function keys and to the screen arriving after sending the keys to be defined for this functionality to work. This responsibility is up to the designer. 

Care should be taken when using this function as it applies generically to all undefined screens.

Examples

 

ADD_UNKNOWN_FORM_GUESS(KeyF3);

ADD_UNKNOWN_FORM_GUESS(KeyF12);