Environment Configuration

Range: a string of up to 63 characters.

The DOMAIN element configures settings for the overall Tmax environment.

Range: 32768 ~ 262143

Value of the pointer that points to a shared memory segment.

Can be used in all elements of the environment file. For details, refer to "DEFAULT in 3.2.2 NODE".

Range: 1 ~ MAX_INT

The maximum number of clients that can be simultaneously connected to the domain. The actual number of connections allowed is MAXUSER +1.

Range: 1 ~ 10

Default: 1

The minimum number of startup CLH processes.

MINCLH = 2

Range: 1 ~ 10

Default: 10

The maximum number of active concurrent CLH processes allowed. When Tmax is started, MINCLH number of CLH processes are activated. Additional CLHs can be activated if the number of client requests exceeds the capacity of the active CLHs.

Default: 8888

Port number used by clients to connect with Tmax. Two port numbers are used: TPORTNO and TPORTNO+1.

The address (TMAX_HOST_ADDR) and port number (TMAX_HOST_PORT) must be set on the client side. The port number must be set to TPORTNO. If the client and server are both on the same node, it is recommended to use the domain socket instead of the TCP/IP socket to achieve more efficient connections.

If the client and server are both on the same node, TMAX_HOST_PORT must be set to PATHDIR instead of TPORTNO. For example, set the following in .profile or tmax.env.

TMAX_HOST_PORT=/home/tmax/path

Nodes in the Tmax system are connected in a peer-to-peer relationship. By using the port number TPORTNO+1, subsequent nodes will be checked in the order they are configured. Port numbers less than 1024 should not be used since they are reserved for system use.

Since the port numbers, TPORTNO and TPORTNO+1, are used for communication between a client and Tmax as well as between nodes, check that these values are not used anywhere else. In addition, for multi-node systems, the number of specified port numbers must match the number of CLHs. There must be a separate port number for each CLH.

To use the IPv6 protocol, CLIENT_PROTOCOL must be set to 'IPV6'.

Default: 3333

Port number used by racd for inter-node communication and centralized node management in a multi-node domain. The port number must be same as the TMAX_RAC_PORT port number. Port numbers less than 1024 should not be used since they are reserved for system use.

If the values specified here and in TMAX_RAC_PORT are different, only the TMAX_RAC_PORT value will be used. It is recommended to use a lower value for RACPORT than TPORTNO. Make sure that the port numbers specified in RACPORT are not used anywhere else.

Range: 1 ~ MAX_INT

Default: 0 (seconds)

Fractional numbers can be set.

If no value is set, by default requests will infinitely wait for a response.

Time-out value for service requests. If a service request issued by a client fails to receive a response within the specified time frame, the request will time-out on the client side. However, the server process will continue to process the request.

To terminate the service on the server side, set the desired time-out period in SVCTIME of the SERVICE element. BLOCKTIME is strongly linked to SVCTIME. The shorter time value between BLOCKTIME and SVCTIME is used as timeout for client tpcall. BLOCKTIME is the tpcall timeout value, and SVCTIME is the server process timeout value. In general, BLOCKTIME value is greater than SVCTIME value.

Range: 1 ~ 128

Default: 1

The number of channels of CLH processes on a node in multi-node systems. In systems with large volumes of inter-node service requests or that process large volumes of distributed transactions, too few number of channels may slow down service processing. For optimal system performance, use an adequate number of parallel communication channels.

Range: 1 ~ MAX_INT

Default: 0

If not specified, the default value is set, and the function is not used.

Size of the function table require for TopEnd system functions in Tmax system when converting a TopEnd system to a Tmax system.

Registers services to be processed in normal or abnormal state with the client logout process of Tmax server.

Used for normal client logouts when logging in or out of a service. Handles the case where clients are automatically logged out when a preset time (CLICHKINT, IDLETIME) expires.

Note that this variable only runs on Tmax clients. It does not run when using a general socket connection. For programs that use the service name, client IDs can be obtained by calling tpgetclid(). Refer to CD of tpsvcinfo structure to determine the cause of the logout.

Range: 1 ~ MAX_INT

Default: 0

If not specified, the default value is set, and the function is not used.

The time interval at which clients are monitored. CLICHKINT must be used in conjunction with IDLETIME to minimize resource waste.

If CLICHKINT is configured in the DOMAIN element, all clients connected to the domain are monitored. However, if it is configured in the NODE element, only those clients that are connected to the node are monitored.

Range: 1 ~ MAX_INT

Default: 0

If not specified, the default value is set, and the function is not used.

Time period that clients can remain idle before being automatically disconnected from the system. If CLICHKINT is set to 5 and IDLETIME is set to 30, clients will be monitored every 5 seconds (CLICHKINT) and if they do not issue any service requests within 30 seconds (IDLETIME), they will be disconnected from Tmax system.

Clients will be monitored from the time tpstart() is called to make a connection, or when tpcall()/tpacall() is requested. The value of IDLETIME must be set to a value greater than BLOCKTIME and SVCTIME. If IDLETIME is set to a value less than either BLOCKTIME or SVCTIME value, clients will automatically be disconnected before they receive a response.

Range: 1 ~ 1024

Default: 8

The number of times tpacall() can be requested by a server process without a tpgetrply() call. Since the server library follows each tpacall() call, the table needs to be created in the initial MAXSACALL that configures the table size.

Range: 1 ~ 1024

Default: 16

The number of times tpacall() can be requested by a client process without a tpgetrply() call. Since the client library follows each tpacall(), the table needs to be created in the initial MAXCACALL that configures the table size.

Range: 1 ~ MAX_INT

Default: 0 (seconds)

Fractional numbers can be set.

If not specified, by default requests will infinitely wait for a response.

Time-out period for service processing in a transaction (in seconds). When the time-out period is exceeded, the transaction is cancelled.

Internal time-out setting that is applied to prevent infinite blocking that can be caused by DB or network failure during XA processing before/after service processing.

Range: 1 ~ MAX_INT

Default: 30 seconds

Node monitoring interval (in seconds) for a multi-node Tmax system. To ensure reliable inter-node communications at all times, the nodes of a domain are connected in a peer-to-peer relationship, and each node regularly monitor the subsequent node in the order they are configured.

If the interval period is short, nodes are monitored frequently and node failures are detected quickly, but inter-node traffic may increase to an unacceptable level. On the other hand, if the interval period is long, nodes are monitored less frequently but inter-node traffic is reduced. Select an appropriate value by considering both the network traffic and need for quick error detection.

Range: 1 ~ MAX_INT

Default: 0 (seconds)

Time-out period (in seconds) with no data flow that triggers CLHs of each node to send a monitoring signal to each other.

This feature must be used with care since after a time-out period with no data flow, the firewall will terminate all processes and this will affect CLH processes of Tmax.

Range: 1 ~ 2048

Default: 16

Maximum number of interactive services that can be simultaneously executed for each CLH. If all clients and server processes can simultaneously call up to 100 interactive services, use a value that is greater than or equal to 100.

If the number of services exceeds this value, a TPELIMIT error will occur.

Range: 1 ~ 256

Default: 8

Similar to MAXCACALL and MAXSACALL, this variable specifies the maximum number of interactive services that can be simultaneously executed by a client or a server process.

If the number of services exceeds this value, a TPELIMIT error will occur.

Default: "NO_SECURITY"

Security setting whose value is one of the following: "NO_SECURITY", "DOMAIN_SEC", "USER_AUTH", and "OTHER_AUTH".

Range: a string of up to 63 characters.

For details, refer to Security Settings.

Range: 0600 ~ 0777

Default: 0600 (If not set, the default value for file access control is 600.)

Inter-Process Communication Permission Mask (IPCPERM) specifies the control unit of the pipe file located in ${TMAXDIR}/path and in shared memory segment. It also sets the control unit of the system log file (${TMAXDIR}/log/slog).

In UNIX, the administrator can assign file access control (to read, record, and execute files) to each individual and group. Read and write accesses can be assigned to individuals, but not to groups.

This item is used to grant users the permission to start and terminate server processes. Without IPCPERM, users cannot start or terminate server processes.

This item sets the control unit of log files created by TMM, CLL, and CLH. It affects svclog and ulog files and log files created by an engine such as server log files that start according to the setting of ASQCOUNT and POD.

Range: 0 ~ 255

Default: 0

Key value that identifies the domain in a multi-domain environment. Required setting for multi-domain systems.

Default: Y

Refer to Distributed Transaction Settings.

Range: 1 ~ MAX_INT

Default: 32

Maximum number of nodes allowed per domain.

Range: 1 ~ MAX_INT

Default: 32

Maximum number of server groups allowed per node.

Range: 1 ~ MAX_INT

Default: 64

Maximum number of server processes that can be started on the node. It is calculated by taking the sum of maximum values of each server processes.

Range: 1 ~ MAX_INT

Default: 64

Maximum number of servers that can be registered per node.

Range: 1 ~ MAX_INT

Default: 512

Maximum number of services that can be assigned to each domain.

This value may be different from the result of executing "cfg -d" in tmadmin because this includes space reserved for dynamically adding services and nodes later.

Range: 0 ~ 65535

Default: 32

Maximum number of CPCs allowed per node.

Range: 1 ~ MAX_INT

Default: 32

Maximum number of active TMSs allowed per node.

Range: 1 ~ MAX_INT

Default: 16

Maximum number of services that can configure the ROUTING setting.

Range: 1 ~ MAX_INT

Default: 32

Maximum total number of groups (server groups or domain gateways) configured in the ROUTING setting of the SERVICE element.

*SERVICE
A        ROUTING = RT1
B        ROUTING = RT2

*ROUTING
RT1     RANGES = "'a':svg1,*:DGW1"
RT2     RANGES = "'a':svg1,'b':svg2,'c':DGW2,*:DGW1"

Range: 1 ~ MAX_INT

Default: 2

Maximum number of active RQs per node.

Range: 1 ~ MAX_INT

Default: 2

Maximum number of active gateways per node.

Range: 1 ~ MAX_INT

Default: 16

Maximum number of server groups that can configure the COUSIN setting. For example, if 10 out of 30 server groups can configure the COUSIN setting, set MAXCOUSIN to 10.

Range: 1 ~ MAX_INT

Default: 32

Maximum total number of server groups that can configure the COUSIN setting of SVRGROUP element. For example, if the MAXCOUSIN value is 10 and COUSIN setting can be configured in two server groups, set MAXCOUSINSVG to 20.

Range: 1 ~ MAX_INT

Default: 16

Maximum number of server groups that can configure the BACKUP setting. For example, if 10 out of 30 server groups can configure the BACKUP setting, set MAXBACKUP to 10.

Range: 1 ~ MAX_INT

Default: 32

Maximum total number of the server groups that can configure the BACKUP setting of SVRGROUP element. For example, if the MAXBACKUP value is 10 and each BACKUP setting can include two server groups, set MAXBACKUPSVG to 20.

Range: 1 ~ MAX_INT

Default: 64

Maximum number of server groups that can be configured.

Range: 1 ~ MAX_INT

Default: 0

If not set, the default value is used, and this function is not used.

This item indicates the maximum value of product name that can be specified as the item that is used to convert a system, which was made for TopEnd system, into the Tmax system. (for TopEnd use)

Range: 1 ~ MAX_INT (seconds)

If a gateway to a backup node is available within a multi-domain system, service requests will be transferred to the backup node if a fault occurs in the main remote node. Service requests will maintain their connection to the backup node even after the main node has been recovered. The gateway to the backup node must be shut down before the service request can re-connect to the main node. However, if the GWCHKINT variable is properly configured, service requests will automatically reconnect to the main node after recovery.

Considerations

Range: 1 ~ MAX_INT (seconds)

The domain gateway tries to connect to the remote gateway at system startup.

If the GWCONNECT_TIMEOUT is not specified, default procedures will be used.

Default: DETAIL

Specifies one of the following logging levels for the TMM.

Range: Same as that of the TMM

Specifies the logging level for the CLH.

Range: Same as that of the TMM

Specifies the logging level for the TMS.

Specifies the logging level of the servers.

Default: N

Tmax 4 and later is capable of encrypting data transmitted between clients and the Tmax system to ensure extra protection. For this feature to be used, it must be configured for both the client and Tmax system.

To set this encryption function for Tmax system, set CRYPT to Y. To not use the encryption function, set CRYPT to N, default value. For information about encryption for a client, refer to the TMAX_SEMANTICS variable in Tmax Client Environment Variables.

Note

Default: 3DES

Encryption method. Either 3DES and AES.

Confirm that the CRYPT_ALGORITHM value in the server configuration file and the TMAX_CRYPT_ALGORITHM value in the client configuration file are the same.

CRYPT must be set to Y to use this item.

Range: 1 ~ MAX_INT

Default: 0

If not specified, the default value is set, and the function is not used.

In Tmax 4 and later, TMS can be configured as a multi-thread transaction manager to improve transaction processing efficiency. To enable this feature, set this value to the maximum number of threads for TMS. Additionally, the TMSTYPE, TMSTHREAD, and TMSOPT variables of the SVRGROUP element must also be configured in conjunction with this variable.

Note

Default: N

Option to use (Y|N) the TDL (Tmax Dynamic Library) Implicit Version Protection will be used.

Range: 1 ~ 65535

Default: 1024

Maximum number of sessions that HMS can create per node. For details, refer to HMS Settings.

Range: 1 ~ MAX_INT

Default: 0

Time-out value for pending transactions. If no response is issued from a pending transaction for this time period, the transaction will be rolled back. If no value is set, no checks are performed.

Default: "IPV4"

Protocol used when creating a port for client connections. If multiple protocols can be used, they are set by using a comma (,) as a delimiter.

Default: "IPV4"

Protocol used when creating a port for inter-node communication in a multi-node environment. If multiple protocols can be used, they are set by using a comma (,) as a delimiter.

Default: "IPV4"

Protocol used when creating a port for connection to the Extern Server from Tmax system. If multiple protocols can be used, they are set by using a comma (,) as a delimiter.

Default: N

Option to use the IPv6 protocol when creating a port for client connections.

Default: N

Option to use the IPv6 protocol when creating a port for inter-node communication in a multi-node environment.

Default: N

Option to use the IPv6 protocol when creating a port for connection to the Extern Server from Tmax system.

Default: Y

Option to use the interface of IP address configured in IP setting of the NODE element when creating a port for client connection.

Default: 1

Range: 1 ~ 2

If set to 2, it uses the version with enhanced search performance and is not compatible with existing Tmax system.

Default: 1073741824

Range: 1024 ~ 1073741824

Maximum message size. If the size of a message from a client or server exceeds the value, a warning message is recorded in slog, but the message is processed.

Default: 1073741824

Range: 1024 ~ 1073741824

Maximum message size. If the size of a message from a client or server exceeds the value, a warning message is recorded in slog, and the connection is ended.

Default: 1

Range: 1 ~ 65535

Number of CPCs between CAS processes and the node’s CLH processes.

Currently, this item must be set to 1.

Size: Up to 63 characters

Name of the physical machine. This value must match the name returned by the UNIX command, uname -n.

Size: Up to 255 characters

Full path of the directory where Tmax is installed. The path must be the same as the value of TMAXHOME. If TMAXHOME is not specified, all Tmax related tasks are performed from the TMAXDIR directory.

Size: Up to 255 characters

Full directory path for server application program executable files.

Tmax system processes as well as application processes for client requests start and terminate with the system.

APPDIR is also used as a working directory of the server. Core files created in a server program is stored in the APPDIR.

This variable can be defined in all elements of the configuration file (NODE, DOMAIN, …​).

If a default setting is reconfigured in a NODE element, the new value is applied to that node.

Size: Up to 255 characters

This item is used to assign an actual hostname when the hostname is different from the configured node name. By setting the HOSTNAME, multiple logical nodes can be configured on a single machine. Multiple node names can be used per hostname.

TMAXHOME, NODETYPE, RACPORT, TPORTNO, and SHMKEY items must be configured in the NODE element. For details, refer to the following "Example" of the NODE element.

Size: Up to 255 characters

This item can be used to separately configure the Tmax installation and working directories. TMAXHOME is the absolute path of the directory where Tmax is installed, and must be same as the value of the TMAXHOME environment variable. If TMAXHOME is configured, TMAXDIR is the working directory path. Otherwise, TMAXDIR is the path for both directories.

Default: SHM_RACD

Method for managing individual nodes when there are multiple logical nodes on a single machine. Each local node of a machine must have a different RACPORT value. Where there are multiple local nodes, each local node must be set to a different RACPORT value.

This setting is used to determine whether to use RACD when executing tmboot/tmdown/tmadmin/cfl on node B, which is on the same host node as the logical node (node A) that has already started executing tmboot/tmdown/tmadmin/cfl.

Management options are:

Size: Up to 255 characters

Default: ${TMAXDIR}/path

The directory path of the named stream pipe used for communication between Tmax processes. Communication methods include using a pipe (unnamed/named pipe), message queue, or shared memory.

PATHDIR is the directory path where pathnames, which are required for communication between Tmax processes through stream pipes, are created. Named pipes are created in this directory. If PATHDIR is not defined, pipes will be created in a new directory inside the directory configured in TMAXDIR.

If PATHDIR is set to another(not $TMAXDIR/path) directory, the system may not terminate properly when Tmax system shuts down. This is because the system uses the stream pipe(named pipe) in $TMAXDIR/path directory when the system terminates. In order to resolve this problem, the user should configure the environment variable, TMAX_PATHDIR, with the PATHDIR value in the configuration file. Now if the system terminates, it will shut down properly by referencing the environment variable, TMAX_PATHDIR.

export TMAX_PATHDIR = /home/tmax/path_new

When Tmax system starts, previous configuration file in the config directory is copied to PATHDIR of the configuration file. This will prevent the system from not terminating properly when the configuration file is modified after Tmax system starts. If you set the previous PATHDIR (the one that was referenced at startup) in the TMAX_PATHDIR, the previous configuration file will be created under this directory. This configuration file will not be modified even if the configuration file is modified after system startup.

Size: Up to 255 characters

Default: ${TMAXDIR}/log/slog

The absolute path of directory where system messages are logged. The logged messages include those generated by TMM, TMS, CLL, and CLH, as well as those generated internally by the system. The slog.date file for each date is created in this directory, and messages are saved to a file according to the date they are created.

If no directory is specified in SLOGDIR, a log/slog folder will be created inside the directory configured in TMAXDIR.

Size: Up to 255 characters

Default: ${TMAXDIR}/log/tlog

The absolute path where TXLOG file is created. The TXLOG file is used to log information about XA transactions. It is created as an unreadable binary file that is used to manage transaction information of Tmax engine. The file is created with a file system and TXLOG file logging is supported depending on the raw file.

If TLOGDIR is not defined, transaction information will be logged in the log/tlog folder inside the TMAXDIR directory.

During system boot, if a log file from the previous boot exists, the file is backed up as '.old', and a new transaction log file is created. The file cannot be larger than 16 MB, and the size can be modified by using the -l option of TLMOPT.

The size for a single xid in txlog is about 32 bytes. (txlog file size does not expand infinitely.)

Size: Up to 255 characters

Default: ${TMAXDIR}/log/ulog

The absolute path where user messages are logged.

Users, or developers, can use the userlog() function to log debugging or various error and warning messages.

The messages generated by userlog() function are saved in the ULOGDIR directory. The ulog _date file for each date is created in this directory, and messages are saved to a file according to the date they are created. For more details about userlog(), refer to Tmax Application Development Guide

If no directory is set to ULOGDIR, messages will be logged in the log/ulog directory inside the TMAXDIR directory.

Size: Up to 63 characters

Since the system can consist of multiple domains, the domain that the node belongs to must be specified. The domain name must be configured in the DOMAIN element of the configuration file.

Range: 1 ~ MAX_INT

Dequeues expired messages. Too many messages can be queued because of host and network issues. In this case, this item can be used to notify the queue status for a client to handle the status.

Size: Up to 255 characters

Configuration file that contains UNIX environment variables used to configure an appropriate environment for executing server application programs. The server application programs run in the environment configured with the settings in the ENVFILE.

Tmax system port number that clients can use to connect to servers. The port number is used as an alternative to TPORTNO.

A total of five ports can be used for connection if all ports from TPORTNO2 to TPORTNO5 are configured. Port numbers less than 1024 should not be used since they are reserved for system use.

TPORTNO and the next consecutive port number (TPORTNO+1) are reserved for communication between clients and Tmax or for inter-node communication. The port numbers must be unique, and the port number in TPORTNO should be different from those already configured.

Size: Up to 255 characters

Command options that can be sent to the TMM process when it starts. Options before '--' are used by Tmax system, and those that come after '--' can be used by general users.

The following are the most commonly used options.

Size: Up to 255 characters

Command options that can be sent to the TLM process when it starts.

The following is the most commonly used option.

Command options that can be sent to the CLH process when it starts. Detailed options are same as that of TMMOPT.

The following conditions are required to transmit a message to a service designated by CLH.

The name of the RDP server process, if using one.

There must be one real server per node. Clients can access all services of a node through the RDP server processes. The RSCPC value must be set to the number of channels that are used to receive results from other server processes. The number of CLH and RDP server processes must remain constant and the MIN and MAX values must be the same. In general, the ratio of the number of processes of RDP to CLH should be 2 to 1. The number of RDP processes must always be greater than that of CLH.

Range: 1 ~ 128

Number of channels used by RDP processes to communicate with other servers.

Range: 1 ~ 128

Default: 32

Maximum number of server groups per node.

Range: 1 ~ 128

Default: 32

Maximum number of TMSs that can be invoked on the node.

Range: 1 ~ 128

Default: 2

While MAXGW is the maximum number of gateways that can be used on the node, MAXGWSVR is the maximum number of gateway server processes that can be invoked on the node. The default value is 2, which means that there are two gateways and each gateway can have one gateway server.

Range: 1 ~ 128

Default: 2

Maximum number of RQ server processes that can be invoked on the node. The default value is 2, which means that there are two RQs and each RQ can have one RQ server.

Range: 1 ~ 128

Default: 8

Maximum number of connections between a gateway and a CLH.

CPC with a server is basically composed of a pair of channels (input/output). If CPC and the number of gateways are both set to 2, MAXGWCPC must be set to at least eight connections. The sum of MAXGWCPC must also be less than the value of MAXCPC.

Default: Y

Option to automatically activate the backup server in the event of server failure.

Alternate port number for TPORTNO and TPORTNO[2-5]. It is recommended to use TMAXPORT instead of TPORTNO[2-5] when multiple port numbers are used.

Port numbers used by clients to communicate with Tmax system using the data compression function. If no port numbers are set, the data compression function is not used during communication. Note that the port numbers must be those that are managed by Tmax.

This feature is not recommended for use in a general network environment since overhead for data compression is greater than network transmission delay. Data compression is usually used when sending a relatively large volume of data under poor network conditions.

The following tables display the amount of time required for transmitting 1.5 MB of data using a 100 Mbps Local LAN (first two tables) and a 56 KB modem (third table). The results show that it is best to use the compression function when transmitting a large volume of text data via a modem.

Minimum size (unit: bytes) of data that can be compressed when using the compression function.

Must be used in conjunction with COMPRESSPORT.

In the following example, Tmax system uses data compression when communicating with the client through port 9999. In the example, data compression will only be used if the data size is larger than 10000 bytes. If the data size is smaller than this value or the client is connected to port 8888, data will not be compressed.

TMAXPORT = "8888, 9999", CompressPort = "9999" CompressSize = 10000

Default: Y

Option to reload CLH, CAS, CLL, and TLM upon abnormal termination.

Settings for fault tolerance features. For details, refer to Fault Tolerance Settings.

Tmax supports EXTERN server functions to use functions of Tmax configuration file from an external process, a non-Tmax process.

Listen port number of CLH. If not specified by the system administrator, the system will assign a value.

The following is an example of configuring EXTERN SERVER.

*NODE
tmaxh3        ...
              EXTPORT = 9000, EXTCLHPORT = 9010

*SERVER
alinkjmapp    SVGNAME = svg1,
              MIN = 1, MAX = 1,
              CPC = 10,
              SVRTYPE=EXTSVR

*SERVICE
JMAPPER       SVRNAME = alinkjmapp,
              SVCTIME = 30

Default: N

Option to use SysMaster Trace function.

SysMaster Trace function uses the GID of a running service to trace system tasks. Only TCS and UCS servers that can use GID are supported. GID can be used for requests sent through TCP_GATEWAY(CUSTOM_GW) are supported.

Range: 1024~MAX_INT

Default: 50000

Maximum number of SysMaster traces that can be stored per CLH. Only required if SMSUPPORT has been set to Y.

Default: N

Option to use the CLL Block.

If there is a client request when Tmax service is not completely started up, the client is allowed to access the Tmax system if CLL is running, but it will receive the TPENOREADY error.

When the service is running and ready, you can cancel the CLL blocking function by using the tmadmin command.

Exception port numbers for the CLL Block. Select among the port numbers set in TMAXPORT.

Even if the CLL Block is set, you can specify exception ports for the CLL Block in the Tmax configuration file, and the clients that connect through these port numbers will not be blocked.

Default: 0

CLL Block time (seconds) for if CLLBLOCK=Y. If the block time expires, the CLL Block is released.

If this value is not set when the block time is less than 0 or CLLBLOCK=Y, the CLL Block must be released using tmadmin.

Default: RR

Method used by CLL to send a client connection to CLH.

If set to CLLCONNLB = LC, Least Connection method is used to make the next connection to the CLL with the least number of connections.

If CLLCONNLB is not set or is substituted by some other value, the default method (Round Robin) is used to make the next connection.

If this value is set in the NODE element, only the client data that were accessed through these ports are encrypted. This allows encryption at the session level which provides a more flexible encryption function.

Note:

A Back-up Node (TRB Node) that can process transaction recovery when a node is temporarily unavailable due to machine failure in a Multi-Node & Multi-Domain environment. This setting can help with the low availability problem caused by pending transactions.

As in the following figure, preconfigure TRB Node A' for the Node A.

TRB

TRB item and Primary Node name must be configured in the Back-up Node (TRB Node).

TRB Node must have one server group. Database information and one TMS must be configured in the server group. To use a Gateway, the TRB item must also be configured in the GATEWAY element.

Note:

Startup/Termination of TRB Node

$tmboot –B <nodename>

*NODE
#Primary node
NODE1     TMAXDIR = /data/tmax

#TRB node
NODE2     TMAXDIR = /data2/tmax, TRB = NODE1

Range: 1 ~ 65535

Default: 1024

Maximum number of sessions that can be created in an HMS of the node. For details, refer to HMS Settings.

Range: 32768~262143

Key value that refers to the shared memory segment used as Tmax Session Queue repository.

Range: 4 ~ 4000000 (Unit: KB)

Size of the shared memory segment used as SQ repository.

Range: 2 ~ MAX_INT-1 (Unit: KB)

Maximum number of SQs that can be created in the node. Must be an even number. If you use an odd number, it will be automatically decreased by 1.

Default: 1~ MAX_INT

Maximum number of keys that can be saved in each SQ.

Default: 1~MAX_INT (seconds)

Timeout for SQ data keeping. When timeout is reached, data will be automatically deleted.

Size: Up to 255 characters

IP address of the node.

Can be used if the IP address cannot be deduced from the host name when attempting to connect to another node.

Set SYSTEM_PROTOCOL to 'IPV6' to use an IPv6 address.

Used as IP address of an interface to bind to when creating a port for client connection (related setting: CLL_BIND_IP).

Default: "IPV4"

Protocol used when creating a port for client connections. If multiple protocols can be used, they are set by using a comma (,) as a delimiter.

Default: "IPV4"

Protocol used when creating a port for inter-node communication in a multi-node environment. If multiple protocols can be used, they are set by using a comma (,) as a delimiter.

Default: "IPV4"

Protocol used when creating a port for connection to the Extern Server from Tmax system. If multiple protocols can be used, they are set by using a comma (,) as a delimiter.

Default: N

Option to use the IPv6 protocol when creating a port for client connection.

Default: N

Option to use the IPv6 protocol when creating a port for inter-node communication in a multi-node environment.

Default: N

Option to use the IPv6 protocol when creating a port for connection to the extern server from Tmax system.

Default: Y

Option to use an interface of the IP address set in the NODE element when creating a port for client connection.

Default: N

Allows for users to modify svclog items. Specify a string such as "$(CLIENTIP) $(RESULT)".

Number of worker threads for encryption/decryption, authentication, and qualification when third-party security system is used for a CAS process. For more information about security settings, refer to Third-party Settings.

Can be up to 255 characters

Command options passed to a CAS process when the process starts if third-party security system is used for the process. For more information about security settings, refer to Third-party Settings.

Third-party authentication library path if the library is used instead of the default authentication library provided by Tmax. For more information about security settings, refer to Third-party Settings.

Third-party encryption library path if the library is used instead of the default encryption library provided by Tmax. For more information about security settings, refer to Third-party Settings.

Can be up to 255 characters

Command options sent to the a TmaxGrid process when the process starts. Options before '--' are used by Tmax system, and those that come after '--' can be used by general users.

The following are available user options.

Size: Up to 63 characters

Logical name of the server group. Must be unique in the SVRGROUP element.

This variable will be referred to from the SVGNAME item of the SERVER element.

Size: Up to 63 characters

Node where the server group exists. Must be a node that is defined in the NODE element. If the node name includes a hyphen (-), it must be enclosed in double quotation marks.

Refer to DEFAULT in "3.2.2 NODE".

Default: TMAX

Server group type. One of TMAX, RQMGR, EXTSVG, and TXRQMGR. The default value is TMAX. Refer to Tmax Programming Guide (MultipleRM) for detailed information about MTMAX and STMAX.

EXTSVG is same as EXTERN SERVER. It is selected when using the EXTERN TMS to support WAS(Web Application Server) and 2PC. When using EXTSVG, the OPENINFO item must also be configured. Even though its value is not significant, set the OPENINFO element to " ".

*NODE
tmaxh3         ...
               EXTPORT = 9000, EXTCLHPORT = 9010

*SVRGROUP
Extsvg         NODENAME = "tmaxh4",
               SVGTYPE = "EXTSVG", TMSNAME = TMSWAS
               OPENINFO = " "

*SERVER
alinkjmapp     SVGNAME = Extsvg1,
               MIN = 1, MAX = 1, CPC = 20,
               SVRTYPE = EXTSVR

*SERVICE
JMAPPER        SVRNAME = alinkjmapp,
               SVCTIME = 30

Size: Up to 8000 characters

Groups that can share a process or perform routing with. These sever groups can exist on a same node or on different nodes. Both COUSIN and BACKUP items can be configured, but they must be set to different server groups.

Size: Up to 8000 characters

Backup group name used to provide seamless services even in case of a failure.

LOAD = -1

If LOAD is Set to -1

LOAD = -2

If LOAD is Set to -2

LOAD = -3

LOAD = 0

LOAD > 0

If LOAD > 0

Size: Up to 63 characters

Unique DB name required if TMS is configured.

Size: Up to 255 characters

Used to connect the server group to the database through TMS. Initializes the DB connection and must be defined by using the syntax required by each DB. Do not use "@@" because the characters are recognized as an encrypted statement.

To encrypt some settings, use ***** (5 asterisks) in place of the setting. When using cfl, a password will be prompted for the encrypted parts.

Partial encryption

OPENINFO = "ORACLE_XA+Acc=P/scott/*****+SesTm=100"

Full encryption

OPENINFO = "*****"

Encrypted statement

Size: Up to 255 characters

Required if TMS, which is a group that integrates to the DB, is configured. Used to terminate the connection with the DB. Must be defined by using the syntax required by each DB. This item is not required by most DBs except for Informix.

Range: 1~16

Default: 2

Number of TMS processes that will be loaded in the server group when Tmax system starts up if TMS is configured.

Range:1~16

Default: 3

Maximum number of active TMS processes in the server group at any one time.

Size: Up to 63 characters

Name of the TMS process that will manage the database for the server group if TMS is configured.

Size: Up to 255 characters

Required to pass values using environment variables to servers that are part of the server group. It can also be used to connect to multiple homogeneous databases on the same node.

Only required for a limited number of DBMSs. For DBMSs like DB2 that only support dynamic registration, set it to 'Dynamic'.

If the DBMS is similar to Sybase or earlier versions of Informix and uses 'int' (not 'long') for the xaswitch field even though it has a 64-bit engine, set it to 'XASWITCH32'.

Range: 1 ~ 128

Number of channels with CLH processes. Used only when SVGTYPE is RQMGR. For details, refer to Reliable Queue Settings.

Default: Y

Option to reload TMS processes if they are abnormally terminated.

Options to configure Tmax fault tolerance feature. For details, refer to Fault Tolerance Settings.

Default: Y

Option to use transaction recovery.

Tmax 4 and later use the Transaction Recovery Function defined in X/OPEN DTP. When TMS is restarted, Tmax obtains an XID list of pending transactions from the RM and performs transaction recovery on the list. Transaction recovery function is supported in a single node or multi node environment, or a multi-domain system that uses Tmax Domain Gateways for communication.

Since recovery is performed when the entire group is started/terminated, recovery can be performed by each TMS group. A command option is added to tmboot/tmdown to start/terminate a specific TMS. For more details about the command, refer to Tmax Reference Guide.

Permissions to query the Pending list must be given to RM to use this feature.

When different server groups of a single node share a database, dependencies can be established to prevent recovery from executing while TMS is running.

svg1 TMSNAME = tms1,
     TMSDEP = "tms2, tms3"

svg2 TMSNAME = tms2,
     TMSRECOVERY = N

svg3 TMSNAME = tms3,
     TMSRECOVERY = N

Default: DOMAIN

When server groups on different nodes share a single database, TMSRANGE can be set to NODE so that recovery is performed separately for each node. This will reduce inter-node traffic and increase stability of the recovery function.

Default: STD

TMS type used.

Number of working threads per TMS process.

Location and name of the TMS log file. Its usage is the same as in TMMOPT and CLHOPT, but the -J option of CLOPT in the SERVER section is additionally supported.

Unit: seconds

XA processing that takes longer than TMSXATIME is logged.

If XA processing, such as xa_prepare, xa_commit, and xa_rollback, takes unusually long time in TMS, this may indicate a DB failure. Logging is provided for cause analysis of the failure in the future.

Log format:

CLH2160 XA function name(xid) processing was delayed (elapsed time) by tms(server group no.)
       : Return value of XA function
CLH2161 XA function name(xid) processing may be stopped due to closed tms(server group no.)

Default: N

Option to temporarily use a server group name as "__dummy".

If set to Y, TMS of the group is not started up when executing tmboot.

Can be useful when a dummy server group setting, such as Domain Gateway Cousin, is needed. For details, refer to Domain Gateway COUSIN Setting.

If not set, the following error occurs during tmboot.

(F) BOOT0014 exec error : /data1/tmaxkjh/tmax/appbin/tms_tbr [BOOT0029]: No such file or directory

Size: Up to 63 characters

Name of HMS process. To use HMS, SVGTYPE must be set to HMS. For more details about the HMS setting, refer to Tmax HMS User Guide.

Range: 0 ~ 65535

Unique value in the domain that is required for processing an HMS message.

Range: 0 ~ 65535

Number of threads that do not perform storage processing for HMS messages.

Range: 0 ~ 65535

Number of threads that perform storage processing for HMS messages.

Range: 1 ~ 65535

Number of threads that perform batch storage processing for HMS messages.

Range: 2 ~ 65535

Maximum number of HMS messages that can be simultaneously processed for batch storage processing.

Size: Up to 255 characters

Command options sent to an HMS process when the process starts.

Size: Up to 255 characters

Path and name of a configuration file where Durable Subscriber is defined.

The durable subscriber is automatically registered when HMS starts up.

Range: 0 ~ 65535 (unit: hours)

An interval to delete persistent messages that HMS accumulates in a storage.

Port number used by HMS to communicate with other HMSs in a cluster.

Range: 0 ~ 65535 (unit: seconds)

Heartbeat check interval. Clustered HMSs regularly exchange heartbeat messages to detect any network failure among them.

Range: 0 ~ 65535 (unit: milliseconds)

Interval for updating status information required for HMS queue clustering.

Must be set to use a clustered queue. Data is more evenly distributed in the queue if the interval is shorter, but network load is heavier. Set a value accordingly.

Can be up to 255 characters

Command options sent to an RQS process when the process starts.

Size: Up to 255 characters

Paths of the directories that contain the executable files for server application programs.

APPDIR of the NODE element sets the paths of all applications running on the node, and it can be redefined in the SVRGROUP to set application file paths for the server group.

Size: Up to 255 characters

Paths of the directories where user messages are logged. Can be redefined for each server group. The method of logging user messages is same as ULOGDIR of the NODE element.

Log level of TMS.

Log level of the server.

Allows for users to modify svclog items.

Size: Up to 63 characters

Server name and also the executable name of the server application program. Each server name must be unique and must be defined only once in the SERVER element of the configuration file. In multi-domain systems, a server name must be unique in each domain.

Size: Up to 63 characters

Server group that the server belongs to.

The server group must already be defined in the SVRGROUP element. By mapping a server to a server group, the node it runs on and the resource manager (database) that it uses are also known. It can also be used to acquire parameters necessary for opening the resource manager.

When operating in XA mode, Tmax manages all database transactions and oversees 2PC processing. To facilitate this, the OPENINFO field must be properly configured in the SVRGROUP element as previously described.

Refer to DEFAULT in "3.2.2 NODE".

Size: Up to 255 characters

Command options that are passed to the server processes when they start up. Options that are defined before "--" are used by the system, and options that are defined after "--" can be used by users.

Major system options include:

MACRO Commands1

MACRO Commands2

This MACRO is used to generate different types of log files (for example, by date).

CLOPT="-o $(SVR).$(DATE).out –e $(SVR).$(DATE).err"

Range: 1 ~ MAX_INT

Default: 1

Number of server processes that is created when Tmax starts up.

Unlike the conventional client/server model where one server process is loaded per client, Tmax manages and maintains a set number of active server processes. The CLH checks the status of server processes whenever a client issues a request and assigns the request to idle server processes to maximize system performance.

Since this value determines the default number of active server processes, it is important that the administrator sets MIN to a value appropriate for the system. If the number of server processes available for handling frequently requested services is too low, the wait time for processing the request will increase and system performance will decrease. On the other hand, if an excessive number of server processes are idle, system resources will be wasted and the performance of the system will decrease.

Range: 1 ~ MAX_INT

Default: 1

Maximum number of server processes that can be generated on the server.

Default: N

Option to use a conversational communication method.

There are three types of server communication methods in Tmax: synchronous, asynchronous and conversational. Services that use conversational communication must be registered with a server that is set to conversational communication. If set to a value other than "Y", the server can only facilitate synchronous or asynchronous communication.

If set to CONV=B, the server process becomes the scheduling process. B represents BOTH, which supports both conversational (Y) and non-conversational (N) types. It can also be used for inter-domain communication through the domain gateway.

Range: 1 ~ MAX_INT

Default: 0

Number of accumulated requests in the queue that automatically activates new server processes.

If the number of server processes exceeds the MIN value, the status of the server processes are monitored and those that have been idle a given period of time are terminated to reduce the count. This option is not applied to POD type server processes.

Range: 1 ~ MAX_INT

Default: -1

If not set, the default value is used and MAXQCOUNT is not used.

Maximum number of requests that can be queued before additional requests are rejected by the server.

If the number of requests exceeds the value set in MAXQCOUNT, incoming requests will not be placed in the queue and an error message (tperrno = 26) is sent immediately to the requesting client. MAXQCOUNT is useful for systems that process large volumes of service requests at peak times, such as banks and public offices.

Range: -1, 0 ~ MAX_INT

Default: -1

Dequeues expired messages. Can be set for each server. Too many messages can be queued because of host and network issues. In this case, this item can be used to notify the queue status for a client to handle the status.

The following are available values.

Default: STD

The following are the service types processed by the server.

Range: 1 ~ 128

Default: 1

Number of parallel communication channels between a UCS server and a CLH process. In situations where a single channel cannot handle the amount of requests, multiple communication channels can be used in parallel to increase processing speed.

Only applies to UCS, UCS_DYN, CUSTOM_GATEWAY, REALSVR, REALSVR_MT, STD_MT server types.

Required for STD_MT server type.

Range: 1 ~ 128

Default: 1 if CPC is not set or the CPC value if CPC is set

The number of parallel channels from CLH processes to UCS server processes.

Available only for UCS and UCS_DYN.

If not set, the number of channels from CLH to UCS is the same as that of channels from UCS to CLH. Setting this option can reduce waste of resources and does not directly affect performance.

Range: 0 ~ MAXTHR

Default: 0

Minimum number of service threads that are initially created when a STD_MT server process starts. Required for STD_MT server.

If set to 0, a service request from CLH is processed after a thread is created.

Range: 1 ~ 1000

Default: 1

Maximum number of service threads managed by a thread pool of the STD_MT server process. Required for STD_MT server.

Creating and adding threads whenever there is a service request can degrade performance. Create threads only up to the maximum number, which must be set after careful consideration.

A total of MAXTHR + 1 threads including the main thread can be running. The main thread does not handle service requests but manages service threads and requests. If the value is 1, it is recommended to use a general server library since only one service thread is created.

The MAXTHR item is related to the CPC and MAXCLH items. Refer to the 'CPC' item for detailed information.

Range: 0 ~ MAX_INT

Default: 0 (Unit: KB)

Stack size of the service threads in the STD_MT server process. If not set, the default size of the OS is used.

Default: Y

Option to reload the server if it is terminated abnormally.

Fault tolerance related options. For more information, refer to Fault Tolerance Settings.

A server name is a name of a server executable file, and TARGET is used to redefine a server process name. Server process refers to a process that executes the server executable file in APPDIR.

By setting TARGET as in the following, tmadmin can check for the actual server name and server process name by using ps.

/user1/starbj/tmax/sample/server> tmadmin
--- Welcome to Tmax Admin (Type "quit" to leave) ---
$$1 tmaxs1 (tmadm): st -p
CLH 0:
---------------------------------------------------
svr_name  svgname  spr_no  status  count  avg  svc
---------------------------------------------------
SVR      svrgrp     32     RDY      0   0 .00  -1

/user2/starbj/tmax/sample/server> ps
starbj 28702 1 0 11:13:03 pts/8 0:00 cll -b 28700
starbj 28704 1 0 11:13:03 pts/8 0:00 svr2
 -b 28700 -S SVR -s SVR -d -1
starbj 28701 1 0 11:13:03 pts/8 0:00 tmm -b 28700
starbj 28703 1 0 11:13:03 pts/8 0:00 clh -b 28700

Example configuration file for TARGET.

*SERVER
original        SVGNAME = svg0,
copied1         SVGNAME = svg0,
                TARGET  = "original",
                CLOPT   = "-e $(SVR).err -o $(SVR).out -x ORIGINAL:COPIED1"
copied2         SVGNAME = svg0,
                TARGET  = "original",
                CLOPT   = "-e $(SVR).err -o $(SVR).out -x ORIGINAL:COPIED2"
*SERVICE
ORIGINAL        SVRNAME = original
COPIED1         SVRNAME = copied1
COPIED2         SVRNAME = copied2

Default: N

If a service is dynamically added to Tmax system using 'mksvr' while it is running, by default this value is set to 'N'.

The AUTORAN setting in the SERVER element will automatically load the transactions for services that have been added dynamically. This affects the setting of dynamically added service. For more information, refer to AUTOTRAN in "3.2.3. SERVICE".

If AUTORAN is defined in both the SERVICE and SERVER elements, the SERVICE element setting is used.

Option B is used for compatibility with AUTOTRAN in old versions (~3.8.8). It works in the same way as Y, except that the transaction operates as a local transaction instead of a global transaction.

Default: FA

Processing order of transactions among server processes when the MIN value of the server is greater than 2.

Setting SCHEDULE

Default: IDLE_DOWN

Lifespan of the following additional server processes (more than MIN value).

Server processes started by POD (when MIN=0)

Server processes started through ASQCOUNT:

Default: N

Temporarily uses "__dummy" as the server name.

If DUMMY is set to Y in the SERVER element, the server process is not started during tmboot.

This item is useful when a dummy server setting, such as Domain Gateway Cousin, is required. For more details, refer to Domain Gateway COUSIN Setting.

If not set, the following error occurs during tmboot.

(F) BOOT0014 exec error : /data1/tmaxkjh/tmax/appbin/tbrtest [BOOT0029]: No such file or directory

Default: N

Allow Unregistered Services

When a server is started after a service has been deleted from the configuration but not from the application (not rebuilt), the server is restarted as many times as MAXRSTART.

If set to AUS=Y in the SERVER element, the server is started ignoring this setting.

Default: Y

Only used for a UCS server. Other server types cannot use this option.

If a server process is terminated by tmdown -s, tmdown -s -i, or abnormal shutdown before tprelay() is called and after the UCS server calls tpsavectx() and saves the client information, the caller does not receive a response for the request. If set to 'Y', when the server process is being terminated an error message is sent to the client for requests that have not been handled by tprelay().

If the CTX_EREPLY option is set to default, when the server process is being terminated an error response is sent to the caller for requests that are being processed. This way, other processes on the server are not affected. This setting operates normally when the client information (CTX_T) created by tpsavectx() call is only managed internally in the server process.

Default: Y

If set to Y, a server process can concurrently receive requests from multiple CLHs when MINCLH >= 2. A server process handles concurrent service requests on a first-come-first-served basis. After the process completes the current request with the tpreturn call, it processes a request from another CLH.

If set to N, each server process can receive and handle service requests from a CLH. This prevents multiple CLHs from simultaneously requesting services to one server process. Each server process receives requests from an assigned CLH even though overload occurs on other CLHs which is inefficient in terms of performance.

Precautions if set to N

Default: Y

Option to use tmapm for each service.

As a user function, it is recommended not to use tmapm when using a user defined function (tpsetsvctimeout()) to readjust the timeout value.

Default: N

MAC(Master Alive Check) is used to terminate a server when TMM is terminated to prevent it from becoming a zombie process.

If set to MAC=Y, the server is terminated when TMM is terminated abnormally.

Default: N

ROC(Reconnect Outbound CPC) is used to reconnect to CPC when a server is disconnected from CLH.

If set to ROC=Y, reconnection is attempted when CLH is alive and the socket is disconnected.

Default: 0

Number of times that the server calls a service before restarting the server.

If this setting triggers a server restart, TMM outputs "sever closed due to MAX_USE_COUNT or MEM_USAGE(CLOPT:-m)."

Log level of the server.

Path name of the directory where user messages are stored.

Users like Tmax application programmers can easily log messages for debugging and error and warning messages by using the userlog() function. The messages that are outputted by the userlog() function are stored in the ULOGDIR directory. Files called 'ulog_date' are created in the directory, and the messages are logged by date in each file.

Allows for users to modify svclog items.

Size: Up to 63 characters

Function name (service routine name) of the service. The name must be unique within the SERVICE element. In a multi-domain environment, the Service Name must be unique across all domains in the system.

Size: Up to 63 characters

Name of the server that processes the service.

Use the executable file name of the server program that contains the service routine. The server must be defined in the SERVER element. If the server name includes any special characters, this must be wrapped in double quotes as in "Server Process Name". If multiple services are provided by a single server process, the same server process name can appear in the SERVICE element multiple times.

Refer to DEFAULT in "3.2.2 NODE".

File name of the module when the service name is different from the module name.

Range: 1 ~ 100

Default: 50

Priority level of the service. A service with a higher number is given higher priority. For example, a service with a PRIO value of 100 has the highest priority.

Data routing setting. For more information, refer to Load Balancing Settings.

Range: 1 ~ MAX_INT

Default: 0

Fractional numbers can be set.

If not set, services wait indefinitely (default value).

Max time allowed for service processing. The service processing must be finished within this time period.

If service times out while using a database session, the next service cannot be processed since the session cannot be forced to disconnect from the database. Tmax resolves such problem in the following way. If service timeout occurs, a user can restart the server by using TPRETURN(TPEXIT, …​) in the tpsvctimeout routine which causes the MAXRSTART count in the SERVER element to be incremented.

Default: Y

Option to process service requests from another domain in a multi domain environment.

If EXPORT is set to N and a request is sent from another domain via a gateway, a TPESECURITY error occurs.

Default: N

Option to automatically launch a global transaction for a service request that is received while in non-transaction mode.

It is different from AUTOTRAN in versions earlier than Tmax 3.8.8.

The following is an example of the configuration file and the tmadmin tool:

*SVRGROUP
svg2            NODENAME = "tmax1"

### tms for Oracle ###
svg3            NODENAME = "tmax1",    DBNAME = ORACLE,
                OPENINFO = "Oracle_XA+Acc=P/scott/tiger+SesTm=60",
                TMSNAME  = tms_ora

*SERVER
svr2            SVGNAME = svg2
### servers for Oracle sample program###
fdltest         SVGNAME = svg3

*SERVICE
### services for fdltest ###
FDLINS          SVRNAME = fdltest
FDLSEL          SVRNAME = fdltest
FDLUPT          SVRNAME = fdltest
FDLDEL          SVRNAME = fdltest
TOUPPER         SVRNAME = svr2

tmax@tmax1;/user/tmax/tmax/config>tmadmin
--- Welcome to Tmax Admin (Type "quit" to leave) ---

$$1 tmax1 (tmadm): cfg -s
   -------------------------------------------------
   svc_name    prio(pr)  autotran  svctime(st)  routno  svrname      svgno
   -------------------------------------------------
FDLINS          50      YES         0           -1      fdltest         2
FDLUPT          50      YES         0           -1      fdltest         2
FDLSEL          50      YES         0           -1      fdltest         2
FDLDEL          50      YES         0           -1      fdltest         2
TOUPPER         50       NO         0           -1        svr2          0

$$2 tmax1 (tmadm): q
ADM quit for node (tmax1)

Range: 1 ~ MAX_INT

Default: 0

For more information, refer to TXTIME in "3.2.1 DOMAIN".

Size: Up to 63 characters

Logical name of the gateway. Must be unique within the GATEWAY element.

Size: Up to 255 characters

Name of the node where the gateway process runs on.

Node name must already be defined in the NODE element.

'listen' port number used by local gateway processes. Enables a remote gateway process to connect to a local gateway process. The port number must be configured in the RGWPORTNO item. Port numbers less than 1024 must not be used since they are reserved for system use.

Since port numbers are essential for communication between gateways, make sure not to use the port numbers that are used by other system functions.

Size: Up to 255 characters

Name or IP address of the node where the remote gateway process, to which the local gateway wants to connect, is running on.

If using the node name, it must be registered in the "/etc/hosts" file. The local gateway processes use both the IP address in RGWADDR and the port number in RGWPORTNO to connect to a remote gateway.

Port number through which the local gateway process connects to a remote gateway process.

This number is a listen port number of a remote gateway process. Port numbers less than 1024 must not be used since they are reserved for system use.

Type of the remote gateway to which the local gateway process is to connect.

The following values are available.

Refer to DEFAULT in "3.2.2 NODE".

Range: 1 ~ 128

Default: 32

Number of channels that can be used concurrently in the gateway.

This is only used when TMAXNONTX is configured in GWTYPE. If not set, the gateway will only connect to and receive service requests from up to 32 domains.

Default: "IPV4"

Protocol used when a local gateway listens. If multiple protocols can be used, they are set by using a comma (,) as a delimiter.

Default: "IPV4"

Protocol used when a local gateway connects to a remote gateway. If multiple protocols can be used, they are set by using a comma (,) as a delimiter.

Default: N

Option to use the IPv6 protocol when local gateway listens.

Default: N

Option to use the IPv6 protocol when a local gateway uses IPV6 to connect to a remote gateway.

Range: 1 ~ 128

Default: 1

Number of parallel communication channels between CLH process of both domains when using the gateway.

In situations where high volumes of data need to be passed through the gateway process, parallel communication using multiple channels can speed up the processing. For gateways set as TMAXNONTX, it is sufficient to set CPC to 2 or 3.

Range: 1 ~ MAX_INT

Default: 0

If not set, services wait indefinitely (default value).

Max time allowed for inter-domain tpcall / tpacall.

Size: Up to 8000 characters

Names of related gateways when a service needs to be distributed through multiple gateways (load balancing). Can use the names of gateways on the same node or different nodes. Both COUSIN and BACKUP items can be configured, but they must be set to different gateways.

The gateways set in COUSIN are in charge of routing, and the gateways set in BACKUP handle failures.

Can only use the gateway names registered in the GATEWAY element. Server groups cannot be used.

The following is an example of the environment file.

*SERVICE
GWSVC1       SVRNAME = gw1
GWSVC2       SVRNAME = gw1
GWSVC3       SVRNAME = gw1

*GATEWAY
gw1         NODENAME = node1, GWTYPE = TMAXNONTX, PORTNO = 10001,
            RGWADDR = "192.168.1.1",   RGWPORTNO = 10002,
            LOAD = 1, CPC = 5, CLOPT = "-i",
            COUSIN = "gw1"

gw2         NODENAME = node2, GWTYPE = TMAXNONTX, PORTNO = 10001,
            RGWADDR = "192.168.1.2",   RGWPORTNO = 10002,
            LOAD = 1, CPC = 5, CLOPT = "-i"

Refer to LOAD in "3.2.3. SVRGROUP".

Size: Up to 7999 characters

Name of the backup gateway to be used in the event of main gateway failure. It must be a gateway set in the GATEWAY element of the Tmax configuration file.

Size: Up to 255 characters

IP address or node name of the backup remote gateway.

If using a node name, it must also be defined in the /etc/hosts file.

Port number of the backup remote gateway.

Used for listening. Port numbers less than 1024 must not be used since they are reserved for system use.

BACKUP, BACKUP_RGWADDR, and BACKUP_RGWPORTNO settings are all used for fault tolerance purposes.

Default: "IPV4"

Protocol used when a local gateway connects to a backup remote gateway. If multiple protocols can be used, they are set by using a comma (,) as a delimiter. The remote gateway’s address must be set in BACKUP_RGWADDR and its port number must be set in BACKUP_RGWPORTNO.

Default: N

Option to use the IPv6 protocol when local gateway connects to a backup remote gateway.

Used when connecting to a remote gateway whose address is BACKUP_RGWADDR and the port is BACKUP_RGWPORTNO.

Size: Up to 255 characters

Used only for Tuxedo gateways (GWTYPE = TUXEDO | TUXEDO_ASYNC). Up to three backup Tuxedo gateways can be assigned by using BACKUP_RGWADDR2-BACKUP_RGWPORTNO2 and BACKUP_RGWPORT3-BACKUP_RGWPORTNO3.

Default: "IPV4"

Used only for Tuxedo gateway (GWTYPE = TUXEDO | TUXEDO_ASYNC). Determines the protocol used when connecting to the second or third backup remote gateway. If multiple protocols can be used, they are set by using a comma (,) as a delimiter. The second remote gateway’s address must be set in BACKUP_RGWADDR2 and its port number must be set in BACKUP_RGWPORTNO2, and the third remote gateway’s address must be set in BACKUP_RGWADDR3 and its port number must be set in BACKUP_RGWPORTNO3.

Default: N

Option to use the IPv6 protocol to connect to second or third backup remote gateway. Used only for Tuxedo gateways (GWTYPE = TUXEDO | TUXEDO_ASYNC)

Used when connecting to a remote gateway whose address and port number are BACKUP_RGWADDR2 and BACKUP_RGWPORTNO2 or BACKUP_RGWADDR3 and BACKUP_RGWPORTNO3 respectively.

Default: BIDIR

Only used when GWTYPE is set to TMAX or TMAXNONTX.

Options are:

Size: Up to 255 characters

Gateway command options that can be sent to the gateway when it starts up. Options preceding '--' are used by the system, and options following '--' can be used by the users.

Common user options are:

Considerations

Default: Y

Option to restart the gateway if it is terminated abnormally.

These two items are used to configure fault tolerance. Refer to Fault Tolerance Settings.

Range: 1 ~ MAX_INT/2

Default: -1

Maximum time that GW keeps the pending list. The maximum time must be less than or equal to the value of TIMEOUT divided by 2. (TIMEOUT >=PTIMEOUT)

Retransmit the pending transaction (prepare-done/commit/rollback) from the Domain Gateway to prevent any pending transactions even when a decision has not been received.

Range: 1 ~ MAX_INT/2

Default: -1

Specify the time interval for GW to retransmit a pending transaction (prepare-done, commit, rollback).

Maximum time must be less than or equal to the value of PTIMEOUT.

Range: -1 ~ MAX_INT

Default: -1

Interval for making a re-connect attempt to the main sever for failback while the gateway is connected to a backup.

Range: -1 ~ MAX_INT

Default: -1

Maximum waiting time for GW to connect to a remote gateway.

Range: -1 ~ MAX_INT

Default: -1

Interval for sending a message to check if the channel that connects a gateway to a remote gateway is available.

For details, refer to TRB in "3.2.2 NODE".

Size: Up to 63 characters

Name of the database to be used by the server group. Use standard DBMS names, such as ORACLE, INFORMIX, and SYBASE.

Size: Up to 255 characters

Database information related to server group.

If using the same resource manager (a database), using one server group for management can raise resource efficiency and enable distributed transaction processing. The OPENINFO syntax for this item will vary depending on the resource manager vendor (such as Oracle and Informix). If you are unsure of what to enter, refer to the relevant database manual.

Size: Up to 255 characters

Default: NULL

Must include information required by the resource manager to close the database of the server group.

This item is usually omitted or set to NULL. Informix database requires that CLOSEINFO be set to a null character and it may be omitted for Oracle databases.

*SVRGROUP
svg1           NODENAME = tmax1,
               DBNAME = ORACLE,
               OPENINFO = "Oracle_XA+Acc = P/scott/tiger+SesTm= 60"

*SVRGROUP
svg2           NODENAME = tmax2,
               DBNAME = INFORMIX,
               OPENINFO = "test",
               CLOSEINFO = ''''

Size: Up to 63 characters

Name of the TMS that will manage database transactions for the server group.

If OPENINFO for the database has been configured, the TMSNAME setting must also be set. The TMS process is required for managing the database of the server group from the systems that use the database. In order for Tmax to manage a database, the database open/close information must be configured, and TMSNAME must be defined for each server group to start the TMS process. The TMS process is a transaction manager that processes transactions through XA linked to the database. It is created by linking the libtms.a file in the $TMAXDIR/lib directory to the database library of the DBNAME defined in the SVRGROUP element.

Range: 1 ~ 32

Default: 2

Number of TMS processes that can be started for the server group. This setting will influence transaction processing management more than database management. The default value is two TMS processes per server group, which is enough for only database management.

Range: 1 ~ 32

Default: 3

Number of additional TMS processes that can be loaded dynamically as needed. For more information, refer to Distributed Transaction Settings.

Default: Y

Setting for the two-phase commit (2PC) for transaction processing. 2PC transactions consist of two phases, preparation and commit/rollback. Tmax supports 2PC for distributed transaction implementation.

CMTRET determines whether to do a complete return.

Range: 0 ~ MAX_INT

Default: 0

Timeout value for processing transactions, starting from when a transaction begins with tx_begin() to when the transaction ends with tx_commit() or tx_rollback(). If tx_commit() or tx_rollback() is not complete when the timeout expires, the transaction will be automatically rolled back.

Size: Up to 255 characters

Default: TMAXDIR

To handle a mid-transaction failure, all distributed transactions are logged. TLOGDIR is used to specify the file where transaction information will be stored.

Name of the database used by the server group.

Information required for opening the database.

Default: NULL

Information required for closing the database.

Name of the TMS process.

Minimum number of TMS processes for the server group.

This item is not important in terms of database management. However, it is very important in transaction processing. If there are too few TMS processes (one or two) when the transaction workload is high, commit/rollback procedures will generate a large resource overhead. Thus it is important to specify an appropriate number of TMSs to effectively manage resources and throughput.

Fault tolerance setting. For details, refer to Fault Tolerance Settings.

Within the SVRGROUP element, this setting refers to the MAXRSTART of a TMS or RQ.

Maximum number of additional TMS processes that can be loaded within the server group. As the transaction workload increases, additional TMS processes can be loaded up to MAXTMS.

Size: Up to 255 characters

This is an item that specifies the name of server group when the Load Balancing function is used on 2 or more nodes.

Name of each server group must be registered in the SVRGROUP element. The Load Balancing function of Tmax system is processed in server group units. But when Load Balancing is processed across multiple nodes, each node name must be specified differently in each server group. The node name must already be configured in the NODE element of configuration file. When defining multiple server groups, separate them by using a comma(,). The required server program must exist in the APPDIR of each node. To use performance-based load balancing, a load value must be set for each server group.

Range: -1 ~ MAX_INT

Default: 1

Represents the server group’s service performance level. A higher value represents higher performance level.

Set to a high value for a high-performing node and a low value for a low-performing node.

Size: Up to 255 characters

DDR can only be used when multiple server groups provide the same service. Hence, the original SVRGROUP needs to be copied to a different node according to the COUSIN setting. For more information, refer to the description of COUSIN in SVRGROUP.

Size: Up to 63 characters

Logical routing name.

This must be unique within the SERVICE element, and will be used in the ROUTING element, which needs to be defined for a service to use DDR (this is explained next). Additionally, the typed buffer name, and field used for routing and its value range must be set with the server group name.

Size: Up to 63 characters

Routing name defined in ROUTING item of the SERVICE element. Because DDR is implemented for each service, the ROUTING name must match the one defined in the SERVICE element.

Size: Up to 2000 characters

This item is configured according to the field data type (STRUCT, FIELD, STRING, or CARRAY type) of the services that use data dependent routing.

The following is the configuration syntax for each of the four data types.

Starting position of the input data that will be used for DDR.

Offset and length must only be used for the range type DDR and not for the matching type because the offset and length items specify only the input data and are not related to the data specified in RANGES.

ROUTE_1   FIELD = "STRING/0/4",
          RANGES = "aaaaaaa":SVG1, *:SVG2

Offset and length are available when using the range type DDR.

ROUTE_1    FIELD = "STRING/0/4",
           RANGES = "aaaaaaa"-"ccccccc":SVG1, *:SVG2

As explained already, offset specifies the starting point of the element within the input data used for DDR criteria, and length specifies the length of element from the offset. Length must be used in conjunction with offset.

If length is not specified, Tmax will use the input data from offset until NULL, or the end of the data.

Size: Up to 2047 characters

Destination of client service requests based on the value of the field specified in FIELD.

Values specified must conform to the following.

When not using the MATCH option

*ROUTING
rout1    FIELD = "STRING, CARRAY, FIELD/INPUT,
         STRUCT/test/a",
         RANGES = "min-'100':svg1,'101'-'200':svg1_2,min-'100':svg1_3,*:svg1_4"

When using MATCH

*ROUTING
rout1    FIELD = "STRING, CARRAY, FIELD/INPUT,
         STRUCT/test/a",
         RANGES ="min-'100':svg1,'101'-'200':svg1_2, min-'100':svg1_3,*:svg1_4" ,
         MATCH=MULTIPLE

Size: Less than 16 characters

Server group name. Must be unique in the SVRGROUP section.

Node name where a server group belongs to. The node name must be the same as the one defined in the NODE section.

Range: 4~128

If the RQ item, which sets the number of parallel communication channels between the RQS process and the CLH process, is not used, then this will be ignored. If RQ is used frequently, its process speed can be improved by maintaining multiple channels.

Server group type.

RQ operates like a POD server. Set this item to "POD" to process tpenq requests.

Can be up to 14 characters.

Logical name of the RQ section. Multiple RQs can be defined in the RQ section. Each RQ name must be unique. In a single server group, multiple RQs can be defined.

Server group name that uses RQ.

The server group name must be defined in the SVRGROUP section.

Default value: COLD

The BOOT field adjusts the data stored in RQ when the Tmax system reboots.

The following describes configurable values:

Range: 1~2047 MB

Default: 16 MB

RQ size can be specified. RQ is created in the TMAXDIR path by default. If the queue entries exceed the specified queue size as a result of continuous services, TPEQFULL will occur when performing tpenq(). The RQ size will not be increased automatically so the size must be set properly. If RQ data will not be stored even after a RQ file is written, the file will be deleted automatically when Tmax is terminated.

Default: Y

Option to cache the RQ file content to memory.

The following describes a configurable value;

Default value: Y

Even BUFFERING is set to 'N', OS does not store data to a disk directly but stores the data in a memory at most 30 seconds. This field eliminates such waiting time and stores the data in a memory to a disk.

The following describes configurable values:

Default value: $(TMAXDIR)/path/RQ name.data

Path to the file used by RQ. This field creates the RQ data files and must be defined with the entire file name and the directory name.

Default: 1024

Maximum number of messages to save in memory when RQ stores data in memory and does not write the data to a file (TPRQS_NON_PERSISTENT).

Range : 1 ~ 65535

Default value: 1024

Maximum number of sessions that can be created in HMS within the domain.

Range: 1 ~ 65535

Default value: 1024

Maximum number of sessions that can be created in HMS within the node.

Can be up to 63 characters.

Logical name of the server group. Must be unique in the SVRGROUP element.

Can be up to 63 characters.

Node where the server group exists. Must be a node that is defined in the NODE element.

Server group type. To use HMS, this must be set to HMS.

Can be up to 63 characters.

Name of a user-built HMS process.

By default, HMS uses a database for storage. Specify OPENINFO of the DBMS to which HMS will connect.

Initialize the database connection, and define OPENINFO using the syntax required by the database.

Range: 0 ~ 65535

Used for processing an HMS message. Must be unique within the domain.

Range: 0 ~ 65535

Number of threads that will not be used for storage processing.

Must be set to a large value when sending and receiving only nonpersistent messages. For basic use of HMS, this item must be set above a certain value.

Range: 0 ~ 65535

Number of threads used for storage processing.

Must be set to a large value when there are many persistent messages. For basic use of HMS, this item must be set above a certain value.

Range: 1 ~ 65535

Number of threads that perform batch storage processing for HMS messages.

Range: 2 ~ 65535

Maximum number of HMS messages that can be simultaneously processed for batch storage processing.

Can be up to 255 characters.

Command options transmitted to an HMS process when HMS starts up.

Can be up to 255 characters.

Path and name of a configuration file where Durable Subscriber is defined. In the file, each label is set with [TopicName] and ClientName:Listener:Selector is specified.

The durable subscriber is automatically registered when HMS starts up.

Range: 0 ~ 65535 (Unit: hours)

An interval to delete persistent messages that HMS accumulates in a storage.

Topic messages that all subscribers receive and queue messages that are consumed are deleted from the storage if they are expired. Messages that are not sent to all receivers are not deleted even if they are expired.

Port number used by HMS to communicate with other HMSs in a cluster.

Do not use a port number that is already used because HMS listens by using the port if there is a destination with the GLOBAL property.

Range: 0 ~ 65535 (Unit: seconds)

Heartbeat check interval. Clustered HMSs regularly exchange heartbeat messages to detect any network failure among them.

If an HMS does not send a heartbeat message within the interval, the connection to the HMS is ended.

Range: 0 ~ 65535 (Unit: milliseconds)

An interval to send and receive status information between queues with the GLOBAL property.

Must be set to use a clustered queue. Data is more evenly distributed in the queue if the interval is shorter, but network load is heavier. Set a value accordingly.

Can be up to 63 characters.

Destination name. A producer and consumer are created using this name.

Can be up to 63 characters.

HMS server group name of the destination.

The SVGNAME must be an HMS server group name specified in the SVRGROUP element.

Destination type. Currently, only TOPIC and QUEUE are supported.

Default value: COLD

How to treat service requests stored in the RQ after a reboot.

Like in RQ, set either to WARM or COLD.

Default value: N

Option to use destinations with the same name in clustered HMSs logically as a single destination.

For GLOBAL setting, HMSPORT must be set in HMS of the SVRGROUP element.

For GLOBAL queue setting, the GQTHR, GQMAXREQ, and GQFULL items are also required.

Range: 0 ~ 65535

Coefficient to determine the buffer size maintained by a clustered queue.

Buffer size = (the number of consumers) X (GQTHR value)

If the length of the current queue is shorter than the buffer size, the queue takes messages from another clustered queue. If the queue contains less messages than the buffer size, it does not distribute its messages upon a distribution request.

Range: 1 ~ 65535

Number of messages that can be requested at once to another queue. If the specified value is large, the queue will be filled with messages very quickly. If the value is too large, there may be unnecessary message transmissions between nodes. Thus, an appropriate value must be set.

Range: 0 ~ 65535

Number of messages that can be accumulated in a queue. If more than the specified number of messages is accumulated in a queue, any subsequent messages are evenly distributed to the clustered queues on another node.

Size: Up to 255 characters

Backup server group.

Multiple backup server groups can be specified by using a comma (,) as a separator. If the original server group fails, the first specified backup will be activated, and if this backup server group also fails, the next server group will be activated, and so on.

All of the specified backup server groups must be registered within the SVGROUP element. The backup server groups must be configured to comply with the settings of the original server group. To change the configuration options, relevant items can be redefined for each server group or server. However, service settings must be the same for the original and backup server groups. These rules are the same as those for duplicate server groups created for load balancing.

Default: Y

Option to restart CLH, CAS, CLL, and TLM upon abnormal termination.

If set to Y, the server processes will be restarted when they shut down unexpectedly due to a system failure.

Range: -1 ~ MAX_INT

Default: -1

Maximum number of times a CHL or CAS process can be restarted.

MAXRSTART is used in combination with the RESTART and GPERIOD items. If RESTART is set to 'Y', a process will be restarted MAXRSTART times during the GPERIOD. If set to 'N', Tmax will ignore this setting. If set to '-1', there will be no limit to the number of times that a process can be restarted.

Range: 1 ~ MAX_INT

Default: 86400 (24 hours) (Unit: second)

Time period for which MAXRSTART is valid.

If a server process is unexpectedly terminated, it will be restarted MAXRSTART times during the GPERIOD. Once the GPERIOD expires, this procedure will be repeated.

If the SVGTYPE is RQMGR, these items configure the restart setting of the RQ. If the SVGTYPE is XA svg, they configure the restart setting of the TMS.

If a server process is abnormally terminated, the process automatically restarts to provide services.

For more information of each item, refer to the previous "3.8.2. NODE" section.

These items configure the restart setting of the server processes. If a gateway process is abnormally terminated, the process automatically restarts to provide services.

The default value of MAXRSTART is 5.

For more information of each item, refer to the previous "3.8.2. NODE" section.

These items configure the restart setting of the gateway.

If the gateway process is abnormally terminated, the process automatically restarts to provide services.

For more information of each item, refer to the previous "3.8.2. NODE" section.

Default: "NO_SECURITY"

The following are available values.

Size: Up to 63 characters

Password for the dompwd of TPSTART_T. This password will be used to log into the Tmax system. If no password or an invalid one is provided, users will not be able to access the Tmax system. The user and password defined here can be created with the mkpw utility.

For DOMAIN_SEC, if the specified password is different from the dompwd value of the TPSTART_T structure in tpstart(), the client program cannot make a service request. The tperrno is set to TPESECURITY(25). For USER_AUTH, the usrpwd and usrname fields in the TPSTART_T struct must be the same as the account and password registered in the password file created with the mkpw utility.

Since level 2 (user authentication) security includes level 1 (system access control), the specified dompwd must be the same as the set domain password.

To use authentication-related functions, set TMAX_SEMANTICS="AUTH_SW:Y" in a client environment variable.

IPv4

192.168.1.43
192.168.1.48

IPv6

fe80::213:77ff:fe4d:c57d
fe80::213:77ff:fe4d:c570

IPv4

192.168.1.35
192.168.1.45

IPv6

fe80::213:77ff:fe4d:c50d
fe80::213:77ff:fe4d:c500

Search the tmax.allow file first, and if there are clients that are in the ACL, allow them to access the system.

Search the tmax.deny file, and if there are clients that are in the ACL, deny them from accessing the system. If they attempt to access the system (TPSTART), the TPECLOSE error occurs.

Allow access to clients who exist in neither tmax.allow nor tmax.deny files.

If the first character is '#', it is processed as a comment.

Allow only IP or NETWORK/NETMASK type.

(IPv4)(IP_V4)192.168.1.1 or 192.168.1.0/24,
(IPv6)fe80::213:77ff:fe4d:c57d or fe80::213:77ff:fe4d:c57d/64

One ACCESS CONTROL LIST is allowed per line, and a blank or tab character is not allowed.

ALL is a reserved word meaning all IPs.

To use a third-party authentication system, set this item to "OTHER_AUTH", and set SECURITY_LIB in the NODE section.

To use a third-party encryption system, set this item to Y, and set CRYPT_LIB in the NODE section.

To use a third-party authentication system, set this item to the library path and file name. Unless SECURITY is set to "OTHER_AUTH" in the DOMAIN section, compiling the configuration file by using the cfl command fails.

To use a third-party encryption system, set this items to the library path and file name. Unless CRYPT is set to Y in the DOMAIN section, compiling the configuration file by using the cfl command fails.