IMS Correlator file

Edit online

The IMS Correlator file tab allows you to specify the service identification properties and the IMS system interaction properties for the new Web service.

This tab contains the following fields:

  • In the Specify service identification properties group:

    WSID
    This field displays the Web service identifer that is used at run time to identify the Web service. This Web service identifier must be unique among all Web services deployed to the same IMS Enterprise Suite SOAP Gateway.
    This identifier is fixed to be the name of the mapped WSDL file minus the extension.
    Note: Because of this naming convention, and because this identifer must be unique among all Web services deployed to the same IMS Enterprise Suite SOAP Gateway (see the preceding paragraph), therefore no two Web services deployed to the IMS Enterprise Suite SOAP Gateway can have identically named WSDL files.
    The IMS Enterprise Suite SOAP Gateway uses this identifier to locate the service that an IMS application wants to invoke. The outbound XML Converter transmits the WSID to the IMS Enterprise Suite SOAP Gateway on behalf of the IMS application.
    File container
    Type or the select the path of the folder in which you want the wizard to generate the IMS correlator file.
    File name
    This field displays the name of the IMS correlator file that the wizard is to generate. You can modify this field by changing the name in the SOAPAction field described previously.
    Update, Overwrite
    These radio buttons are enabled if the IMS correlator file that you specified in the File container and File name fields (described previously) already exists:
    • Select Update if you want the wizard to do the following:
      1. Preserve all the existing entries in the IMS correlator file; and
      2. Add or update information for the current Web service and operation on the WSDL and XSD tab of the Generation Options page of the wizard.
    • Select Overwrite if you want the wizard to overwrite the existing IMS correlator file.
    Entries in the IMS correlator file are identified by a combination of the Web service name and the operation name. If you specify a Web service name and an operation name that already exist in the IMS correlator file, then the wizard initializes the request and response schema properties on this page with the values from the IMS correlator file.

  • In the Specify IMS system interaction properties group:

    Transaction code
    Type the name of the IMS transaction that handles the response that the Web service receives.
    This name must be alphanumeric and must contain 8 characters or less.
    Inbound connection bundle
    Type the name of the connection bundle that you want the Web service to use in the IMS Enterprise Suite SOAP Gateway.
    This name must be alphanumeric.
    Inbound TPIPE name
    Type the Tpipe name used with CM0 transactions in IMS.
    LTERM name
    Type the LTERM name that is to be used to override the value in the LTERM field of the IMS application program's I/O PCB.
    This name must be alphanumeric and must contain 8 characters or less.
    Socket timeout
    Type the number of milliseconds that the IMS Enterprise Suite SOAP Gateway should wait for a response from IMS Connect.
    Execution timeout
    Type the number of milliseconds that IMS Connect should wait for a response from the IMS Enterprise Suite SOAP Gateway.
    The maximum valid value is 3600000.
    Callout message type
    Select ASYNC Asynchronous or SYNC Synchronous processing. For more information about the callout message type, see Support for the IMS Callout (ICAL) call.
    Send-only with ACK support
    Enable or disable the send-only acknowledgement protocol. If enabled, SOAP Gateway sends the callout response message to IMS using the send-only with acknowledgement protocol. This option is available for the synchronous callout message type only.
    Callout connection bundles
    The name of the connection bundle for IMS Enterprise Suite SOAP Gateway outbound communication.
    Web service timeout
    Type the number of milliseconds that the IMS Enterprise Suite SOAP Gateway should wait for a response from the Web service to which the request is sent.
    The maximum valid value is 21474483646.
    Callout WS-Security
    Select the security token type that IMS Enterprise Suite SOAP Gateway will expect from users.