Configuration

Top  Previous  Next

This section covers the configuration aspects of XTND run as standalone service. To configure region embedded services, please refer to the XCICS/TS Configuration Guide, in the section "TN3270 Services".

XTND is configured using an XML file named xtnd.xml normally located in $HOME/etc of the owning user.

The configuration file is divided into different sections:

general settings
application definition

Whole configuration is identified by the tag <configuration>.

Settings element

This section, identified by the tag <settings>, defines the global parameters for the daemon behaviour.

Service element

It defines the main behaviour of XTND. The following attributes may specified:

attribute

default

description

address

None

network address to be bind

port

23

the port listening for incoming tn3270 connections

welcome

true

if true a welcome screen is sent to the emulator

multiplex

false

if true multiplex mode is enabled

tn3270e

False

if true XTND will try to negotiate TN3270E protocol

timeout

0

the time, in minutes, after that inactive terminals are automatically disconnected. If zero no timeout is set.

Trace element

It defines the full path name of XTND trace file. The following attributes may specified:

attribute

default

description

file

-

path name of trace file (%h is substituted with $HOME, %x with $XFRAMEHOME)

level

none

specified the trace level (none, log, debug)

License element

It defines the full path name of XTND license file. The following attributes may specified:

attribute

default

description

file

-

path name of license file (%h is substituted with $HOME, %x with $XFRAMEHOME)

Administration element

It defines the administration settings of XTND. If not defined no administration facility is provided. The following attributes may specified:

attribute

default

description

port

-

the port listening for incoming administration connections

Codepage element

It defines the codepage to be used by XTND. If defined specified codepage conversion tables are loaded. The following attributes may specified:

attribute

default

description

file

-

full path to the ASCII/EBCDIC EBCDIC/ASCII conversion table (%h is substituted with $HOME)

Conversion element

It defines the conversion behaviour of XTND. The following attributes may specified:

attribute

default

description

uppercase

true

if true XTND automatically converts lowercase chars into uppercase

security element

It sets up the eventual usage of SSL in the communication with the terminal emulators. When "ssl" attribute is set to to true, terminal emulators connected to XTND, must communicate over SSL (Secure Socket Layer). The element also defines the attributes of the Key Store.

attribute

default

description

ssl

false

if true, SSL communication is enabled

keystore

-

full path of the SSL key store

keystorepassword

-

pasword to open the keystore

Application element

This section, identified by the tag <application>, defines the XCICS application parameters. The following attributes may specified:

attribute

default

description

name

-

name of application as displayed in welcome screen

address

-

hostname/IP address of the XCICS application

port

-

port number of the XCICS appliaction (network_port)

default

false

if true the current application definition is the one to which terminals connect by default

Terminal element

It defines a terminal identifier. The following attributes may specified:

attribute

default

description

device

-

(mandatory) terminal device identifier. This parameter must match the corresponding "device" (physical) parameter in the "define terminal" statement in xcics.conf

name

-

synonym for device (for backward compatibility only)

luname

-

if provided, defines a LU name constraint

address

-

if provided, defines an hostname/IP address constraint

Terminals element

It defines a set of  terminals, defined in another application.

attribute

default

description

links

-

application name of the linked terminals

An example configuration file

<!-- xtnd.xml -->
<!-- xtnd configuration file -->
<configuration>
   <settings>
       <service port="8023" welcome="true" multiplex="true"/>
       <trace file="%h/logs/xtnd.trc"/>
       <administration port="7599" />
       <codepage file="%h/etc/IBM930.tbl"/>
       <conversion uppercase="false"/>
   </settings>
   <application name="DEMO" address="hpux01.ht.net" port="30585">
       <terminal device="TN00DEV0"/>
       <terminal device="TN01DEV0"/>
       <terminal device="TN02DEV1"/>
       <terminal device="TN0LDEVA" luname="LU01"/>
       <terminal device="TN0ADEVA" address="pc97.ht.net"/>
       <terminal device="TNALDE" luname="LU02" address="192.168.1.31"/>
   </application>
   <application name="OTHERAPP" address="aix02.ht.net", port="40000">
       <terminals link="DEMO"/>
   </application>
</configuration>
 
#
# xcics.conf for application DEMO
#
define terminal name=TN00, device=TN00DEV0, type=standard;
define terminal name=TN01, device=TN01DEV0, type=standard;
define terminal name=TN02, device=TN02DEV0, type=standard;
define terminal name=TL01, device=TN0LDEVA, type=standard;
define terminal name=TLED, device=TNALDE,  type=standard;

Java Virtual Machine options

In order to provide some options directly to the JVM running the XTND server, the environment XTND_JVM_OPTIONS must valorized with the required JVM options, and exported.

export XTND_JVM_OPTIONS="-Xmx128m -Xms64m"
xtndctl start

Memory issues

It is very important to properly set up the Java memory heap, when running XTND instances serving a large number of client: a shortage of memory in the JVM running XTND, may cause XTND to freeze. This issue depends on the number of terminals connected and on the maximum heap size defined for the JVM: java heap must be large enough to allow XTND to allocate memory for all the connections.