Contents

SOAP Wizard

SOAP stands for Simple Object Access Protocol. SOAP is a protocol for exchanging XML-based messages over computer networks, normally using HTTP/HTTPS.

For example, the SOAP Listener task on an IIS server uses HTTP protocol to transport SOAP messages to and from the Internet. Applications developed using SOAP Notifier COM components use Notifier protocol to transport SOAP messages to and from a CIC server. SOAP itself is not concerned with the protocol used for transport, so you can use SOAP on many types of computer networks.

The SOAP tools allow you to build a SOAP Request subroutine. The Proxy wizard creates a handler that exposes a SOAP interface for an existing subroutine initiator. You use the wizard to define the calling subroutine and then the variables to use. With this information, the Proxy wizard builds a subroutine you can use with the SOAP tools.

SOAP Tool Variables

The SOAP tools use only variables of the type "string" or "list of strings," so any subroutine to which you are going to add a SOAP request must contain only those types of variables.

Web Services Invoked by SOAP

A web service is a method that you invoke across the Internet. A web service can perform virtually any data processing activity, ranging from simple information lookups to complicated business transactions. SOAP is frequently used to invoke web services. In the SOAP proxy wizard, you must enter a web service name with an IIS server host name and port.

ISAPI Listener Files

These files are used on the web server. The SOAP Listener task on an IIS server uses HTTP protocol to transport COAP messages to and from the Internet. These files include the Web Services Description file and the ISAPI Filter Config file. The Web Services Description file makes it possible to describe a service on the CIC server so that a worldwide audience can find and use it. SOAP clients use this file to generate code to communicate with the web service. The ISAPI Filter Config file filters incoming message requests. This file prevents denial of service attacks.

Note: For more installation and configuration information, consult the Installing and Using SOAP Functionality Technical Reference and Installation Guide.

Proxy Handler Options

These options define how the proxy wizard generates specific logic in the handlers that it generates.

Failure Handling Logic

You cannot define exit paths for a subroutine initiator. A subroutine can use output parameters to signify a failure. Check this option to add failure handling tool step logic.

If you choose this option, when the handler is created, two tool steps are added to help with this. These two tool steps will have TODO in the tool step label. You will have to change the expression, which defaults to true, of the condition tool step and set the fault string, which defaults to empty string, in the assignment step.

Copy Header

If you want to copy the <Header> element and its contents from the source envelope to the response envelope, select this option. This will affect both success and failure paths.

Note: For more information, refer to the Installing and Using SOAP Functionality Technical Reference and Installation Guide.