IMS connection factory properties

The custom properties of an IMS™ TM resource adapter connection factory must be configured properly to match the characteristics of the target Enterprise Information System.

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:

HostName
This value is mandatory for TCP/IP connections only. It is ignored for Local Option connections. You must replace the value "myHostNm " with the IP address or host name of the machine on which the target IMS Connect is running.
PortNumber
This value is mandatory for TCP/IP connections only. It is ignored for Local Option connections. You must replace the value of "0" with 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 and IMS Connect can be configured to use multiple ports for communications with IMS Connector for Java and other clients. See "Configuring IMS Connect" in the IMS Connect Guide and Reference (SC18-9287-02) for additional information about the PortNumber property.
CM0Dedicated
This value is optional and it applies to TCP/IP connections only. The default value 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. Each dedicated persistent socket connection is reserved for a particular clientID and only commit mode 0 interactions are permitted on dedicated persistent socket connections.
SSLEnabled
This value is optional and it applies to TCP/IP connections only. The default value is FALSE. A value of TRUE indicates that this connection factory will be used to create SSL socket connections to IMS Connect using the HostName and PortNumber specified in its connection properties. This PortNumber must be configured as an SSL port in the IMS Connect configuration. A value of FALSE indicates that SSL sockets will not be used for connecting to the port specified in the PortNumber property.
SSLKeyStoreName
This value is optional, it applies to TCP/IP connections only, and SSLEnabled must be set to TRUE. SSLPrivate 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 SSLKeyStoreName / SSKeyStorePassword property is left empty, an informational message is generated in the server log.
The SSLKeyStoreName property can be used to specify either a JKS keystore or a RACF® keyring when running on z/OS®. 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. 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 SSLKeyStoreName 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 SSLKeyStoreName 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.
SSLKeyStorePassword
This value is optional, it applies to TCP/IP connections only, and SSLEnabled must be set to TRUE. Specify the password for the keystore.
SSLTrustStoreName
This value is optional, it applies to TCP/IP connections only, and SSLEnabled must be set to TRUE. 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 SSLKeyStoreName and SSLTrustStoreName 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 SSLTrustStoreName / SSLTrustStorePassword 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.
SSLTrustStorePassword
This value is optional, it applies to TCP/IP connections only, and SSLEnabled must be set to TRUE. Specify the password for the truststore.
SSLEncryptionType
The value of the SSLEncryptionType property is case-insensitive and optional. It applies to TCP/IP connections only, and SSLEnabled must be set to TRUE. Select the encryption type to STRONG, WEAK or ENULL. STRONG and WEAK reflect the strength of the ciphers which is related to the key length. All those ciphers that can be used for export are in the weak category and the rest go into the strong category. By default, the encryption type is set to WEAK. When ENULL is specified, the IMS TM resource adapter will use a cipher spec whose name contains the string “NULL". Null encryption will allow for authentication to take place during the SSL handshaking process as is currently the case. Once the handshaking process for a socket has completed including authentication as required, all messages will flow in the clear over that socket.
IMSConnectName
This value is mandatory for Local Option connections only. Specify the job name of the target IMS Connect. If the IMSConnectName is specified, the Host name, Port number, and SSL-related properties will be ignored. When an IMS Connect name is specified for a connection factory, that connection factory can only be used to create Local Option connections.
UserName
This value is optional and is 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 or the container.
Password
This value is optional and is the password that will be used for connections created by this connection factory if the default user name is used.
GroupName
This value is optional and is 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 EIS signon environment.
DataStoreName
This value is mandatory and is the name of the target IMS datastore. You must replace the default value, "myDStrNm", with the ID parameter of the Datastore statement specified in the target IMS Connect configuration member. It also serves as the XCF member name for IMS during internal XCF communications between IMS Connect and IMS OTMA. The value specified for DataStoreName is case sensitive.
TraceLevel
This value is optional and is the level of information to be traced. For additional information on trace level, see Logging and tracing with the IMS TM resource adapter.
TransactionResourceRegistration
This value is optional and is the type of transaction resource registration (transaction enlistment). This property has been deprecated but is still supported for compatibility with older applications. 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
This value is optional and is a unique name for identifying the repository location. This ID applies to MFS transactions only and 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
This value is optional and specifies the physical location of the XMI repository. The URI applies to 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.

Feedback