Chapter 4 . Configuring BEA Connect TCP for IMS

BEA Connect TCP for IMS makes use of a configuration file that is read and processed at run time to establish the processing environment. The configuration file is a simple, plain-text file that a systems programmer can edit easily to define and alter the configuration.

The configuration file includes the following information:

System configuration parameters
Statement(s) that defines the local gateway (BEA Connect TCP for IMS)
Statement(s) that defines remote gateway(s) with which BEA Connect TCP for IMS can establish connections and exchange requests and responses
Statement(s) that defines service(s) offered by remote gateways that can be requested by IMS clients of BEA Connect TCP for IMS

System Configuration Parameters

System configuration parameters are defined by the SYSTEM statement. Only one SYSTEM statement is allowed, and should be the first statement in the configuration file.

Syntax of the SYSTEM Statement

SYSTEM,

	[SLEEPTIME=(sleep-min,sleep-max,sleep-delta)]
	[,MSGLEVEL={msg-level| 4}]
	[,CLIENTSHUTDOWN={Yes|No}]
	[,IDLETIMEOUT={nn|0}]
	[,CHKPFREQ={nn|0}]

Description of the Parameters


Parameter	Value	Description
SLEEPTIME	sleep-min	Specifies the minimum amount of time (decimal, milliseconds) that BEA Connect TCP for IMS delays before checking the IMS Message Queue for work.
	sleep-max	Specifies the maximum amount of time (decimal, milliseconds) that BEA Connect TCP for IMS delays before checking the IMS Message Queue for work.
	sleep-delta	Specifies the incremental amount of time (decimal, milliseconds) that BEA Connect TCP for IMS uses to graduate from the minimum sleep time to the maximum sleep time. Because IMS cannot post a BMP when new messages are placed in the BMP's message queue, BEA Connect TCP for IMS periodically "polls" the IMS Message Queue for new work. BEA Connect TCP for IMS uses a graduated polling interval that is set to the minimum sleep time whenever new work is found in the IMS Message Queue. The polling interval is then incrementally increased by the delta time until one of the following occurs: New work is found in the IMS Message Queue (in which case the polling interval is again reset to the minimum value) The maximum sleep time is reached (in which case the polling interval remains at the maximum value) This limits the amount of CPU time required to poll the IMS Message Queue when traffic is heavier. Avoid specifying values that cause the polling interval to be very small (or zero), or values smaller than 100 milliseconds. This may result in polling the IMS Message Queue too frequently. However, also avoid specifying values that cause the polling interval to be too large (greater than one second). This may cause BEA Connect TCP for IMS to be unresponsive. You should vary the sleep time between 100 and 500 milliseconds in 5 millisecond increments. Default Values: 150, 500, 5
MSGLEVEL	msg-level	Specifies the detail level of messages to be logged by BEA Connect TCP for IMS: 0 - No messages are logged 2 - Error Messages only 4 - Informational Messages and Error Messages Note that the Message Level is cumulative. For example, if a Message Level of 4 is specified, all messages with a Message Level of 4 or less will be logged (i.e., informational and error messages) and will also be displayed on the MVS console. Specifying a Message Level of 0 suppresses all logging. Normally, a Message Level of 4 should be specified, which results in BEA Connect TCP for IMS logging all informational and error messages. Default Value: 4
CLIENTSHUTDOWN	Yes\|No	Specifies whether a SHUTDOWN request can be made by a remote client request or as a response to a remote client request. Refer to Chapter 5, "Administering BEA Connect TCP for IMS" for additional information. Default Value: No
IDLETIMEOUT	nn	Specifies the number of seconds that will lapse before the local gateway will terminate a session. Default Value: 0
CHKPFREQ	nn	Specifies the number of seconds that will lapse before the local gateway will take a checkpoint. If you define a checkpoint frequency of zero or do not define a checkpoint frequency value, the BMP will continue to take a checkpoint for each message arriving to the BMP message queue. Note: If you specify a checkpoint frequency and the BMP does not terminate in a normal manner, then IMS will requeue the messages that have been processed by the BMP since the last checkpoint was issued. When the BMP starts, it writes the messages to the SVRLOG file. Default Value: 0

Defining the Local (IMS) Gateway

The local (IMS) gateway is defined by a GATEWAY TYPE=LOCAL statement. There may be multiple GATEWAY TYPE=LOCAL statements, each specifying a different Port Number. There must be at least one GATEWAY TYPE=LOCAL statement.

Syntax of the GATEWAY TYPE=LOCAL Statement

GATEWAY,TYPE=LOCAL,
	LMID=logical-machine-id,
	PORT=port-number,
	ACCOUNT={account-id | *},
	PASSWORD={password | *}
	[,HOSTADDR=ip-address]
	[,MAXMSGLEN={max-message-length | 2048}]
	[,SESSIONS={max-sessions| 1}]
	[,IDLETIMEOUT={nn|0}]

Description of the Parameters


Parameter	Value	Description
LMID	logical-machine-id	Specifies a symbolic name (1-16 characters) that uniquely identifies this gateway/port. Note: Special characters are not supported.
PORT	port-number	Specifies the port number (decimal, 1-32,767) at which inbound connections from remote gateways will be accepted. Choose a port number that is not in the range of well-known port numbers reserved for use by TCP/IP applications.
ACCOUNT	account-id	Specifies the account ID (1-8 characters) that must be specified by a remote gateway to establish a connection. If an Account ID is not used, then ACCOUNT=* should be specified.
PASSWORD	password	Specifies the password (1-8 characters) that must be specified by a remote gateway to establish a connection. If a Password is not used, then PASSWORD=* should be specified.
HOSTADDR	ip-address	Is the IP address for this machine over which inbound connections from remote gateways will be accepted at the specified port number. The IP address is specified using standard dotted-decimal notation (for example, 199.203.45.99). Default Value: If this parameter is not specified, then connections will be accepted over any network interface.
MAXMSGLEN	max-message-length	Specifies the maximum TCP/IP message length (decimal, 1 - 32767) that will be accepted over the connection. Default Value: 2048
SESSIONS	max-sessions	Is the maximum number of concurrent, active inbound sessions (decimal, 0 - 32,767) that will be accepted by this gateway. Default Value: 1
IDLETIMEOUT	nn	Specifies the number of seconds that will lapse before the local gateway will terminate a session. Default Value: 0

Defining Remote (TPS, CICS, IMS) Gateways

A remote gateway is defined by a GATEWAY TYPE=REMOTE statement. There may be multiple GATEWAY TYPE=REMOTE statements.

Syntax of the GATEWAY TYPE=REMOTE Statement

GATEWAY,TYPE=(REMOTE,{TPS|IMS|CICS,tran-id|CICSCPT}),
       LMID=logical-machine-id,
       HOSTADDR=ip-address
       PORT=port-number,
       ACCOUNT={account-id,*}
       PASSWORD={password,*}
       [,MAXMSGLEN=max-message-length]
       [,SESSIONS=(min-sessions),(max-sessions)]
       [,IDLETIMEOUT={nn|0}]

Description of Parameters


Parameter	Value	Description
TYPE	(REMOTE,type)	Specifies the remote gateway type. You must specify one of the following: TPS - The remote gateway is a BEA Connect TPS gateway. IMS -The remote gateway is a BEA Connect TCP for IMS gateway. CICS, tran-id - The remote gateway is a BEA Connect TCP for CICS gateway. "tran-id" specifies the 1-4 character name of the BEA Connect TCP for CICS transaction that is to be scheduled by CICS to handle incoming TCP/IP Connect requests. Refer to the BEA Connect TCP for CICS User Guide for more information. CICS - The remote gateway is a BEA Connect TCP for CICS gateway that uses the Interlink CPT product for TCP/IP access.
LMID	logical-machine-id	Specifies a symbolic name (1-16 characters) that uniquely identifies the remote gateway. The Logical Machine ID is used to associate a remote service with a particular remote gateway.
HOSTADDR	ip-address	Specifies the IP address of the remote gateway. The IP address is specified using standard dotted-decimal notation (for example, 103.204.79.82).
PORT	port-number	Specifies the Port Number (decimal, 1-32,767) to be used to establish a connection with the remote gateway.
ACCOUNT	account-id	Specifies the Account ID (1-8 characters) to be used to establish a connection with the remote gateway. If an Account ID is not used, then ACCOUNT=* should be specified.
PASSWORD	password	Specifies the Password (1-8 characters) to be used to establish a connection with the remote gateway. If a Password is not used, then PASSWORD=* should be specified.
MAXMSGLEN	max-message-length	Specifies the maximum TCP/IP message length (decimal, 1 - 32767) that will be sent over the connection. Default Value: 2048
SESSIONS	min-sessions	Specifies the minimum number of outbound sessions (decimal, 0-32,767) that are to be automatically started with this gateway during initialization of BEA Connect TCP for IMS. Additional sessions (up to the maximum number of sessions specified) are started on a demand basis. Remember that by specifying a minimum number (greater than 0) of outbound sessions for a remote gateway, you can cause outbound session(s) to be automatically established with that gateway during initialization. This can be handy to verify outbound connectivity without having to make use of test transactions. Default Value:0
	max-sessions	Specifies the maximum number of concurrent, active, outbound sessions (decimal, 0-32,767) that will be established with this gateway. Default Value:1
IDLETIMEOUT	nn	Specifies the number of seconds that will lapse before the remote gateway will terminate a session. The remote gateway will terminate sessions until it is equal to the minimum sessions allowed. Default Value: 0

Defining Remote Services

A service offered by a remote gateway is defined by a SERVICE TYPE=REMOTE statement. There may be multiple SERVICE TYPE=REMOTE statements. Furthermore, there may be multiple statements defining the same service, provided each specifies a different remote Logical Machine ID.

Syntax of the SERVICE TYPE=REMOTE Statement

SERVICE,TYPE=REMOTE,
       NAME=(local-service-name,remote-service-name),
       LMID=logical-machine-id,
       TIMEOUT={timeout | 0}

Description of Parameters


Parameter	Value	Description
NAME	local-service-name	Specifies the name (1-16 characters) by which the service is known on this machine. This is the name which must be used by an IMS Client to request the service.
	remote-service-name	Specifies the name (1-16 characters) by which the service is known on the remote machine. This is the name which will be used to invoke the service on the remote machine.
LMID	logical-machine-id	Specifies the Logical Machine ID (1-16 characters) of a remote gateway that offers this service. This name must match a Logical Machine ID (LMID) specified in a GATEWAY TYPE=REMOTE statement.
TIMEOUT	timeout	Specifies the time limit in seconds (decimal, 0 - 32,767) for the service. If a response is not received within the specified period of time, an error condition is recognized. Default Value: 0 (meaning "no time limit").

[Top] [Previous] [Next] [End of Book]