CLOPT Options for Gateway

This appendix describes CLOPT options for Tmax domain gateway, Java gateway, and Tuxedo gateway.

1. Tmax

This section describes the CLOPT options for Tmax domain gateway.

1.1. Transaction Domain Gateway

CLOPT options for gateways whose GWTYPE is "TMAX".

Option Description

[-r]

Same as the -r option for CLOPT in GATEWAY element.

[-h]

Same as the -h option for CLOPT in GATEWAY element.

[-i]

If not set, an attempt will be made to connect to a remote gateway for requests that are received while disconnected. If set, connecting to a remote gateway is attempted at the interval specified in NLIVEINQ. If not connected to a remote gateway, a TPNOREADY message is sent to the client.

[-R DECISION]

Used when the remote gateway version is Tmax 3.x. Gateway determines whether to roll back or commit a transaction that was started from a remote gateway but is pending at the local gateway.

  • RBK: Rollback.

  • COM: Commit.

  • IGN: Do nothing.

[-c TIME]

Attempts to reconnect to CLH at the interval specified in TIME.

[-p configuration file path]

Same as the -p option for CLOPT in GATEWAY element.

[-l ip-addr,ip-addr2,..]

L4 periodically sends pings to the gateway for alive checks and forcefully terminates connections if needed.

Each time a connection is terminated, the gateway logs the event, which can result in unnecessary log accumulation. When using this option, such connections must be distinguished for ping checks to prevent generating redundant logs.

[-m]

Similar with the MAC=Y setting in the SERVER element, shuts down tmgw(nt) when tmm is terminated.

[-k]

Same as the -k option for CLOPT in GATEWAY element.

[-x]

Suppresses printing of the GATEWAY0046, GATEWAY0064, GATEWAY0098 messages in the slog, which are generated while attempting to connect to an invalid remote address.

1.2. Non Transaction Domain Gateway

CLOPT options for gateway whose GWTYPE is "TMAXNONTX".

Option Description

[-h]

Same as the -h option for CLOPT in GATEWAY element.

[-i]

If not set, an attempt will be made to connect to a remote gateway for requests that are received while disconnected. If set, connecting to a remote gateway is attempted at the interval specified in NLIVEINQ. If not connected to a remote gateway, a TPNOREADY message is sent to the client.

[-c TIME]

Attempts to reconnect to CLH at the interval specified in TIME.

[-n]

The number of channels between Tmax gateways is fixed to 2.

When message 1 is sent to channel 1, and then message 2 is sent to channel 2 through GW1, message 2 may arrive first and be processed before message 1 at GW2.

To prevent this, set the number of channels to one by adding [-n] option to CLOPT of the GATEWAY section in the configuration file. [-n] does not have any arguments.

[-p configuration file path]

Same as the -p option for CLOPT in GATEWAY element.

[-l ip-addr,ip-addr2...]

Same as the -l option for the Tmax transaction domain gateway.

[-m]

Similar with the MAC=Y setting in the SERVER element, shuts down tmgw(nt) when tmm is terminated.

[-k]

Same as the -k option for CLOPT in GATEWAY element.

[-x]

Suppresses printing of the GATEWAY0046, GATEWAY0064, GATEWAY0098 messages in the slog, which are generated while attempting to connect to an invalid remote address.

2. Java

This section describes CLOPT options for Java gateway.

2.1. JEUS Gateway

CLOPT options for gateway whose GWTYPE is "JEUS".

Option Description

[-D DEBUG_LEVEL]

Debugging level.

  • 1 : Outputs logs related to request and response.

  • 2 : Outputs XA related logs.

  • 4 : Outputs message DUMP related logs.

A pipe(|) operator can be used to determine the log to output.

It can be dynamically changed using the setopt command of tmadmin at runtime.

[-e LOGFILE_PATH]

Log file path to store standard errors.

[-o LOGFILE_PATH]

Log file path to store standard outputs.

[-r]

Option for recovery. This option must always be set when using XA.

If not set, XA requests are treated as NONXA, which may cause errors.

It is not required when using NONXA.

[-A second]

Interval for alive checks, in seconds. This option replaces the existing NLIVEINQ setting configured in the GATEWAY or DOMAIN element.

If no response is received from an external system during the alive check period and within the specified time, the connection is terminated.

  • Response waiting time: MIN (30, gwchkint, blocktime, (nliveinq or -A option value))

No alive checks are performed for IN-CHANEL connections.

[-h VERSION]

  • When using the default value for the header setting in WebT 3.x and WebT 5.x versions, set 1.

  • When using extendedV4 for the header setting in WebT 5.x, set 4.

[-t]

This option is required when multiple domains are connected to a single JTmax instance.

If not set in such an environment, recovery may fail or behave incorrectly.

[-H]

If set, no alive check message is printed in the log.

[-x]

Suppresses printing of the GATEWAY0046, GATEWAY0064, GATEWAY0098 messages in the slog, which are generated while attempting to connect to an invalid remote address.

2.2. JEUS Async Gateway

CLOPT options for gateway whose GWTYPE is "JEUS_ASYNC".

Option Description

[-D DEBUG_LEVEL]

Debugging level.

  • 1: Outputs logs related to request and response.

  • 2: Outputs XA related logs.

  • 4: Outputs message DUMP related logs.

  • 7: Outputs all the message logs that 1,2, and 4 output.

A pipe(|) operator can be used to determine the log to output.

It can be dynamically changed using the setopt command of tmadmin at runtime.

[-e LOGFILE_PATH]

Log file path to store standard errors.

[-o LOGFILE_PATH]

Log file path to store standard outputs.

[-r]

Option for recovery. This option must always be set when using XA.

If not set, XA requests are treated as NONXA, which may cause errors.

It is not required when using NONXA.

[-h 4]

Must always be set to 4.

[-A second]

Interval for alive checks, in seconds. This option replaces the existing NLIVEINQ setting configured in the GATEWAY or DOMAIN element.

If no response is received from an external system during the alive check period and within the specified time, the connection is terminated.

  • Response waiting time: MIN (30, gwchkint, blocktime, (nliveinq or -A option value))

No alive checks are performed for IN-CHANEL connections.

[-a FILE_PATH]

Makes a connection using RGWADDR, RGWPORTNO, and "IP:PORT" list from the specified file. Messages are transmitted through the same channel for a single transaction.

By default, messages are transmitted through each channel in a round robin fashion. (Create the file with one "ip:port" per line.)

[-H]

If set, no alive check message is printed in the log.

[-t]

This option is required when multiple domains are connected to a single JTmax instance.

If not set in such an environment, recovery may fail or behave incorrectly.

[-m MAX_COUNT]

Number of requests that the gateway can issue to JTmax.

(default value: 500)

[-x]

Suppresses printing of the GATEWAY0046, GATEWAY0064, GATEWAY0098 messages in the slog, which are generated while attempting to connect to an invalid remote address.

[-n]

Uses all channels in a round-robin fashion.

2.3. Cautions

  • Byte limits for large-volume data transactions

    • To send/receive more than 5,000,000 bytes of data with JAVAGW and WAS, you must set the jeus.net.msg.max property to a value greater than its default (5,000,000). This property defines the maximum message size allowed through the JEUS protocol.

    • Related libraries : jeus.jar, webtutil.jar

3. Tuxedo

This section describes CLOPT options for Tuxedo gateway.

3.1. Tuxedo Gateway

CLOPT options for gateway whose GWTYPE is "TUXEDO".

Option Description

[-a LOCAL_DOMAIN_NAME]

Domain name (DM_REMOTE_DOMAINS) to be used to connect to Tuxedo domain gateway. If no name is specified, the following error message will be displayed.

"3005 gateway name (-a domname) not defined"

[-e LOGFILE_PATH]

Log file path to store standard errors.

[-o LOGFILE_PATH]

Log file path to store standard outputs.

[-u UID]

Must be set when using ACL, because calls not initiated by Tmax clients may be requested.

[-n]

When integrating a Tuxedo gateway with Tuxedo 7.2 or later, this option is active even if the -t option is not specified. If this option is not set, the -t option must be explicitly configured in Tuxedo. (Release r9786)

[-c checktime -C checksvcname ]

  • -c : If no response is received from an external system during the alive check period and within the specified time, the connection is terminated. After disconnection, the Tuxedo gateway is restarted, or reconnected only when the service request is made.

  • -C : Name of the service to perform alive checks. If not sepcified, an internally used value is applied.

[-F]

Used if the type of a message transmitted by Tuxedo is FML16. If no type is specified, this option will be set to FML32.

[-v]

Used if the type of a message transmitted by Tuxedo is VIEW16. If no type is specified, this option will be set to VIEW32.

[-i]

Must be set to use channel IRT when configuring Tuxedo Cousin.

[-r REMOTE_DOMAIN_NAME]

Used to authenticate Tuxedo when it attempts to connect to Tmax. Only Tuxedo domain gateway whose local domain name is set as REMOTE_DOMAIN_NAME will be allowed to access Tmax.

If it fails to be authenticated, then the following error message will be displayed:

"0046 incorrect local name(REMOTE_DOMAIN_NAME), remote domain name(counterpart local domain name)"

[-h]

When multiple local gateways are configured, each gateway attempts to connect to the remote systems independently. As a result, in Tmax Tuxgw, if a second connection attempt is made after one is already established, the following error message is generated:

(E) GATEWAY3010 connection error from remote gateway [TUXGW0002]

If not needed, use this option to prevent this message from being logged.

[-D]

Among the messages that are sent and received through Tuxedo gateway, those that have not been processed correctly are output as binary data with the following message:

<time>:discarded [tmax | tuxedo] message(size:<size>)

3.2. Tuxedo Async Gateway

Same as the CLOPT options for Tuxedo Gateway.