Script Functions

ADD_STRING Function

Defines a string by a unique number for use by other scripts

ADD_UNKNOWN_FORM_GUESS Function

Function keys to send when an unknown form appears during RAMP navigation

ALERT_MESSAGE Function

Issue a message as an alert

AVCLOSEFORM Function

Signal to the Framework to close the current screen 

AVRESTOREAVALUE and AVRESTORENVALUE Function

Restores an alphanumeric or numeric value from the Framework virtual clipboard

AVSAVEVALUE Function

Save an alphanumeric or numeric value in the Framework virtual clipboard.

AVSIGNALEVENT Function

Signal an event to filters and RAMP screens 

AVSWITCH Function

Requests a switch to another business object and optionally the execution of a nominated command.

CHECK_CURRENT_FORM Function

Check that RAMP is showing a screen

CHECK_FIELD_EXISTS Function

Checks whether a field is present in the current screen

CLEAR_MESSAGES Function

Clear all messages currently in the stack 

COPYTOCLIPBOARD Function

Copy a string to the user's clipboard

CURRENT_FORM Function

Get the Form Name of the current RAMP screen

DROP_SPECIAL_FIELD_HANDLER Function

Removes the definition of a 5250 special field handler

FATAL_MESSAGE Function

Issue a fatal message

FATAL_MESSAGE_TYPE Function

Stop the Framework from shutting down when a fatal navigation error occurs

GET_FORM_MESSAGE Function

Get the 5250 message text at a specified row number and optionally route as a Framework message.

GETVALUE Function

Get the value from a field on a RAMP screen

HANDLE_PROMPT Function

Show a user defined prompter form for a field

HIDE_5250_BUTTONS() Function

Use in the ARRIVE script to hide the function key buttons in the 5250 screen

HIDE_CURRENT_FORM Function

Hide the current screen with an optional message

LOCK_FRAMEWORK Function

Locks the framework

MESSAGE Function

Issue a message

NAVIGATE_TO_SCREEN Function

Navigate to a screen 

OVERRIDE_KEY_CAPTION_ALL Function

Assigns a new caption for a function key on any screen

OVERRIDE_KEY_CAPTION_SCREEN Function

Assigns a new caption for a function key on a particular screen

OVRSFLAUTOGUI Function

Allows you to turn the Axes system flag Recognise subfiles as tables on and off on a screen by screen basis.

Q_CHECK_CURRENT_FORM Function

Check that RAMP is showing a screen, the request is queued up and processed when the next screen arrives

Q_NAVIGATE_TO_SCREEN Function

Navigates to a nominated 5250 screen, the request is queued up and processed when the next screen arrives

Q_SENDKEY Function

Emulates the pressing of a key, the request is queued up and processed when the next screen arrives

Q_SETVALUE Function

Set the content of a field on a 5250 screen to a value, the request is queued up and processed when the next screen arrives

RESTART_LAST_NAVIGATION Function

Restarts to the last navigation plan when the next screen arrives. 

SCREEN Function

Returns the screen object for a specified screen name

SENDKEY Function

Emulate pressing a key.

SET_HANDLER_CAPTION Function

Set the current command handler caption to a new value

SET_SPECIAL_FIELD_HANDLER Function

Sets or resets the current definition of a 5250 special field handler

SETBUSY Function

Moves the cursor to the specified field, or piece of text, or subfile cell

 SETCURSORTOFIELD Function

Moves the cursor to the specified field, or piece of text or subfile cell

SETCURSORTOROW Function

Moves the cursor to the specified row and column on the screen

SETKEYENABLED Function

Dynamically enable or disable a Destination’s button or 5250 function key

SETVALUE Function

Set a field on a RAMP screen to a value 

SHOW_5250_BUTTONS() Function

Use in the ARRIVE script to show the function key buttons in the 5250 screen

SHOW_CURRENT_FORM Function

Show or hide the current screen.

SHOWSTATUSBAR Function

Show/Hide the 5250 terminal status bar for the end user

STRING Function

Returns the string for a given string identification number

STRIP_LEADING_NUMBERS Function

Returns the leading numbers from a string

TONUMBER Function

Makes a string or other JScript object into a number.

TOSTRING Function

Makes a number or null or other JScript object into a string.

TRACE Function

Add run time information to the trace panel 

TRIM_LEFT Function

Trim preceding (left) spaces from a string

TRIM_RIGHT Function

Trim trailing spaces from a string

UNLOCK_FRAMEWORK Function

Unlocks the framework