Configuration File

All options, except the name of the configuration file and the socket or port, can be set in a configuration file. One advantage of using a configuration file is that the file can be changed, and the changes will apply when the server is restarted. The configuration file is generally stored in the / (root) file system and can be modified using an editor such as EDTF. If you wish, you can store the configuration file in a source member and use an editor such as SEU. Configuration files can be shared across different aXes Terminal Servers.

The default location for the configuration file is the /axes/configs directory. You can edit the default TS configuration file using the command:

EDTF STMF(‘/axes/configs/aXesTS.conf’)

The configuration file is a simple text file containing a series of ‘option’ or ‘option=value’ directives separated by white space. Valid directives are described below.

Comments may be placed anywhere within the configuration file. Comments begin with the hash (#) character and all characters after the # are ignored. Long lines can be continued by breaking them with a trailing backslash (‘\’).

Sections are used to group various configuration options. The aXes Terminal Server supports the UserList section. This section can be replaced by a separate file.

The configuration file can be encoded using any IBM i supported CCSID or code page.

Most aXes-TS configuration directives have reasonable defaults and need not be specified.When specifying numeric values do not include leading zeroes because these will cause the value to be interpreted as an Octal number (i.e., 037 will be interpreted as decimal 31).

Configuration Directives

Default values are either underlined or explicitly stated.

Mandatory parameters are marked with an asterisk *.

AutoGUI

Enables or disables the autoGUI menu option. To turn AutoGUI functionality on or off, use the AutoGUIOn property in Application Level Basic Properties.

Allowable values are 0 or 1. Zero (0) disables autoGUI menu option and 1 enables it.

The default value is 1.

AdminPath

Specifies the directory where the aXes Terminal Server Administration JavaScript and XSL files reside. There are no constraints on the name of this directory.

The default is a directory named <prod-dir>/TS/Admin where <prod-dir> is the product installation library.

AdminView

Specifies the Administration View function is enabled. The default is disabled to comply with European privacy requirements. The allowable values are:

Value

Description

noview Specifies that an administrator or other authorized user cannot view other sessions.
view Specifies that an administrator or other authorized user may view other sessions.
user Specifies that the ability to view another user’s session is defined in the user configuration file.

ClientAttrRemapBase

Specifies the base Unicode value that marks the starting point for mapping 5250 attribute characters into the user-defined Unicode character range. Any Unicode value is allowed but the character should be in the user-defined range (0xe000 to 0xf8ff). This value must be specified using C language syntax where the hexadecimal numbers are preceded by 0x (zero and x). The default value is 0xf000

ClientNullReplaceChar

Specifies the Unicode value sent to the client as the replacement for a host null (x’00’) character byte.

The default value is 0xa0 which is the non-breaking space character.

This is the same character as that represented by the HTML &nbsp; entity. This value must be specified using C language syntax where the hexadecimal numbers are preceded by a 0x (zero and x). The default value is 0x0a.

Compress

Specifies whether dynamic data sent to the client is compressed. Allowable values are 0 or 1. Zero (0) disables compression and 1 enables compression.

The default value is 1.

Disabling compression will cause more data to be sent over the network.

Data compression is used only if the browser indicates it can accept compressed data via the Accept-Encoding HTTP header.

CompressTS

Specifies whether static data in the <prod-dir>/ts directory sent to the client is compressed. Static data is cached by the aXes Terminal Server during start-up and includes the Javascript files that comprise the aXes Terminal Server client.

Allowable values are:

Value

Description

0 (zero) Disables compression and causes an uncompressed cache to be used. Using an uncompressed cache will cause more data to be sent over the network.
1 Enables compression and causes a compressed cache to be used. Cached data will be uncompressed dynamically if the browser client indicates it cannot accept compressed data. This setting may increase the CPU used by the aXes Terminal Server if many clients indicate compression is not supported.
2 Causes both compressed and uncompressed caches to be created. If the client indicates it can accept compressed data the compressed cache will be used otherwise the uncompressed cache will be used. This setting will increase the amount of storage used by the aXes Terminal Server by an amount equal to the uncompressed size of the <prod-dir>/ts directory.

The default value is 1.

Data compression is used only if the browser indicates it can accept compressed data via the Accept-Encoding HTTP header.

DefaultWorkstationType

Specifies the type of workstation device created by aXes Terminal Server.

The allowable values are:

 Value Description
auto Specifies that aXes Terminal Server will automatically determine the device type to use based on the setting of the QIGC system value. If this system value is set to ‘1’ then a dual-size (27*132) DBCS-capable device (5555-C01) will be created, otherwise a dual-size (27*132) SBCS device (3487-HC) is created. IBM i VRM530 is inherently a DBCS capable system therefore aXes Terminal Server will create a DBCS-capable device.
CCSID If the QIGC system value is set to ‘1’ and the HostCSSID directive is set to Auto or to a DBCS CCSID number then a dual-size (27*132) DBCS-capable device (5555-C01) will be created, otherwise a dual-size (27*132) SBCS device (3487-HC) is created.This value is the word CCSID rather than a CCSID number.
type Specifies the device type aXes Terminal Server will use when creating a workstation device. The allowable type values are:

 

Type

Workstation

Description

3 5292-2 24*80 colour graphics display
6 3179-2 24*80 colour display
8 3477-FC  24*80 or 27*132 colour display
10 5555-C01 24*80 or 27*132 colour double-byte character set (DBCS) display
12 5555-G02 24*80 colour double-byte character set (DBCS) graphics display
15 3487-HC  24*80 or 27*132 colour display

You should not choose a DBCS device if your host system is SBCS.

DefaultKeyboardType

Specifies the type of keyboard for workstations device created by aXes Terminal Server. The allowable values are:

Sysval Specifies that aXes Terminal Server will automatically determine the device type to use based on the setting of the QIGC system value. If this system value is set to ‘1’ then a dual-size (27*132) DBCS-capable device (5555-C01) will be created, otherwise a dual-size (27*132) SBCS device (3487-HC) is created.

IBM i VRM530 is inherently a DBCS capable system therefore aXes Terminal Server will create a DBCS-capable device.

type Specifies the keyboard type aXes Terminal Server will use when creating a workstation device. The Keyboard Types table shows allowable type values.

The Keyboard Types table shows the keyboard type and the associated countries.

Type

Language or Country

AGB

Austria/Germany

AGE

Austria/Germany (Euro)

AGI

Austria/Germany Multinational

ALI

Albania

BGB

Bulgaria

BLI

Belgium Multinational

BLM

Belgium Multinational (Euro)

BRB

Brazilian Portuguese

BRE

Brazilian Portuguese (Euro)

CAB

Canadian French

CAI

Canadian French Multinational

CAM

Canadian French Multinational (Euro)

CLB

Arabic

CSB

Czech Republic

CYB

Cyrillic

DMB

Denmark

DME

Denmark (Euro)

DMI

Denmark Multinational

ESB

Estonia

FNB

Finland/Sweden

FNE

Finland/Sweden (Euro)

FNI

Finland/Sweden Multinational

FAB

France (Azerty)

FAE

France (Euro)

FAI

France (Azerty) Multinational

FQB

France (Qwerty)

FQI

France (Qwerty) Multinational

GKB

Greece

GNB

Greece

HNB

Hungary

ICB

Iceland

ICE

Iceland (Euro)

ICI

Iceland Multinational

INB

International

INI

International Multinational

IRB

Iran (Farsi)

ITB

Italy

ITE

Italy (Euro)

ITI

Italy Multinational

JEB

Japan (English)

JEI

Japan English Multinational

JKB

Japan (Kanji) and Katakana

JPB

Japan Latin Extended

JUB

Japan Kanji and United States English

KAB

Japan (Katakana)

KOB

Korea

LTB

Lithuania

LVB

Latvia

MKB

FYR (former Yugoslav Republic of Macedonia)

NCB

Hebrew

NEB

Netherlands

NEE

Netherlands (Euro)

NEI

Netherlands Multinational

NWB

Norway

NWE

Norway (Euro)

NWI

Norway Multinational

PKB

India (Urdu)

PLB

Polish

PRB

Portugal

PRE

Portugal (Euro)

PRI

Portugal Multinational

RCB

Simplified Chinese

RMB

Romania

ROB

Latin 2

RUB

Russian

SFI

Switzerland/French Multinational

SFM

Switzerland/French Multinational (Euro)

SGI

Switzerland/German Multinational

SGM

Switzerland/German Multinational (Euro)

SKB

Slovakia

SPB

Spain

SPE

Spain (Euro)

SPI

Spain Multinational

SQB

Serbia (Cyrillic)

SSB

Spanish Speaking

SSE

Spanish Speaking (Euro)

SSI

Spanish Speaking Multinational

SWB

Sweden

SWE

Sweden (Euro)

SWI

Sweden Multinational

TAB

Traditional Chinese

THB

Thailand

TKB

Turkey

TRB

Turkey (F1)

UAB

Ukraine

UKB

United Kingdom

UKE

United Kingdom (Euro)

UKI

United Kingdom Multinational

USB

United States/Canada

USE

United States/Canada Euro

USI

United States/Canada Multinational

VNB

Vietnam

YGI

Croatia, Serbia (Latin), and Slovenia

DefaultWorkstationCharset

Specifies the graphic character set used when creating a workstation device. The allowable values are:

Keyboard

Specifies that the character set associated with the device keyboard type will be used.

Sysval

Specifies that the character set defined in the QCHRID system value will be used.

Character set identifier

Specify the character set identifier to use. This value is a number between 1 and 32767 and must be a valid character set identifier. See the International Application Development book for information about valid graphic character sets.

If a character set identifier is specified then a value must also be specified for the DefaultWorkstationCodepage directive.

DefaultWorkstationCodepage

Specifies the code page used when creating a workstation device. If not specified the value used depends on the setting for DefaultWorkstationCharset.

When DefaultWorkstationCharset=Keyboard the code page associated with the device keyboard type is used.

When DefaultWorkstationCharset=Sysval the code page defined in the QCHRID system value is used. Otherwise a code page must be specified.

Value

Description

codepage identifier Specify the codepage identifier to use. This value is a number between 1 and 32767 and must be a valid codepage identifier.

See the International Application Development book for information about valid code pages.

HostCCSID

Specifies the CCSID used to convert host panel data into Unicode before sending the data to the client. This value has no effect on the interactive job - it is used only during data conversion. The allowable values are:

Value

Description

Auto

Specifies that aXes Terminal Server will automatically determine the CCSID to use by extracting the CCSID of the currently active display file. If the display file CCSID cannot be determined or is 65535 then aXes Terminal Server will use the CCSID of the interactive job. If this value is 65535 then the default CCSID of the interactive job will be used.

Job

Specifies that aXes Terminal Server will use the CCSID of the interactive job. If this value is 65535 then the default CCSID of the interactive job will be used.

CCSID-number

Specifies the CCSID that aXes Terminal Server will use. This value must be a valid CCSID, the CCSID must be valid for interactive IBM i jobs, and the data sent to the display must be in the specified CCSID.

InterSession

Specifies whether interactive sessions started by the terminal server have access to the full batch CPW capacity of the host system. Allowable values are 0 or 1. Zero (0) disables aXes Intersession and 1 enables aXes Intersession.

The default value is 0.

If you are installing aXes on IBM i Version 6 then aXes Intersession cannot be used. If you enable this directive the job log will indicate aXes Intersession is active but it will have no effect. On Version 6 you should leave, or reset, the value to the default of 0.

If you are installing aXes on an iSeries server with zero interactive capacity running IBM i VRM530 or above, you must use named devices.

In addition, if you are running aXes on an i5 Standard Edition Server with zero or reduced interactive capacity running IBM i VRM530 or above, you must used named devices and all virtual display devices must begin with the letters QQF.
See the Users Section and Device Selection information in the Terminal Server Configuration chapter of the aXes Reference for detailed information on controlling device naming and the meaning of special substitution values.

For iSeries servers on IBM i VRM530 or above ensure that all virtual devices used by aXes will be named devices by adding one of the following entries as the last entry in the list of user entries:

*=1,QPADEV$*

-or-

*=1,QPA$U$*

For i5 servers running IBM i VRM530 or above ensure that all virtual display devices used by aXes will have the prefix QQF by adding one of the following entries as the last entry in the list of user entries:

*=1,QQFDEV$*

-or-

*=1,QQF$U$*

Named device values must go in either the Users section of the aXes Terminal Server configuration file or in the file referenced in that section (usually <prod-dir>/configs/aXesTSUsers.conf).

If you already have a ‘catch-all’ entry such as this then you must modify it to match the required device naming criteria.

If you already have device names for individual users, or plan to add them, then you must ensure that they also match the required device naming criteria.

If aXes Terminal Server client sessions receive “AXS8124 – Error occurred opening terminal” and the AXES5250 job log shows “CPF8902 – Virtual device not available” then multiple users are requesting the same virtual device. You can either ignore this error and sign-on again or choose a device naming convention that reduces the possibility of device name collision by including the user name in the device name. For example:

*=1,QPA$U$*

-or-

*=1,QQF$U$*

Be aware that if you change the device naming convention you must ensure the system value QAUTOVRT is set to a sufficiently hight value to allow the new devices to be created. You may delete existing devices that no longer satisfy the required naming convention.

aXes Intersession is not supported on IBM i Version 6. Refer to the Considerations for IBM i Version 6 topic in the aXes Quick Start for more information.

aXes Intersession has no effect on systems without separate batch and interactive capacity. The following system models will not benefit from Intersession because they have a single CPW rating for the entire system workload.

Model

CPW

200 7.3-16.8
300 11.6-21.1
310 33.8-56.5
320 67.5-177.4
400 13.8-35.0
500 21.4-43.9
510 81.6-11.5
515 3800-7100
525 3800-7100
530 148.0-650.0
600 22.7-73.1
620 50.0-464.3
640 319.0-998.6
650 1794.0-4550.0

IPMask

Specifies the mask for an IP address that the connecting client must match. If the client does not match this address then the logon attempt will be rejected. The mask is of the form ‘nnn.nnn.nnn.nnn’ and wildcards (?,*,**) are permitted. The wildcards have the following meanings:

Value

Description

? Matches any single character
* Matches any characters except the dot (.) separator
** Matches any single character

For example, ‘192.10.1.1??’ means any IP address in the range 192.10.1.100 to 192.10.1.199 would be allowed. ‘192.10.1.*’ means addresses that start with 192.10.1 would be allowed. ‘192.**’ would allow any address that starts with 192. The default is to allow connections from any IP address.

JobName5250

Specifies the name of the child job created by aXes Terminal Server.

The default is to use the same name as the aXes Terminal Server job.

Library

Specifies the IBM i library name for aXes objects such as data queues.

The default value is the product installation library, if this is not found it then defaults to ‘AXES’.

Logpath

Specifies the name of the directory used for server trace files.

There is no default value.

MaxUsers

Specifies the maximum number of users allowed to sign on simultaneously the terminal server instance. The minimum allowable value is 1 and the maximum value is 32,767.

The default value is 32767.

Monocase

Controls which characters are converted to upper-case when the field indicates upper-case input is required. The allowable values are:

Value

Description

5494-subset Specifies that only those characters specifically listed in the 5494 Functions Reference as being affected by the monocase bit are converted to upper-case.
Extended Includes additional diacritic characters.
DBCS Indicates that full-width lower-case characters are converted to their upper-case equivalent if the field has the monocase bit set.
All All lower-case characters typed (diacritic, non-diacritic, and full-width) are converted to their upper-case equivalent if the field has the monocase bit set.

The options for the Monocase directive are additive and can be combined to achieve the preferred behaviour. For example:

Monocase=5494-subset, extended

Path

Specifies the PATH used for invocation of the aXes Terminal Server (aXes-TS) and CGI programs. The default path is /usr/bin:%LIBL%

ReplaceShiftWithSpace

Specifies whether to replace Shift-Out and Shift-In characters with a space. The space character used is x’0a’ which is the non-breaking space character. This is the same character as that represented by the HTML &nbsp; entity. Allowable values are 0 or 1. Zero (0) disables shift character replacement and 1 enables shift character replacement.

The default value is 0.

RequestThreadCount

Specifies the number of request threads that the terminal server supports. Request threads accept connections from an application server. This process is normally very fast and therefore the default is usually sufficient. The value can be increased if you have an exceptionally large number of connection requests.

The default value is 3.

ResponseThreadCount

Specifies the number of response threads that the terminal server supports. Response threads deliver the terminal XML to the application server. When the connection to the application server is across a slow network this number may need to be increased. The default value should be adequate when aXes Terminal Server is running as an internal FastCGI server using UNIX domain socket connections or when using local IP socket connections.

The default value is 3.

SignatureModel

Specifies the signature model that should be used for 5250 screen identification by the client system. The allowable values are 1 or 2 only. The default value is 2. Value 1 indicates that the original signature model should be used. Value 2 indicates that the enhanced signature model should be used. It is recommended that you only change this setting when advised to by your product vendor.

AllowLayoutGrids

Indicates whether CSS layout-grid options are allowed in client browser sessions. The default value is 1 (on) but you should always set this option to 0 (off) unless you are using Japanese or Chinese 5250 applications. The use of CSS layout-grid options are IE (Internet Explorer) specific at this time. HTML knowledge is required to understand how using them they may impact non-DBCS and mixed mode DBCS data. For this option to be effective your IBM i server must also have system value QIGC set to true.

TS2DefaultTheme

The default theme to be used for aXes-TS2 sessions. This value must specify the name of a validly formatted CSS style sheet document that exists in the <axes root>/ts/ts2/css folder. This theme will be used when useJQueryExtensions is unchecked in Application setting.

TS2DefaultJQTheme

The default theme to be used for aXes-TS2 sessions. This value must specify the name of a validly formatted CSS style sheet document that exists in the <axes root>/ts/ts2/css or the project folder. This theme will be used when useJQueryExtensions is checked in Application setting.

TS2ChangeTheme

Indicates whether users of aXes-TS2 sessions are allowed to change their theme. Allowable values are 1 (users can change themes) or 0 (users cannot change themes).

ccsidoverride

Allows the overriding of the CCSID conversion rules for 5250 screen content only.

Use this option with extreme caution. Do not use it unless you exactly understand what it does and why you need to use it. Carefully test all results before any production implementation is made. The customer is solely and completely responsible for any impact (in any context) that the use of ccsidoverride may have.

The configuration format must be ccsidoverride=CCCCC-EEEE-UUUU-OO-A. The override format must always be exactly as specified.

Always check the aXes AXES5250 job log after any ccsidoverride = changes for messages and warnings.

The ccsidoverride=CCCCC-EEEE-UUUU-OO-A format content is:

Format

Description

CCCCC A valid 5 digit CCSID (eg: 05035 or 00037) that specifies the CCSID to be overridden. The value must be 5 characters long.
EEEE An EBCDIC character value in hexadecimal format – the value must be 4 characters long and a valid hexadecimal value.
UUUU A UNICODE character value in hexadecimal format – the value must be 4 characters long and a valid hexadecimal value.
OO An option specified as BD (both directions), EU (EBCDIC->UNICODE) or UE (UNICODE->EBCDIC).
A The application. It must be one of D (DBCS), S (SBCS) or B (Both).

SignonMsgCCSID

Specifies the CCSID used to convert message text retrieved from the IBM i sign-on display panel into Unicode before sending the data to the client.

The allowable values are:

Value

Description

Auto Specifies that aXes Terminal Server will automatically determine the CCSID to use by extracting the CCSID of the sign-on display file associated with the subsystem that has allocated the display device. If the display file CCSID cannot be determined or is 65535 then aXes Terminal Server will use the QCCSID system value. If QCCSID is 65535 then Axes Terminal Server will use the CCSID of its own job. If this value is 65535 then the default CCSID of the aXes Terminal Server job will be used.
Job Specifies that aXes Terminal Server will use the CCSID of its own job. If this value is 65535 then the default CCSID of its own job will be used.
CCSID- number Specifies the CCSID that aXes Terminal Server will use. This value must be a valid CCSID, the CCSID must be valid for interactive IBM i jobs, and the sign-on messages must be in the specified CCSID.

TSExpiryTime

Specifies the timeout period, in seconds, for idle terminals. The host virtual terminal associated with a client will be closed if it does not perform a transaction within this period. After this idle period the session cannot be re-established via the ‘Resume’ or ‘Refresh’ options.

The default value is 3600 (1 hour).

TSExpiryTime set to 0 is not allowed, aXes requires this to have a value greater than 0, otherwise the error "the sessions get disconnected or ended" will be shown.

TSInactiveLimit

Specifies the wait time, in seconds, between the aXes Terminal Server and the client application.

The default value is 30.

The wait time is a conditional transaction timeout period. For example, when a terminal transaction exceeds this time, the aXes Terminal Server client (browser) will prompt the user if they wish to wait for the transaction to complete. The user may answer ‘yes’ in which case the client will continue to wait for the transaction to complete or they answer ‘no’ in which case the terminal can perform another HTTP transaction and may re-establish or refresh the terminal display by issuing the ‘Refresh’ transaction.The value specified for this directive must be less than the value specified for –idle-timeout specified on the FastCgiServer or FastCgiExternalServer directives in the aXes-W3 configuration file.

TSPath

Specifies the directory where the aXes Terminal Server files reside. There are no constraints on the name of this directory.

The default is a directory named <prod-dir>/ts where <prod-dir> is the product installation library

Trace

Specifies whether server tracing is active. Allowable values are 0 or 1. Zero (0) disables server tracing and 1 enables server tracing.

The default value is 0.

When set to 1 the LogPath directive must also be specified. A diagnostic trace is written to the <log-path>/.aXesTStrc.txt file.

TraceLevel=option-list

Specifies the level of trace information written to the trace log. The option-list is a space-separated list containing at least one of the following keywords:

Value

Description

Info When specified Informational messages will be logged to the IBM i job log and the trace file (if enabled). The default is that these messages are not logged.
Error When specified Error messages will be logged to the IBM i job log and the trace file (if enabled). The default is that these messages are not logged.
Warn When specified Warning messages will be logged to the IBM i job log and the trace file (if enabled). The default is that these messages are not logged.
Debug When specified Debugging messages will be logged to the trace file (if enabled). The default is that these messages are not logged.

Typeahead

Specifies whether keyboard type-ahead is active in the client. Allowable values are 0 or 1. Zero (0) disables keyboard type-ahead and 1 enables keyboard type-ahead.

The default value is 1.

Users Section

This optional section is used to specify User options for the aXes Terminal Server (aXes-TS) and is prefaced by a User tag. Each entry in the section is a comma-separated list of values. Each entry specifies a set of overrides for a specific user.

This section must be at the end of the configuration file.

The Users section can be replaced by a separate file if you specify Users=path. For example:

Users=/axes/configs/users.conf

Each entry in the Users section or the Users file is formatted as follows:
username=enable,device,inlpgm,inlmnu,curlib,ipmask,view,sessions,devtype, kbdtype,charset,codepagewhere username is an IBM i user profile name. Generic names may be specified by using wildcard characters. The question mark (?) represents any single character and the asterisk (*) represents any number of characters. The order of generic entires is important because the first match found is used. Generic names should be listed in order of most specific to least specific.
You can omit option values by specifying commas as placeholders, for example, JOE=1,,,,JOELIB but count the commas carefully. A user can be disabled from aXes Terminal Server by specifying a zero, for example, JOE=0.

The allowable option values are:

Value

Description

enable Enables or disables terminal access for a specific user. The default is to allow terminal access for anyone who has a valid IBM i user profile and password. Allowable values are 0 or 1. Zero (0) disables terminal access for the user. If the value is 0 the remaining parameters can be omitted.
Device
  • The name of the device associated with this user. There is no default value. Specifying a device name without substitution values effectively limits the user to one terminal session. This value must be unique. The following substitution values are supported:$U is replaced by the user’s profile
  • $* is replaced by a number padded with zeroes
Inlpgm The initial IBM i program to be run after a successful sign on. This value overrides any value defined on the user profile. There is no default value.
See Note 1 below.
Inlmnu The initial IBM i menu displayed after a successful sign on. This value overrides any value defined on the user profile. There is no default value.
See Note 1 below.
Curlib The initial current library for the user. This value overrides any value specified on the user profile. There is no default value.
Ipmask An IP address mask that must match the client IP address. This can be used to constrain user access from a range of IP addresses or a specific IP addresses. The default is to allow connection from any IP address. Address ranges may be specified by using wildcard characters. The wildcards have the following meanings:
? matches any single character.
* matches any characters except the dot (.) separator.
** matches any characters.
view or noview or default Specify view to indicate that this user’s sessions can be viewed by an authorised administrator.
sessions Specify the maximum number of aXes Terminal Server sessions this user is allowed to start at one time. The default is no maximum.
Devtype Specify the type of workstation device created for this user. The default is to use the value specified in DefaultWorkstationType.
kbdtype Specify the type of keyboard for the workstation device created for this user. The default is to use the value specified in DefaultKeyboardType.
Charset Specify the character set for the workstation device created for this user. The default is to use the value specified in DefaultWorkstationCharset. If charset is specified then codepage must also be specified.
codepage Specify the character set for the workstation device created for this user. The default is to use the value specified in DefaultWorkstationCodepage. If codepage is specified then charset must also be specified.

Note 1: specifying the initial program, initial menu, and current library is an arcane 5250 method and should not be used in a modernized application. Instead you should use the INLPGM associated with the user profile to call the required program.

User options example 1

User option: JOE=1,JOEDSP0001,QCMD,MAIN,JOELIB,192.10.1.*,view,1

Means: User JOE is allowed to start an aXes Terminal Server session.

JOE sessions will acquire the display device JOEDSP0001.

The initial program will be QCMD.

The initial menu will be MAIN. Note: This is ignored by IBM i because an initial program is specified which takes precedence over an initial menu.

The current library will be set to JOELIB.

JOE must sign-on from a client within the 192.10.1 network.

Administrators can view JOE sessions.

And JOE is restricted to a single session. Note: This is also a side effect of specifying a named device with no substitution values.

User options example 2

User option: QSECOFR=0

Means: QSECOFR cannot use any aXes Terminal Server sessions.

User options example 3

User option: SHC=1,AXESTS2$*

Means: User SHC is allowed to start an aXes Terminal Server session

SHC sessions will acquire display devices using the name AXESTS2nn where nn is a sequence number.

SHC can sign-on from any client

SHC sessions cannot be viewed

SHC can start any number of sessions

User options example 4

User option: TP*=1,AXES$U,,,,,,1

Means: Any user starting with TP is allowed to start aXes Terminal Server sessions

TP users will acquire display devices using the name AXESxxxxxx where xxxxxx will be the first six characters of the user name.

TP users can sign-on from any client

TP sessions cannot be viewed

TP users are restricted to one session each

User options example 5

User option: *=1,AX$U$*

Means: All users are allowed to start aXes Terminal Server sessions

Users will acquire display devices using the name AXxxxxxxnn where xxxxxx will be the first 6 characters of the user name and nn will be a sequential number.

A catch-all entry such as this example must be the last entry in a list of user entries.

Device Selection

Device selection is controlled by the <prod-dir>/ts/admin/tslogonexit.lua script. The script processes any substitution values specified in the device name component of the user definition.

The tslogonexit.lua script may be modified by customers to satisfy unique device naming requirements. Be aware that an exception in the script is likely to cause the server to fail so test any script changes thoroughly in a development server before making them available in a production server. The Lua Virtual Machine in aXes Terminal Server is Lua 5 so you must use Lua 5 functions and syntax if you modify this script.

The script is read into storage when the server is started so you must end and restart the server before any changes take effect.

If the tslogonexit.lua script is not found during server start up then a message is sent to the job log of the server job and default behaviour is used. The default behaviour respects the enable/disable flag and the IP mask setting.

 

Administrators

Legal Mentions

aXes is brought to you by:

LANSA

Serving the IBM i community for 30 years.