Connection properties

When you create an IMS™ service definition or define an IMS connection factory to WebSphere® Application Server, you must provide values for certain properties of the connection between IMS Connector for Java and IMS Connect. The following list describes these connection properties:

Host name
Mandatory for TCP/ IP connections: The IP address or host name of the machine running the target IMS Connect. You must replace the value "myHostNm " with a value that is valid for your IMS environment.
Port number
Mandatory for TCP/IP connections: The number of a port used by the target IMS Connect for TCP/IP connections. Multiple sockets can be open on a single TCP/ IP port. See "Configuring IMS Connect" in the IMS Connect Guide and Reference (SC27-0946-03) for additional information about the PortNumber property. You must replace the value of "0" with a value that is valid for your IMS environment.
CM0Dedicated
The default is false. A value of FALSE indicates the connection factory will generate shareable persistent socket connections and IMS Connector for Java will generate a clientID to identify the socket connection. These connections can be used by commit mode 0 and commit mode 1 interactions. A value of TRUE indicates the connection factory will generate dedicated persistent socket connections, which require user-specified clientIDs to identify the socket connections. A dedicated persistent socket connection is reserved for a particular clientID and only commit mode 0 interactions are allowed. This property applies to TCP/IP connections only.
SSL Enabled
The default is false. This property is only valid for TCP/IP connections. A value of true indicates that IMS Connector for Java will create an SSL socket connection to IMS Connect using the HostName and PortNumber specified in these connection properties. This port must be configured as an SSL port by IMS Connect. A value of false indicates that SSL sockets will not be used for connecting to the port specified in the Port Number property.
KeyStore Name
For non-z/OS platforms, specify the fully-qualified path name of your JKS keystore file. For z/OS, specify the name of your JKS keystore file as above, or a special string that provides the information needed to access your RACF keyring.
Private keys and their associated public key certificates are stored in password-protected databases called keystores. For convenience, trusted certificates can also be stored in the keystore and then the Truststore Name property can either be empty or could point to the keystore file. If the TrustStore Name/TrustStore Password property is left empty, an informational message is generated in the server log.
The keystore name can be used to specify either a JKS keystore or a RACF keyring when running on z/OS. An example of a fully-qualified path name of your JKS keystore file is c:\keystore\MyKeystore.ks. A RACF keyring is specified as: keystore_type:keyring_name:racfid. The keystore_type must be either JCERACFKS when software encryption is used for SSL or JCE4758RACFKS if hardware encryption is used. Replace keyring_name with the name of the RACF keyring that you are using as your keystore and racfid with a RACF ID that is authorized to access the specified keyring. Examples of RACF keyring specifications are "JCERACFKS:myKeyring:kruser01" or JCE4758RACFKS:myKeyring:kruser01". When running in z/OS, if the keystore name matches the above RACF keyring format, IMS Connector for Java will use the specified RACF keyring as its keystore. If the keystore type specified is anything other than JCERACFKS or JCE4758RACFKS, IMS Connector for Java attempts to interpret the keystore name specified as the name of a JKS keystore file.
Note: The JKS file can have other file extensions; it does not have to have to be .ks.
KeyStore Password
Specify the password for the keystore. Private keys and their associated public key certificates are stored in password-protected databases called keystores.
TrustStore Name
For non-z/OS platforms, specify the fully-qualified path name of your JKS truststore file. For z/OS, specify the JKS name or the RACF keyring of the truststore. The same format is used for the values of the Keystore Name and Truststore Name properties. See the description of the Keystore Name property for a discussion of this format.
A truststore file is a key database file (keystore) intended to contain public keys or certificates. For convenience, private keys can also be stored in the Truststore and then the Keystore Name property can either be empty or could point to the truststore file. If the KeyStore Name/KeyStore Password property is left empty, an informational message will be generated in the server log.
Note: The JKS file can have other file extensions; it does not have to have to be .ks.
TrustStore Password
Specify the password for the truststore. A truststore file is a key database file that contains public keys.
Encryption Type
Select the encryption type. Strong and weak are related to the strength of the ciphers, that is, the key length. All those ciphers that can be used for export come under the weak category and the rest go into the strong category. By default, the encryption type is set to weak.
IMS Connect name
Mandatory for Local Option connections: The job name of the target IMS Connect. If the IMS Connect name is specified, it overrides the Host name, Port number, and SSL-related properties.
Default user name
Optional: The default security authorization facility (SAF) user name that will be used for connections created by this connection factory if no UserName property is provided by the application component.
Default password
Optional: The password that will be used for connections created by this connection factory if the default user name is used.
Default group name
Optional: The IMS group name that will be used for all connections created by this connection factory if the default user name is used.
Note: The GroupName property can only be provided in a component-managed environment.
Data store name
Mandatory: The name of the target IMS datastore. It must match the ID parameter of the Datastore statement that is specified in the IMS Connect configuration member. It also serves as the XCF member name for IMS during internal XCF communications between IMS Connect and IMS OTMA. You must replace the default value "myDStrNm" with a value that is valid for your IMS environment.
Trace level
Optional: The level of information to be traced. For additional information on trace level, see Logging and tracing with the IMS resource adapter.
TransactionResourceRegistration
Optional: The type of transaction resource registration (enlistment). Valid values are either "static" (immediate) or "dynamic" (deferred). If this property is set to "dynamic", the enlistment of the resource to the transaction scope will be deferred until the resource is used for an interaction for the first time.
MFS XMI Repository ID
A resource property of a defined J2C Connection Factory, which is accessible on the J2C options page of the server configuration. This field contains a unique name for identifying the repository location. This ID must match the repository field defined in the generated format handler of your application. The default for this field is "default".
MFS XMI Repository URI
A resource property of a defined J2C Connection Factory, which is accessible on the J2C options page of the server configuration. This field specifies the physical location of the XMI repository. Valid formats for this field include:
  • file://path_to_xmi, where path_to_xmi is a directory on the local file system containing the xmi files, for example file://c:/xmi.
  • http://url_to_xmi, where url_to_xmi is a valid url that resolves to a directory containing the xmi files, for example http://sampleserver.com/xmi.
  • hfs://path_to_xmi where path_to_xmi is the HFS directory on the host z/OS®. This format is only supported for WebSphere Application Server for z/OS.
Related concepts
Execution timeout
Socket timeout
Related tasks
Setting execution timeout values
Setting the Socket Timeout Value
Related reference
Valid execution timeout values
IMSInteractionSpec properties
Feedback
(C) Copyright IBM Corporation 2000, 2005. All Rights Reserved.