Creating Web Services and Web Clients in Caché
Using the SOAP Wizard
[Home] [Back] [Next]
InterSystems: The power behind what matters   

Using the SOAP Wizard
Studio provides the SOAP Wizard, which enables you to generate a client for a given web service, given the WSDL of that service.
When using templates such as the SOAP Wizard, Studio will use a proxy server, if it is enabled. For information on specifying the proxy server and port, see Using a Proxy Server in Using Caché Internet Utilities.
To use the SOAP wizard:
  1. Examine the WSDL and check for the following items:
    In either case, if the answer is yes, then you will need to select the option Use unwrapped message format for document style web methods, which is described in a later step.
  2. On the first screen:
    1. Click either URL or FILE, depending on the location of the WSDL.
    2. Enter the location of the WSDL. Type either the entire URL or the complete path and filename for the WSDL.
    3. If the WSDL is at a location that uses SSL (that is, if the URL starts with https), then select a suitable SSL configuration from the SSL Configuration dropdown list. For information on creating and managing SSL/TLS configurations, see the chapter Using SSL/TLS with Caché in the Caché Security Administration Guide.
      This wizard specifies an SSL configuration to use when accessing the WSDL. This field is not used in any other way.
    4. If the WSDL is at a location that uses SSL, the wizard will (by default) checks whether the certificate server name matches the DNS name used to connect to the server. If these names do not match, the connection is not permitted. This default behavior prevents “man in the middle” attacks and is described in RFC 2818, section 3.1; also see RFC 2595, section 2.4.
  3. Click Next.
    The wizard then attempts to access the WSDL and display it so that you can verify that you have chosen the correct one.
    If the wizard cannot access the WSDL, it displays a screen that displays the error and provides options that you can use to provide a username and password. (Many WSDLs are at URLs that are protected by a username and password, and this is a common reason for failing to access the WSDL.) In this scenario, first do one of the following:
    Then enter values in the Username and Username fields and press Try Again. Note that the wizard does not save your entries for these items.
  4. On the screen that displays the WSDL, specify options as follows:
  5. If you have an Ensemble installation, optionally provide values for the following additional fields:
    For information on Ensemble, see the Ensemble documentation.
  6. Click Next. The wizard then displays a screen like the following:
  7. Specify the following options:
  8. Optionally edit the package names. The wizard uses the following rules for package names:
  9. Click Next. The wizard generates and compiles the classes and displays a list of these classes.
  10. Click Finish.
If you use a WSDL URL and there are problems with the wizard, save the WSDL as a file and try again, using that file as input.
If the WSDL contains references to externally defined entities, the wizard attempts to resolve those; for this task, the timeout period is 10 seconds.
For properties of these classes, if the corresponding element in the schema has a name that starts with an underscore (_), the name of the property starts with a percent sign (%).

Send us comments on this page
Copyright © 1997-2019 InterSystems Corporation, Cambridge, MA