Example: Invoking SOAP Services using the SDA Web Services Plugin

0 Likes
If you want to execute a SOAP service operation as part of a Serena Deployment Automation (SDA) process step, you can use the SDA Web Services plugin Invoke SOAP service step to do this. The following example gives the basics on how you would configure the step properties.

SOAP Example

SOAP services are described by the associated WSDL. If you are invoking SOAP web services using a SOAP Web Services plugin step, the required properties are WSDL URL and Operation. A simple request can be done with just WSDL URL and Operation; Parameters are needed for complex requests.
The following figure shows an example of a process step that invokes one of the ChangeMan ZMF Connector services, almzmf, to get ChangeMan ZMF sites.
b2ap3_thumbnail_webservices_example_soap_process_60.png
In the preceding figure, the WSDL URL property points to the ZMFPackageServices.wsdl file, Operation is getAppSites, and the Parameters property gives the required information for the SOAP service call.
Your parameters must be entered in XML format.
Note: The simpler parameter format, such as auth.hostaddress=q002 is not supported, because it won't work for all services; you must use XML.
The full parameters for the getAppSites operation are as follows:
b2ap3_thumbnail_webservices_example_parameters_xml.png
The xsd tag may not be necessary, depending on your services. If your server doesn't require that the namespace is set, you can omit the xsd wrapper.
In this example, the xsd wrapper is needed, because we cannot determine the namespace from the WSDL. If you do need to set the namespace, the root element name can be found in the WSDL file. This is usually the same or similar name as that of the operation.
The following figure shows the WSDL element name used for the namespace ID in the corresponding xsd.
b2ap3_thumbnail_webservices_example_wsdl_element_name_edited.png

SOAP Headers

If your services requires a SOAP header, click Show Hidden Properties to show additional fields.
In this example, the header is used to set up authentication. If your server needs the Header tag, you should enter it in SOAP Header as shown in the following figure.
b2ap3_thumbnail_webservices_example_soap_header_60.png
The full SOAP header text for the preceding example is as follows:

 b2ap3_thumbnail_webservices_example_wsdl_full_header_example.png

Destination

If you set the Destination property to Step properties, the responses to the SOAP operation appear in output properties and can be referenced and used in the next process step.

If you select File for the Destination property, specify the file name to use in the following field, Response file.

You can use Status expression to parse or verify the response. 

For details on the Web Services Plugin steps and properties, see the Serena Deployment Automation Plug-ins Guide or Plug-ins Index on Serena Documentation Center.

Important: The ZMF SOAP service is shown here as an example to illustrate how to execute SOAP services using the Web Services Plugin. However, if you are planning to use SDA with ZMF, you would typically use the SDA ZMF Plugin, which includes steps for typical ZMF change package activities. For information on using the Deployment Automation ZMF Plugin, see the Deployment Automation Plug-ins Guide or Index. For information on ChangeMan ZMF Connector, see the ChangeMan ZMF Connector Configuration Guide.

 

 

Labels:

How To-Best Practice
Comment List
Anonymous
Related Discussions
Recommended