ATTN

Equivalent to pressing the Attn key on the keyboard.

CLEAR

Equivalent to pressing the Clear key on the keyboard.

ON SCREENERROR [GOTO label]

Permits branching based on communication exception conditions. An example of an exception is a VTAM application that does not accept a logon command. This command can be activated any number of times within a script to change the method of exception handling. Each time command ON SCREENERROR is activated, the previous setting is overridden. The new setting takes effect from the point it is specified in the script onward.

GOTO

The script flow branches to the specified label name (must be in the same command member).
If no GOTO parameter is specified, no branching occurs.

COLOR {ON|OFF}

Specifies color and highlight capabilities of terminal emulation. If LOGMODE is not specified when logging in to the VTAM application, KOA uses this command to determine the terminal emulation type. For more information see KOA Implementation Considerations.

ON – Emulates a terminal which supports extended data stream (colors and highlights).

OFF – Emulates a terminal which does not support extended data stream (colors and highlights). Default.

GETSCREEN

Instructs KOA to refresh the screen with updated information from the VTAM application, without waiting for keyboard input.

The LOGON command allows logging on to a VTAM application. The APPLID and SESSID parameters are mandatory. Other optional parameters (listed below) can be specified to define terminal name and emulation type.

• APPLID applid – Specifies the name of the VTAM application. applid can consist of a constant or can contain any valid KOA or AutoEdit expression. Mandatory.
• SESSID sessid – Specifies the 4-character, unique identifier of the session. sessid is supplied by the user. Within the same KOA script, a user can operate several active VTAM application sessions concurrently. Therefore, each session must have its own unique session ID. Mandatory.
• DATA data – Passes data to the VTAM application as part of the logon process (such as TSO user ID). If data contains embedded blanks, it must be enclosed in single quotes. data can consist of a constant, or can contain any valid KOA and/or AutoEdit expression. Optional.
• LOGMODE logmode – Defines terminal characteristics (such as size or color) by specifying a predefined VTAM logmode name. The logmode name must be 1-8 characters in length. Optional.

If LOGMODE is not specified, KOA uses information provided in commands COLOR and SCREENSIZE to find a valid predefined logmode in CTOPARM which supports these characteristics. For more information refer to "KOA Implementation Considerations" later in this chapter.

• TERMINAL terminal – Specifies a predefined VTAM terminal (logical unit) name. The terminal name must be 1-8 characters in length. Optional.

If TERMINAL is not specified, KOA uses information provided in member CTOPARM to dynamically select a terminal name. For more information refer to "KOA Implementation Considerations" later in this chapter.

LOGOFF

Logs off or disconnects from the VTAM application.

SCREENMODE {UNLOCKED|ANY}

Indicates type of screens to be received by the KOA script. This command can be activated any number of times within a script to re-specify the screen mode.

• UNLOCKED – Only unlocked screens (screens that allow keyboard input) are received. This parameter ensures that KOA is always able to send information back to the VTAM application. Default.
• ANY – Any screen (locked or unlocked) is received. KOA may receive a screen which does not allow keyboard input. However, KOA will not be able to respond to this type of screen.

SCREENMODE {RECEIVE|NORECEIVE}

Indicates if information (messages and screens) should be received from the VTAM application. This command can be activated any number of times within a script to re-specify the screen mode.

• RECEIVE – information is sent to and received from the VTAM application. Each time KOA sends information to the VTAM application, KOA waits for a response. Default.
• NORECEIVE – Information is sent to the VTAM application, but no response is received automatically. To request a response in this mode, command GETSCREEN should be used.

SCREENMODE {GETUNSOL|IGNUNSOL}

Indicates type of information (messages and screens) to be received from the VTAM application. This command can be activated any number of times within a script to respecify the screen mode.

• GETUNSOL – Both solicited and unsolicited messages and screens are received from the VTAM application and can be displayed (by command GETSCREEN).
• IGNUNSOL – Unsolicited information (that is, messages and screens which are not expected by KOA) are ignored, and are not displayed. Default.

SETSESS sessid

Switches (shifts) to the session with the specified session ID.

TIMEOUT value

Specifies how many seconds KOA should wait for a response from the VTAM application before disconnecting the session. If not specified, the default value (as specified in the Control-O Installation Parameters) determines the TIMEOUT value.