Start of change

Migrating from IMS Enterprise Suite Version 3.1 SOAP Gateway

After you install IMS Enterprise Suite Version 3.2 SOAP Gateway, migrate your web service files and server properties by using the SOAP Gateway management utility iogmgmt -migrate command.

To migrate your existing web services and server properties:

  1. Use the SOAP Gateway management utility iogmgmt -migrate path_to_source_installation command in the new installation (target) to migrate all web services and server properties from the previous installation (source).
    1. Go to the directory where the V3.2 SOAP Gateway management utility is at: install_dir/imsserver/deploy.
    2. Issue the following command:
      ./iogmgmt -migrate path_to_3.1_install_dir/imsserver 
    The migration utility handles the following migration tasks:
    • The correlator entries are migrated over and checked to ensure that the files are up to date.
    • The connection bundle files are copied to the new installation.
    • The following server configuration information is copied over to the new installation:
      • Server properties that are set through the SOAP Gateway management utility.
        Important: The iogmgmt -migrate command does not validate the existing values. If an invalid value was previously manually added, the problem would not surface until during run time.
      • The wsjaas.conf file and the server policy and bindings files for web services security are copied over.
      • The WS-Security binding and policy files are migrated only if the source binding/policy files are different from the target binding and policy files.
      • The following properties that are set in the log4j.properties file are migrated to the native.env.properties file:
        • log4j.appender.CONSOLE.Threshold
        • log4j.appender.LOGFILE.Threshold
        • log4j.appender.LOGFILE.encoding
    • For web services migration, the tool parses through the correlator entries on the source (V3.1) server to identify all the existing web services and their corresponding WSDL files:
      • For the provider scenario, for each WSDL file found in the correlator entries:
        • If the WSDL file and the XSD files it references do not exist in the wsdl/ directory, but the web service .aar file is found in the WEB-INF/services/ directory, the web service .aar file is copied over to the target server (V3.2).
        • If the WSDL file and the XSD files it references exist in the wsdl/ directory, a web service .aar file is generated on the target server.
      • For the consumer and business event scenarios, the WSDL and XML files must exist on the source server. These files are copied over to the target server.

    Log file location and trace level setting are not migrated.

    A migration report (migration.log) is saved in the designated V3.2 SOAP Gateway log file directory. The report contains the following information:
    • Server configuration information that is migrated and configured.
    • Web services security-related files that are migrated.
    • Connection bundle information that is migrated.
    • Correlator files that are migrated and updated to the new schema.
    • Web services that are deployed.
  2. Check the migration report.
    For any reported issues, correct the issues, and rerun the iogmgmt -migrate command until all errors are resolved.
    Important: You can run the migration tool as many times as necessary.

    For web services that fail to be deployed, after the issues are corrected, manually deploy the services by using the iogmgmt -deploy command. For example:

    ./iogmgmt -deploy -w /path/to/yourWSDLFile.wsdl -r /path/to/yourCorrelatorFile.xml 
  3. Adjust your server properties if necessary. Customize your log file location and trace level setting.
  4. Start the SOAP Gateway server. If the server is already running, you must restart the server for server property changes to take effect.
End of change