Definitions

The configuration file is located in /<aXes JSM Root>/jsm/instance/system/httpd.xml

The default JSM web root (<axes web JSM root>) is located /<aXes JSM Root>/jsm/instance/www/instance/htdocs

The format of the file is XML and it is recommended to use Notepad or Notepad++ to open it on windows.

The section related to aXes terminal server is defined by the following match tag:

<match uri="/axests/" class="com.axes.mobile.service.HTTPServiceAxes" trace="false">

...

<match>

The parameters are of this format:

<parameter name="<name>" value="<value>"/>

The parameters tags used by aXes Terminal Server are defined below

id

ID used in the naming of the outbound GET and API queue names in the AXESJSM subsystem

readers

Number of readers defined in the AXESJSM subsystem.

library

This defines the library in which aXesJSM is installed.

The default value is AXESJSM

timeout.get

Wait time for getJobName or getRecordFormat entry operation in ms

Default:

value="15000"

timeout.open

Wait time for terminal OPEN operation in ms

Default:

value="30000"

timeout.read

Wait time for terminal READ operation in ms

Default:

value="15000"

timeout.read.peek

Wait time for a quick peek for another VTTerminal in ms. This is unused at the moment.

Default:

value="0"

check.address

Enables a check to validate the terminal client's address is the same as the one seen by the transport layer.

Default:

value="true"

allow.key.sysreq

This parameter enables the system request SYS key.

Enable ATN and SYS Req keys

Default:

value="true"

allow.key.attention

This parameter enables the attention ATN key.

Enable ATN and SYS Req keys

Default:

value="true"

process.read.flags

This parameter runs through all IBM i fields with read flags and and processes their value on the server to make sure they are displayed properly on the client. True turn this feature on, False turn this feature off.

Default:

value="true"

replace.null.with.space

Specifies whether to replace null characters for Repeat To Address command.

Allowable values are true or false. False disables null character replacement and true enables null character replacement.

Default:

value="false"

replace.shift.with.space

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 true or false. False disables shift character replacement and true enables shift character replacement.

Default:

value="true"

dds.conversion.mode

Specifies whether to fix broken DBCS characters received by the server. A broken DBCS character is when a "Shift out" is not followed by a "Shift in". When this option is active, the server will fix broken DBCS characters by adding a missing "Shift in".

Allowable values are 1 (active) or 0 (inactive). 0 disables the automatic addition of a missing "Shift in".

Default:

value="0"

device.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.

Default:

value="10"

device.charset

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

Keyboard (integer)

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

0

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.

Default:

value="0"

device.codepage

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

When device.charset=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.

Default:

value="0"

device.keyboard

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

Default:

value=""

device.use.name

This parameter indicates to use the device name provided on the login screen. True will use the name provided, False will ignore the name provided

Default:

value="true"

device.use.menu

This parameter indicates to use the device menu provided on the login screen. True will use the menu provided, False will ignore the menu provided

Default:

value="false"

device.use.program

This parameter indicates to use the device program provided on the login screen. True will use the program provided, False will ignore the program provided

Default:

value="false"

device.use.library

This parameter indicates to use the device library provided on the login screen. True will use the library provided, False will ignore the library provided

Default:

value="false"

device.autosignon

This parameter indicates whether the system will automatically log the user onto the system using profile tokens. This is required to be true in an SSO environment.

Single Sign-On Support

Default:

value="true"

device.dbcs

Indicates whether the device is DBCS capable.

Default:

value="true"

device.signon.ccsid

Default:

value="37"

device.password.min

This setting indicates the minimum password length to use

Default:

value="6"

device.password.max

This setting indicates the maximum password length to use

Default:

value="20"

device.password.ccsid

This setting indicates the CCSID to use for the password on the login screen.

Default:

value="37"

device.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.

Default:

value="true"

device.monocase

This setting controls how Japanese full width characters are uppercased. Allowed values are:

1 - 5494-Subset

2 - Extended

3 - 5494 or Extended

4 - DBCS

5 - 5494 or DBCS

Default:

value="1"

device.type.ahead

Not applicable to TS2.

Default:

value="true"

device.expiry.time

Not applicable to TS2

Default:

value="3600"

device.change.theme

This settings defines whetehr the user is alowed to change themes on the aXesTS client using the themes menu. True allows the user to change theme. False does not allow the user to change theme.

Default:

value="true"

device.default.theme

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 web JSM root>/ts/ts2/css folder. This theme will be used when useJQueryExtensions is unchecked in Application setting.

Default:

value="theme_default"

device.default.jqtheme

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 web JSM root>/ts/ts2/css or the project folder. This theme will be used when useJQueryExtensions is checked in Application setting.

Default:

value="smoothness"

device.system.name

The system name. This name will appear in the browser title of you axesTS window.

Default:

value="YOUR SYSTEM NAME"

device.override

Specifies the characters to override in JSON format with the following name pairs:

f - unicode character value to be converted from

t - unicode character value to be converted to

c - comment (unused)

For example to convert 2 characters from Yen to Backslash and backslash to Yen:

type="json" value="{input:[{f:'\u005C',t:'\u00A5',c:'Backslash to YEN'}],output:[{f:'\u00A5',t:'\u005C',c:'YEN to Backslash'}]}"

Default:

type="json" value=""

device.options

This option gives the ability for an administrator to set options depending on the user who logs in using the following parameters:

device: This parameter will set the job name according to the user profile who is logged in.

$U will be replaced by the user profile

= will be an incremental counter.

Example: Simple job matching the username name.

Use the syntax below if you want that a user profile called USERA is assigned the job name AXUSERA01, for example.

type="json" value="{device:'AX$U='}"

Default:

type="json" value=""

device.options.USER

This option gives the ability for an administrator to set job options for a specific USER profile. The following parameters are available:

  • Name: Specifies the name of the job.
  • Device: Specifies the device type according to the IBMi specifications.
  • charset: Specifies the device character set.
  • codepage: Specifies the device code page.
  • keyboard: Specifies the keyboard.
  • program: Specifies, for an interactive job, the program called whenever a new routing step is started that has QCMD as the request processing program.
  • menu: Specifies the initial menu displayed when the user signs on the system if the user's routing program is the command processor QCMD.
  • library: Specifies the name of the current library associated with the job being run.
  • autosignon: Specifies the auto sign-on option
  • sessions Specifies the number of sessions allowed.

Example: Simple job matching the username name.

Use the syntax below if you want that a user profile called USERA has the following options set to the job:

  • Name: Tee job name will be MYD
  • Device: The device type will be 15
  • charset: The device character set will be 697
  • codepage: The device codepage will be 37
  • autosignon is true
  • session number is 1.
  • All other options are default.

<parameter name="device.options.USERA" type="json "value="{device:'MYD',type:15,charset:697,codepage:37,keyboard:'',program:'',menu:'',library:'',autosignon:true,sessions:1}"/</p>

Default:

type="json" value=""

service.user.allow

This setting defines which users are allows to use the system. Multiple users can be separated by a comma

*USER - All users are allowed to login

A user profile name can also be specified to allow this user explicit access.

Wildcards can be specified to allow a set of user profiles. The example below allows all user profiles that start with WEB*.

value="WEB*"

Default:

value="*USER"

service.user.deny

This setting defines which users are explicitly denied access to the system. Multiple users can be separated by a comma

Wildcards can be specified to to deny a set of user profiles. The example below denies all user profiles that start with WEB*

value="WEB*"

Default:

value=""

service.time.start

Access time start allowed for the services. If the time is not within these setting, axesjsm will not allow access/login.

service.time.end

Access time end allowed for the services. If the time is not within these setting, axesjsm will not allow access/login.

Administrators

Legal Mentions

aXes is brought to you by:

LANSA

Serving the IBM i community for 30 years.