Version 9.6
 —  IMS Connect RPC Server  —

Administrating EntireX IMS Connect RPC Server

The EntireX IMS Connect RPC Server allows standard RPC clients to communicate with IMS MPP programs running on IMS version 9 and higher. The IMS Connect RPC Server transforms the RPCs from the clients into messages to IMS Connect v2.2. The IMS Connect RPC Server acts on one side as an RPC server and on the other side as a client for IMS Connect. The IMS Connect RPC Server is a Java-based component that can run on a different host to the one where IMS is running. This allows it to operate with a zero footprint of EntireX on the IMS host.

This document covers the following topics:


Customizing the IMS Connect RPC Server

For the setup of the IMS Connect RPC Server there are

Location of the the IMS Connect RPC Server

The IMS Connect RPC Server is contained in the file entirex.jar.

The Configuration File

The default name of the configuration file is entirex.imsconnect.properties. The IMS Connect RPC Server searches for this file in the current working directory.

You can set the name of the configuration file with -Dentirex.server.properties=<your file name> with "/" as file separator.

The configuration file contains the configuration for both parts of the IMS Connect RPC Server.

graphics/imsConnect_config.png

Start of instruction setTo set up the IMS Connect RPC Server

  1. Use the RPC server agent of the System Management Hub.

  2. Add the IMS Connect RPC Server as an RPC server.

    See Administering the EntireX RPC Servers using System Management Hub under UNIX | Windows for details.

    Or:
    Use the scripts to start the IMS Connect RPC Server.

    Under Windows, use imsconnectserver.bat in the folder bin to start the IMS Connect RPC Server. You may customize this file.

    Under UNIX, use imsconnectserver.bsh in the folder bin to start the IMS Connect RPC Server. You may customize this file.

    Both scripts use the configuration file entirex.imsconnect.properties in the folder etc.

Configuring more than one IMS Connect RPC Server

If you configure more than one IMS Connect RPC Server that connect to the same EntireX Broker, the following items must be distinct:

Top of page

Configuring the RPC Server Side

The RPC server side of the IMS Connect RPC Server is configured like the Java RPC Server. The IMS Connect RPC Server uses the properties that start with "entirex.server".

The RPC server side can adjust the number of worker threads to the number of parallel requests. Use the properties entirex.server.fixedservers, entirex.server.maxservers and entirex.server.minservers to configure this scalability.

If more than entirex.server.minservers are waiting for requests, a worker thread stops if its receive call times out. The timeout period is configured with entirex.server.waitserver.

Alternatively to the properties, you can use the command-line option. The command-line options have a higher priority than the properties set as Java system properties and these have higher priority than the properties in the configuration file.

Name Command-line Option Default Value Explanation
entirex.bridge.verbose   no Verbose/trace mode of IMS Connect RPC Server
entirex.server.brokerid -broker localhost Broker ID
entirex.server.serveraddress -server RPC/SRV1/CALLNAT Server address.
entirex.server.userid -user IMSRPCServer The user ID for the Broker for RPC. See entirex.server.password.
entirex.server.fixedservers   no
no Use attach server to manage worker threads.
yes Run minimum number of server threads.
entirex.server.minservers   1 Minimum number of server threads.
entirex.server.maxservers   32 Maximum number of server threads.
entirex.server.restartcycles -restartcycles 15 Number of restart attempts if the Broker is not available. This can be used to keep the IMS Connect RPC Server running while the Broker is down for a short time.
entirex.server.password -password   The password for secured access to the Broker.
For Java 1.4 and above, the password is encrypted and written to the property entirex.server.password.e.
To change the password, set the new password in the properties file (default is entirex.imsconnect.properties).
To disable password encryption set entirex.server.passwordencrypt=no. Default for this property is "yes".
For Java 1.3 and below, the password encryption is not available.
entirex.server.properties -propertyfile entirex.server.properties The file name of the property file.
entirex.server.security -security no no|yes|auto|name of BrokerSecurity object
entirex.server.encryptionlevel   0 Encryption level. Valid values: 0,1,2.
entirex.server.compresslevel -compresslevel 0 Permitted values (you can enter the text or the numeric value)
BEST_COMPRESSION 9
BEST_SPEED 1
DEFAULT_COMPRESSION -1, mapped to 6
DEFLATED 8
NO_COMPRESSION 0
N 0
Y 8
entirex.server.waitattach   600S Wait timeout for the attach server thread.
entirex.server.waitserver   300S Wait timeout for the worker threads.
entirex.timeout   20 TCP/IP transport timeout. See Setting the Transport Timeout under Writing Advanced Applications - EntireX Java ACI.
entirex.server.verbose -verbose no Verbose output to standard output yes|no.
entirex.server.logfile -logfile   Path and name of the trace output file.
entirex.trace -trace 0 Trace level (1,2,3).
entirex.server.monitorport -smhport 0 The port where the server listens for commands from the System Management Hub (SMH). If this port is 0, no port is used and management by the SMH is disabled.

Top of page

Configuring the IMS Connect Side

These properties are used to configure the connection to IMS Connect.

Alternatively, you can use the command-line option. The command-line options have a higher priority than the properties set as Java system properties and these have higher priority than the properties in the configuration file

Name Default Value Explanation
ims.host   Host name of IMS Connect. Mandatory.
ims.port   Port number of IMS Connect. Mandatory.
ims.datastoreid   Data store ID. Name of the IMS system that will receive transactions. Mandatory.
entirex.bridge.targetencoding cp037 Specify the appropriate EBCIDIC encoding used by your IMS Connect. This codepage is also used when communicating with the EntireX Broker.

Note:
Enable conversion in the Broker attribute file so the data can be converted correctly, typically by setting service-specific attribute CONVERSION to "SAGTCHA".

Default "cp037" is EBCDIC codepage with full Latin-1 character set.

ims.useoldexit yes
yes Use old IMS Connect user message exit. Name is *SAMPLE*.
no Use new IMS Connect user message exit. Name is *SAMPLE1*.
ims.exitname *SAMPLE* (old exit)
*SAMPL1* (new exit)
Name of IMS Connect user message exit.
ims.sockettimeout 10000 Socket timeout for connection to IMS Connect (in milliseconds).
ims.checkdfs true
true, yes Check for DFS message. Return an error and do not return the message if it contains a DFS error message.
false, no Do not check for DFS message.
ims.clientid   ID of the client that is used by IMS Connect. Maximum 8 bytes (optional).
ims.lterm   IMS LTERM override. Maximum 8 bytes (optional).
ims.userid   RACF user ID. Maximum 8 bytes (optional).
ims.groupid   RACF group ID. Maximum 8 bytes (optional).
ims.password   RACF password/PassTicket. Maximum 8 bytes (optional).
ims.applname   RACF application name. Maximum 8 bytes (optional).
ims.sslparams   SSL parameters (optional). Same syntax as Broker ID.
ims.mapping.folder   The folder where the server expects SVM files (extension .svm). SVM files are generated by the IDL Extractor for COBOL and COBOL Wrapper. See Server Mapping Deployment.
ims.useprogramname false Automatically use the IDL program name as transaction name. If set to "true" or "yes", 10 bytes are used for the transaction name. If set to a number, this number of bytes is used for the transaction name.

Top of page

Starting the IMS Connect RPC Server

Start of instruction setTo start the IMS Connect RPC Server

Top of page

Stopping the IMS Connect RPC Server

Start of instruction setTo stop the IMS Connect RPC Server

Top of page

Application Identification

The application identification is sent from the IMS Connect RPC Server to the Broker. It is visible with Broker Command and Info Services.

The identification consists of four parts: name, node, type, and version. These four parts are sent with each Broker call and are visible in the trace information.

For the IMS Connect RPC Server, these values are:

Identification Part Value
Application name ANAME=IMS Connect RPC Server
Node name ANODE=<host name>
Application type ATYPE=Java
Version AVERS=9.5.0.0

Top of page