Your RAMP-TS Screen Script Defines a JavaScript Object
The script you create for each RAMP-TS screen defines a JavaScript object. Like any JavaScript object it has functions and properties.
The standard shipped RAMP-TS functions and properties are as follows (commonly used features are shown in bold):
| Name | Type | Modifiable by your scripting? | Description/Comment |
|
vFKC |
String Array |
No |
Function key captions |
|
vFKERTS |
String |
No |
Function key enablement for 5250 screen |
|
vFKEVLF |
String |
No |
Function key/button enablement for RAMP-TS |
|
vFKSEQ |
String |
No |
Function key sequence numbers |
|
vFKSND |
String Array |
No |
Function keys to sent to 5250 server |
|
vGUID |
String |
No |
GUID of the screen definition |
| vHandle_ARRIVE |
Function |
N/A |
Screen arrival handling function. |
|
vHandle_AVEVENT |
Function |
N/A |
Screen VLF event handling function |
| vHandle_BUTTONCLICK |
Function |
N/A |
Screen button click / function key handling function |
|
vHandle_DEPART |
Function |
N/A |
Screen departure handling function |
| vHandle_NAVIGATETO |
Function |
N/A |
Screen navigation handling function |
|
vHandle_USER_NAVIGATION_PLAN |
Function |
N/A |
Screen navigation plan override function |
| vLastMessage |
String |
No |
Latest message to have arrived on this screen |
| vLatestVariant |
String |
No |
Latest screen variant to have arrived |
| vName |
String |
No |
Name of the screen |
| vOverrideExitJunction |
String |
Yes |
Override of exit junction associated with this screen. |
|
vTargets |
String Array |
No |
Screens that this screen can navigate to |
|
vTYPE |
String |
No |
Type of screen |
You can add your own functions and properties.
Note: Do not prefix your own functions and properties with "v" (lowercase) or "V" (uppercase). The v*/V* namespaces are reserved by the RAMP-TS product to allow for the future expansion of the standard shipped functions and properties.