System Variables

System variables affect the behavior of Entire Connection during runtime.

`AUDIT`	`DISPLAY`	`NTCOFF`	`STATUS`
`AUDITXFER`	`EAB`	`NTCON`	`STOPBITS`
`AUTOLOCK`	`ECHO`	`NUMLOCK`	`STOPTASK`
`BAUDRATE`	`EOSDELAY`	`OEM`	`TCPADDR`
`BEEP`	`INSTOGGLE`	`PARITY`	`TCPPORT`
`BREAKMS`	`LOGOFF`	`PCFILE`	`TIME`
`COMMPORT`	`LOGON`	`PRINTOPTION`
`CURSOR`	`LOOPCNT`	`REMOTEECHO`
`DATABITS`	`NATFILE`	`RESPONSE`
`DATE`	`NCF`	`STARTTASK`

See also: *PASSWORD1 - 4 and *USERID1 - 4.

System variables can be modified during runtime, using the SET command. Using the TOGGLE command, you can also modify system variables of type Binary.

This document covers the following topics:

Types of System Variables
Value Types for System Variables
List of System Variables

Types of System Variables

There are two types of system variables:

System variables that affect the whole Entire Connection system
These variables are set at startup time with values from the share file. You can modify the values during runtime, either from the command line or from a procedure file. The modifications are valid only as long as Entire Connection is active. In the corresponding object properties, variable values can be changed permanently.
System variables that only affect specific sessions
When a session is opened, these variables are filled with values from the session properties. You can modify the values while the session is open, using a procedure file. The modifications are valid only as long as the session is open. In the session properties, variable values can be changed permanently.

Value Types for System Variables

Value Type	Value
Binary	TRUE/FALSE You can also use the combinations YES/NO and ON/OFF which are synonymous with TRUE/FALSE. When you display the value of a variable, TRUE or FALSE is always shown.
Date	Date format (month, day, year and delimiter character) as defined in the user properties.
Path	{[[`drive:`]\`directory`\...\] `filename`[.`extension`]}
Integer	Whole positive number.
String	Any ASCII character or a group of ASCII characters. The maximum length is 254 characters.
Parity	EVEN, MARK, NONE, ODD, SPACE
Task Name	Name of a valid task.
Time	Time format (hour, minute, second and delimiter character) as defined in the user properties. If the delimiter character is A, the time is displayed in the AM/PM format (for example, 01:30 PM).

List of System Variables

The default value of a system variable is indicated by underlining.

AUDIT

Affects	System
Value Type	Binary
Valid Values	OFF/ON
Object / Page / Option	User properties / Procedure / Audit procedure files

AUDITXFER

Affects	System
Value Type	Binary
Valid Values	OFF/ON
Object / Page / Option	User properties / Procedure / Audit file transfer

AUTOLOCK

Affects	System
Value Type	Integer
Valid Values	0 - 1440 (minutes)
Object / Page / Option	User properties / Parameters 1 / Autolock time

BAUDRATE

Affects	Session
Value Type	Integer
Valid Values	300/1200/2400/4800/9600/14400/19200/28800/38400/57600/115200
Object / Page / Option	Session properties / Serial communication / Baud rate

BEEP

Affects	System
Value Type	Binary
Valid Values	OFF/ON
Object / Page / Option	User properties / Parameters 1 / PC speaker beep on errors and warnings

BREAKMS

Affects	Session
Value Type	Integer
Valid Values	0 - 1000 500
Object / Page / Option	Session properties / Serial communication / Break signal time

COMMPORT

Affects	Session
Value Type	Integer
Valid Values	1 - 4 2
Object / Page / Option	Session properties / Serial communication / COM port

CURSOR

Affects	System
Value Type	Integer
Valid Values	0 - 4 1 (small)
Object / Page / Option	User properties / Parameters 1 / Cursor size

DATABITS

Affects	Session
Value Type	Integer
Valid Values	7 and 8
Object / Page / Option	Session properties / Serial communication / Data bits

DATE

Affects	System
Value Type	Date
Valid Values	All data formats available in the user properties YMD.
Object / Page / Option	User properties / Parameters 2 / Date style

DISPLAY

Affects	Session
Value Type	Binary
Valid Values	OFF/ON
Object / Page / Option	Session properties / Procedure / Display all host screens while executing a procedure file

EAB

Affects	Session
Value Type	Binary
Valid Values	OFF/ON
Object / Page / Option	Session properties / Display / Ignore extended attribute colors

ECHO

Affects	System
Value Type	Integer
Valid Values	0 - 100 0 (no echo)
Object / Page / Option	Used to debug procedure files

EOSDELAY

Affects	Session
Value Type	Integer
Valid Values	0 - 1000 (milliseconds) 6
Object / Page / Option	Session properties / Telnet communication and Serial communication / End-of-screen delay

INSTOGGLE

Affects	Session
Value Type	Binary
Valid Values	OFF/ON
Object / Page / Option	Session properties / Terminal / Enable insert mode toggling

LOGOFF

Affects	Session
Value Type	Binary
Valid Values	OFF/ON
Object / Page / Option	Session properties / Procedure / Enable automatic logoff

LOGON

Affects	Session
Value Type	Binary
Valid Values	OFF/ON
Object / Page / Option	Session properties / Procedure / Enable automatic logon

LOOPCNT

Affects	System
Value Type	Integer
Valid Values	0 - 32767 256
Object / Page / Option	User properties / Procedure / Limit loops in procedure files

NATFILE

Affects	Session
Value Type	Integer
Valid Values	1-32, if work file 1-31, if printer file 7
Object / Page / Option	Session properties / File transfer / Natural work file

NCF

Affects	System
Value Type	Binary
Valid Values	OFF/ON
Object / Page / Option	User properties / Parameters 2 / Create format file

NTCOFF

Affects	Session
Value Type	Path
Valid Values	See description of value types
Object / Page / Option	Session properties / Procedure / Logoff procedure

NTCON

Affects	Session
Value Type	Path
Valid Values	See description of value types
Object / Page / Option	Session properties / Procedure / Logon procedure

NUMLOCK

Affects	Session
Value Type	Binary
Valid Values	OFF/ON
Object / Page / Option	Session properties / Terminal / Allow alphanumeric input in numeric fields

OEM

Affects	Session
Value Type	Binary
Valid Values	OFF/ON
Object / Page / Option	Session properties / File transfer / Use DOS character set for upload/download in NCD format

PARITY

Affects	Session
Value Type	Parity
Valid Values	EVEN, MARK, NONE, ODD, SPACE
Object / Page / Option	Session properties / Serial communication / Parity

PCFILE

Affects	Session
Value Type	Integer
Valid Values	1-32, if work file 1-31, if printer file
Object / Page / Option	See the description of the `SET` command

PRINTOPTION

Affects	Session
Value Type	String
Valid Values	Size=`nn` Orient={P\|L} Duplex={S\|V\|H}
Object / Page / Option	See the description below.

With the PRINTOPTION variable, you can change the print settings for download to printer and for printing from a procedure file. You can change the size of the font, the page orientation and you can define whether to print on one or both sides of the paper.

Note:
The font used for printing is defined in the user properties.

The value is a string which may be composed of three elements:

Element	Description
Size=`nn`	Font size. `nn` is a number from 1 to 99.
Orient=`option`	Page orientation. Valid options are P (portrait) and L (landscape).
Duplex=`option`	Paper usage. Valid options are S (simplex), V (vertical) and H (horizontal).

The elements must be separated by one blank. There must be at least one element in the value string. The elements may be in any order.

Example - use font size 16, landscape, and vertical printing on both sides of the paper:

SET PRINTOPTION "Size=16 Orient=L Duplex=V"

To use the defaults (font size as selected in the user properties, portrait and printing on one side of the paper), you have to clear the current settings as follows:

SET PRINTOPTION ""

REMOTEECHO

Affects	Session
Value Type	Binary
Valid Values	OFF/ON
Object / Page / Option	Session properties / Serial communication / Remote echo

RESPONSE

Affects	Session
Value Type	Integer
Valid Values	1 - 1000 (1 - 1000 seconds) 1001 - 2440 (1 - 1440 minutes) 15 (seconds) Note: These special internal representations for seconds and minutes are always used when a procedure file is executed (for example, with the command `SET` or `WAIT`). Any values for seconds or minutes that you specify using the Configuration Manager are automatically transformed to the above special internal representation.
Object / Page / Option	Session properties / Procedure / Maximum host response time

STARTTASK

Affects	System
Value Type	Task Name
Valid Values	Valid Entire Connection task name
Object / Page / Option	User properties / Parameters 2 / Startup task

STATUS

Affects	Session
Value Type	Binary
Valid Values	OFF/ON
Object / Page / Option	Session properties / Procedure / Display status lines while executing a procedure file

STOPBITS

Affects	Session
Value Type	Integer
Valid Values	1 or 2
Object / Page / Option	Session properties / Serial communication / Stop bits

STOPTASK

Affects	System
Value Type	Task Name
Valid Values	Valid Entire Connection task name
Object / Page / Option	User properties / Parameters 2 / Shutdown task

TCPADDR

Affects	Session
Value Type	String
Valid Values	TCP/IP address (no default) A TCP/IP address can either be a string which is resolved in the host's table (up to 128 bytes), or it can be formed as follows: `nnn.nnn.nnn.nnn` where `nnn` is a number between 000 and 255.
Object / Page / Option	Session properties / TN3270 communication or Telnet VTxxx communication / Host name / IP address

TCPPORT

Affects	Session
Value Type	Integer
Valid Values	TCP/IP port ID 23
Object / Page / Option	Session properties / TN3270 communication or Telnet VTxxx communication / Default TCP port or Custom TCP port

TIME

Affects	System
Value Type	Time
Valid Values	All time formats available in the user properties HMS:
Object / Page / Option	User properties / Parameters 2 / Time style