IMS connection profiles

An IMS connection profile contains information about the IMS hostname, port number, and other security-related properties for connection to the specified IMS host system.

zosConnect-2.0 Applies to zosConnect-2.0.

Each IMS connection profile is enclosed in a pair of the <imsmobile_imsConnection> </imsmobile_imsConnection> tags. Each connection profile references the ID of a connection factory that is defined in the connectionFactory tag. A connection factory contains the required information (username and password) to connect to IMS Connect. If you intend to store the user ID and password in the connection profile configuration, the username and encrypted password for authorization must be specified in the authData element of your connection factory. This connection factory must reference the ID of the authData element.

Note:

A connection factory (connectionFactory) cannot be shared by multiple connection profiles. An authorization data object (authData) cannot be shared by multiple connection factories.
IMS connection pools can be created by referencing a top level connectionManager element with the connectionFactory attribute connectionManagerRef. To learn more about the attributes used to define connection pools, see Configuring connection pooling for database connections in the WebSphere Application Server Liberty documentation.
Important: If IMS connection pools are used, for the connectionTimeout value in the connectionManager element to be effective, the maxPool value in the connectionManager element must be less than or equal to the max socket value in IMS Connect.

Table 1. IMS connection profile: Attributes in the `imsmobile_imsConnection` element
Attribute	Description
id	Specify a unique ID for this connection profile. This ID is the connection profile value to enter in the z/OS® Connect API toolkit when you configure the service properties.
connectionFactoryRef	Set this value to the ID of the `connectionFactory` element.
comment	Optional. Enter your comment for this connection profile.
pingIMSConnectOnInvoke	Ping IMS Connect before the transaction is invoked to ensure that the connection that is retrieved from the connection pool is not stale. Throw an exception if z/OS Connect is unable to ping IMS before the service is invoked.

Table 2. IMS connection profile: Attributes in the `connectionFactory` element
Attribute	Description
id	Specify an ID for the connection factory.
containerAuthDataRef	Set this value to the ID of the `authData` element. If the user ID from the originating client is to be sent to IMS Connect, remove this attribute, and remove or comment out the `authData` element. Use this attribute and the corresponding `authData` element only if you want the user ID and password in the connection profile to be sent to IMS Connect.

Table 3. IMS connection profile: Attributes of the `properties.gmoa` element that is nested within the `connectionFactory` element
Attribute	Description

hostName	Specify the hostname or IP address of the data store server (IMS Connect).
portNumber	Specify the port number that is used to connect to IMS Connect.
SSLEnabled	Indicates whether SSL is enabled for this connection factory.
SSLEncryptionType	Specifies the type of cipher suite to be used for encryption. For more information, see SSL encryption type (SSLEncryptionType) in the IBM IMS documentation.
SSLProtocol	The SSL protocol to be used for encryption.
SSLKeyStoreName	Name (full path) of SSL keystore for client certificates and private keys. For more information, see SSL keystore name (SSLKeyStoreName) in the IBM IMS documentation.
SSLKeyStorePassword	Password of SSL keystore for client certificates and private keys.
SSLTrustStoreName	Name (full path) of SSL keystore for trusted certificates.
SSLTrustStorePassword	Password of SSL keystore for trusted certificates.

Table 4. IMS connection profile: Attributes in the `authData` element
Attribute	Description
id	Specify an ID for this `authData` element.
user	Specify the username to use to connect to IMS Connect.
password	Specify the encrypted password for the specified user. Use a tool such as securityUtility in Liberty to encrypt plain text.

The following sample shows two connection profiles, each referencing a connection factory. Each connection factory references an authData object for authorization with IMS Connect.

<server>
    <imsmobile_imsConnection id="myConnectionID1"
    connectionFactoryRef="myConnection1_CF"             
    comment=""         
    />

    <connectionFactory id="myConnection1_CF" containerAuthDataRef="myConnection1_Auth">
        <properties.gmoa hostName="hostName_or_IPAddress" portNumber="1234"/>
    </connectionFactory>

    <authData id="myConnection1_Auth" user="Fred" password="mypassword"/>
     
    <imsmobile_imsConnection id="myConnectionID2"
    connectionFactoryRef="myConnection2_CF"             
    comment=""         
    "/>

    <connectionFactory id="myConnection2_CF" containerAuthDataRef="myConnection2_Auth">
        <properties.gmoa hostName="hostName_or_IPAddress" portNumber="9876"/>
    </connectionFactory>

   <authData id="myConnection2_Auth" user="John" password="mypassword"/>
  
</server>