Configuring for the IMS service provider

To set up a new server to use the IMS service provider, use the provided template to set up the required configuration, including the IMS mobile service registry. If you have already set up a server (such as with the CICS® service provider), or you have specific layout requirements for the XML file, manually configure the server.xml file.

Before you begin

The product extensions directory and the required imsmobile.properties file must be created by using the zconsetup install utility script. Ensure that the product extensions directory exists and the required imsmobile.properties file is added by following the steps in Setting up the product extensions directory.

About this task

Use the provided template to set up a server that is configured to use the IMS service provider. Instructions are also provided for manual configuration of the server.xml file.

Procedure

  1. Ensure that a server instance is set up and configured to use the IMS service provider.
    • To set up a new server instance with the IMS service provider, run the zosconnect command in the <installation_path>/bin/ directory with the create option and specify the imsmobile template.
      zosconnect create <server_name> --template=imsmobile:imsDefault

      You get a confirmation that the server <server_name> is created.

    • If you already have an existing server, manually update the server.xml file to use the imsmobile-2.0 feature by adding the following configuration information in the <featureManager> section:
      <featureManager> 
          . . .
        <feature>imsmobile:imsmobile-2.0</feature>  
      </featureManager> 
  2. Configure security. Uncomment the related tags and provide the appropriate values in the server.xml file.
    Note: The Angel process must be started for client authentication.
    1. Uncomment the following tags for SSL and failover to basic authentication:
      <!-- Define the SSL configuration 
           <ssl id="defaultSSLConfig" keyStoreRef="defaultKeyStore" 
                trustStoreRef="defaultTrustStore" clientAuthentication="false" />
           <!-- Define a keystore, use securityUtility to generate encoded password 
           <keyStore id="defaultKeyStore" password="<ADD VALID PASSWORD>"/>
           -->
      
           <!-- Define a truststore, use securityUtility to generate encoded password  
           <keyStore id="defaultTrustStore" password="<ADD VALID PASSWORD>"/>
           -->
      		
           <!-- Fail over to basic authentication 
           <webAppSecurity allowFailOverToBasicAuth="true"/> 
      -->
      

      Use the Liberty server securityUtility command (securityUtility encode userID) to generate the encoded password. This utility is located in the <installation_path>/wlp/bin directory.

      For example, the uncommented security configuration might look as follows:

      <!-- Define the SSL configuration -->
           <ssl id="defaultSSLConfig" keyStoreRef="defaultKeyStore" 
                trustStoreRef="defaultTrustStore" clientAuthentication="false" />
      
           <!-- Define a keystore, use securityUtility to generate encoded password -->
                <keyStore id="defaultKeyStore" password="mypassword_Keystore"/>
      
           <!-- Define a truststore, use securityUtility to generate encoded password -->
                <keyStore id="defaultTrustStore" password="mypassword_Truststore"/>
      
           <!-- Fail over to basic authentication -->
                <webAppSecurity allowFailOverToBasicAuth="true"/> 
      
    2. Configure your SAF registry or basic registry by uncommenting the related sections in the server.xml file.

      For more information about SAF or basic registry configuration, see User registries.

  3. Save your changes.

You can now start (or restart) the server to verify whether you can use the IMS service provider.

  1. Start the server, or restart the server if it is currently running.

    Starting the server is usually done by running a started task based on the sample JCL <hlq>.SBAQSAMP(BAQSTRT). For information about starting the server, see Starting and stopping IBM z/OS Connect.

    A GMOIG7777I message is issued in the console and logged in the messages.log file in <WLP_USER_DIR>/servers/<server_name>/logs, indicating that the feature is initialized successfully.
    Important: You would receive two warning messages, CWWKG0011W and CWWKG0083W, indicating that the port value "portNumber" is not a number. These warnings are as expected.
    The template server.xml has the following entry:
    <properties.gmoa hostName="hostName_or_IPAddress" portNumber="portNumber"/>
    These warning messages simply mean that the default IMS connection profile in the template is not yet configured. A connection profile is only required when a service is invoked. This connection information can be configured when you create an IMS service.

What to do next

You can do a quick test to verify server communications to IMS by using the IMS PingService service. For more information, see Verifying server communication with IMS.
Before you start creating an IMS service, see the following information:
To learn about how to create an IMS service and an API, see the following IMS scenarios. Each scenario includes a tutorial with detailed steps.