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.
[-h]	Same as the -h option for CLOPT in GATEWAY.
[-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.
[ -l "ip-addr,ip-addr2…"]	L4 periodically sends the ping command to a gateway with a connection for alive check and forcibly ends the connection. The gateway records log about the disconnection. This causes an issue of a large volume of unnecessary data. If this option is used, the unnecessary log is not recorded.
[-m]	Terminates tmgw(nt) when TMM is terminated, like MAC = Y in the SERVER section.
[-k]	Same as the -k option for CLOPT in GATEWAY.

Option

Description

[-r]

Same as the -r option for CLOPT in GATEWAY.

[-h]

Same as the -h option for CLOPT in GATEWAY.

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

[ -l "ip-addr,ip-addr2…"]

L4 periodically sends the ping command to a gateway with a connection for alive check and forcibly ends the connection. The gateway records log about the disconnection. This causes an issue of a large volume of unnecessary data. If this option is used, the unnecessary log is not recorded.

[-m]

Terminates tmgw(nt) when TMM is terminated, like MAC = Y in the SERVER section.

[-k]

Same as the -k option for CLOPT in GATEWAY.

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.
[-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.
[ -l "ip-addr,ip-addr2…"]	Same as the -l option for Tmax transaction domain gateway.
[ -m ]	Terminates tmgw(nt) when TMM is terminated, like MAC = Y in the SERVER section.
[-k]	Same as the -k option for CLOPT in GATEWAY.

Option

Description

[-h]

Same as the -h option for CLOPT in GATEWAY.

[-i]

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

[ -l "ip-addr,ip-addr2…"]

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

[ -m ]

Terminates tmgw(nt) when TMM is terminated, like MAC = Y in the SERVER section.

[-k]

Same as the -k option for CLOPT in GATEWAY.

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.
[-e LOGFILE_PATH]	Log file path to store standard errors.
[-o LOGFILE_PATH]	Log file path to store standard outputs.
[-r]	Must be specified for versions later than WebT 3.14.
[-h VERSION]	Set to 1 if the header is set as the default value in WebT 3.x and WebT 5.x. Set to 4 if the header is set to extendedV4 in WebT 5.x.
[-t]	Must be specified to connect multiple domains to one JTmax. If multiple domains attempt to connect to one JTmax without setting this option, a recovery process will fail.

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.

[-e LOGFILE_PATH]

Log file path to store standard errors.

[-o LOGFILE_PATH]

Log file path to store standard outputs.

[-r]

Must be specified for versions later than WebT 3.14.

[-h VERSION]

Set to 1 if the header is set as the default value in WebT 3.x and WebT 5.x.
Set to 4 if the header is set to extendedV4 in WebT 5.x.

[-t]

Must be specified to connect multiple domains to one JTmax. If multiple domains attempt to connect to one JTmax without setting this option, a recovery process will fail.

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.
[-e LOGFILE_PATH]	Log file path to store standard errors.
[-o LOGFILE_PATH]	Log file path to store standard outputs.
[-r]	Must be specified.
[-h 4]	Must be set to 4.
[-A TIME]	Used to close a connection with an external gateway if no response is received within a specified amount of time or an alive check interval.
[-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, an alive check message is not written to the log file.
[-t]	Must be specified to connect multiple domains to one JTmax. If multiple domains attempt to connect to one JTmax without setting this option, a recovery process will fail.
[-m MAX_COUNT]	Number of requests that the gateway can issue to JTmax. (default value: 500)

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.

[-e LOGFILE_PATH]

Log file path to store standard errors.

[-o LOGFILE_PATH]

Log file path to store standard outputs.

[-r]

Must be specified.

[-h 4]

Must be set to 4.

[-A TIME]

Used to close a connection with an external gateway if no response is received within a specified amount of time or an alive check interval.

[-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, an alive check message is not written to the log file.

[-t]

Must be specified to connect multiple domains to one JTmax. If multiple domains attempt to connect to one JTmax without setting this option, a recovery process will fail.

[-m MAX_COUNT]

Number of requests that the gateway can issue to JTmax. (default value: 500)

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 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]	UID is specified to prevent a call request, which a Tmax client has not issued, when using ACL.
[-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.
[-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(local domain name of the opposite end)
[-h]	If multiple local gateways are set, each gateway tries to connect to each remote gateway. In Tuxgw of Tmax, after a connection has been established, the following error occurs when the second connection is attempted. (E) GATEWAY3010 connection error from remote gateway [TUXGW0002] If not needed, use this option to prevent this message from being logged.
[-D]	Among messages that are sent and received through Tuxedo gateway, messages that have not been processed successfully are output as binary data with the following message format. <time>:discarded [tmax \| tuxedo] message(size:<size>)
[-c time(sec)]	Executes tpcall() for a connected Tuxedo at the interval specified in time Calls the service specified with the -C option. If a service name is not specified, dus$%@tjq is used. If no response is received during the specified time * 2, the connection is ended.
[-C service_name]	Service name used along with the -c option.
[-i]	If Tuxedo gateway is set as COUSIN, normal scheduling is performed even if there is a channel issue. Unlike existing IRT, the first several calls may fail because the Tuxedo gateway is used for transactions. After the first several calls, normal scheduling is performed.

Option

Description

[-a LOCAL_DOMAIN_NAME]

Domain name 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]

UID is specified to prevent a call request, which a Tmax client has not issued, when using ACL.

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

[-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(local domain name of the opposite end)

[-h]

If multiple local gateways are set, each gateway tries to connect to each remote gateway. In Tuxgw of Tmax, after a connection has been established, the following error occurs when the second connection is attempted.

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

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

[-D]

Among messages that are sent and received through Tuxedo gateway, messages that have not been processed successfully are output as binary data with the following message format.

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

[-c time(sec)]

Executes tpcall() for a connected Tuxedo at the interval specified in time

Calls the service specified with the -C option. If a service name is not specified, dus$%@tjq is used. If no response is received during the specified time * 2, the connection is ended.

[-C service_name]

Service name used along with the -c option.

[-i]

If Tuxedo gateway is set as COUSIN, normal scheduling is performed even if there is a channel issue.

Unlike existing IRT, the first several calls may fail because the Tuxedo gateway is used for transactions. After the first several calls, normal scheduling is performed.

3.2. Tuxedo Async Gateway

Same as the CLOPT options for Tuxedo gateway.