About Web services

This documentation describes the Transfer CFT Web services interface option, and provides instructions for getting started with Web services, executing a SEND file transfer request, and retrieving the request details from the catalog.

Web services provide a way for applications to use software services over networks such as the Internet. Client applications use the Web Services Description Language (WSDL) to do this and exchange data using XML. Since you can use URLs, HTTP, and XML to access Web services, applications running on a variety of platforms and using various languages can access XML Web services.

You can use Web services to access all of the main functions for managing Transfer CFT such as:

  • Configure Transfer CFT: create, modify, and view configuration objects
  • Monitor Transfer CFT: consult the log, the catalog, and transfer statistics
  • Create transfers: create a new file transfer, a message or transfer reply

License key

You require a license key that includes the Web services option for the Transfer CFT product. To request a key, contact your Axway sales representative.

About the WSDL file

To use Web services with Transfer CFT, you need a WSDL Web Services Description Language file. Your installed Transfer CFT product comes with a WSDL file that describes the operations, operation attributes, requests and response structure. You can access the WSDL file from your local installation at:

  • On UNIX/Windows: <cft_installation_directory>/distrib/copilot/wsdl/copilotcft.wsdl
  • On z/OS: <copilot. http.httprootdir>/wsdl/copilotcft.wsdl
  • On IBM i: <install_directory>/distrib/copilot/wsdl/copilotcft.wsdl

Using the WSDL file, you can automatically generate a Web services client. You can use an open source Web service Java toolkit, for example Axis from The Apache Software Foundation, to create this Web services client.

The Web services requests sent by the client are then processed on the Transfer CFT Copilot server listening port.

Additional resources

For more information on the following subjects, go to:

You can find SOAP samples and documentation at:

  • Transfer CFT Web services documentation: <cft_installation_directory>/distrib/copilot/wsdl/doc/index.html
  • SOAP request samples:<cft_installation_directory>/distrib/copilot/wsdl/sample
Note For UNIX/Windows systems, for other platforms refer to the platform specific paths.

General restrictions

The Web services process can receive any SOAP request that conforms to the W3C specifications and WS-I Recommendations.

The following restrictions apply to Transfer CFT Web services:

  • The time zone offset is not supported for XSD types Time and DateTime.
  • Element attributes are not supported, nor parsed. This means that if there are incorrect spaces in names for any operation attribute or message, they are skipped and no error is returned. Exceptions are made to support WS-I recommendations.

WS-I recommendations

Verify that the correct option is set if your client requests have to be checked to conform to WS-I recommendations. To do this, set the UCONF [copilot.webservices.wsicomplience] identifier to yes.

The following WS-I constraints are checked by the GUI server for the XML representation of SOAP messages. These constraints include:

  • SOAP Header constraints:
    • R1009: A MESSAGE MUST NOT contain processing instructions
    • R1012: A MESSAGE MUST be serialized as either UTF-8 or UTF-16
  • SOAP Body constraints:
    • R1006: A MESSAGE MUST NOT contain soap:encoding
  • Style attributes on any element that is a child of soap:Body
    • R1007: A MESSAGE described in an rpc-literal binding MUST NOT contain soap:encodingStyle attribute on any elements that are grandchildren of soap:Body
    • R1014: The children of the soap:Body element in a MESSAGE MUST be namespace qualified

For more information on WS-I recommendations, visit http://www.ws-i.org

Related topics

Get started with Web services

Related Links