Generic service client message return details

In the generic service client, message returns are generated after a service call is successfully invoked. Message returns display the content returned by the service.


This page shows the XML content of the request and provides access to data correlation. The same content is presented in three different ways.

This view provides a simplified view of the message that focuses on editing the values of the XML content. Use the Schema menu to enable assistance with editing XML content so that the XML is valid and complies with the XSD specification.

In the Form view, add the XML headers that are required for standard web service calls. On the Header bar, click Add (Add button) to create the default XML header structure for WS-Addressing, WS-ReliableMessaging or WS-Coordination requests, or click More for other standards. You can enable or disable XML header elements and specify the correct values for each XML element. Checks are performed to ensure that the XML content is valid.

Note: To add XML headers to calls in IBM® Security AppScan®, add a Static XML Headers algorithm on the Request Stack tab of the request.

This view provides a hierarchical view of the XML structure of the message, including elements, namespaces, and the associated values. You can use Add, Insert, Remove, Up, and Down to edit the XML elements and namespaces in the tree.

Use Skip if Empty column to select the empty XML elements that you want to skip. This column is visible only if you selected the Display the 'Skip if Empty' column in XML tree viewer check box in Window > Preferences > Test > Test editor > Service test.

Click Filter to hide or show namespace, attribute, or text nodes, depending on your requirements.

Click Allow only valid modifications to enable smart editing, based on a specified XML schema document (XSD). To specify a set of XSD documents for the workbench, in the test navigator, right-click the project and select Properties and Schema Catalog. Disable Allow only valid modifications if you do not have an XSD or if you want to bypass the schema.

You can right-click an XML element to convert it to an XML fragment. This enables you to perform data correlation (use datasets and create references) on the entire XML fragment instead of only on the value.

This view displays the source XML content of the message or plain text content. To format XML content, click Format XML text. To wrap XML content into a single line, click Pack XML text to single line. Similar controls are available for JSON content.
Important: In the Source view, do not edit the tags that start with SoaTag. If you delete or change these tags, any references and substitutions in the test will be broken. You cannot recreate these tags after you delete them.


This page lists the MIME or DIME attachments that are attached to the request. The contents of this view conform to the Multipurpose Internet Mail Extensions (MIME) or Direct Internet Message Encapsulation (DIME) specification. You can use this page to add workbench resources as MIME or DIME attachments and change properties.

The Content ID is the identifier that the request uses to refer to the attachments. The method for using this identifier depends on your server requirements.
Select whether the attachment conforms to the Multipurpose Internet Mail Extensions (MIME) or Direct Internet Message Encapsulation (DIME) specification
Use MTOM transmission mechanism
By default, the request uses SOAP Messages with Attachments (SwA) to handle attachments. Select this option to handle attachments with the SOAP Message Transmission Optimization Mechanism (MTOM).

Response Properties

This page lists the names and values of properties of the response.