phoSoapClientHelper - cClientWebService

Provides a mechanism for connecting any Web Service to a test view

Type: Property
Access: Read/Write
Data Type: Handle
Parameters: None

Syntax

Property Handle phoSoapClientHelper

Access Type	Syntax
Read Access:	Get phoSoapClientHelper to HandleVariable
Write Access:	Set phoSoapClientHelper to HandleVariable/Value

Description

A special soap client helper view can be used to allow you to see what is happening with a soap request. This helper displays a view that shows you the soap request, the soap response, the transfer (error) status, parameters, the return value and more. This purpose of this view is two-fold - it helps you debug soap client calls and it provides a great way to learn about web-services.

To use this client hlper you must set phoSoapClientHelper to point to this view. Once you've done this, the view will be invoked after an web-service call. Note that until a call is made, you will not see this view.

It is not expected that you would ever use this in a deployed application.

Adding the Helper View to Your Test Component

When a web-client object is created in your view, comment code in this object will provide all of the information needed to use this helper object.

// phoSoapClientHelper
//     Setting this property will pop up a view that provides information
//     about the Soap (xml) data transfer. This can be useful in debugging.
//     If you use this you must make sure you USE the test view at the top
//     of your program/view by adding:   Use WebClientHelper.vw // oClientWSHelper
//Set phoSoapClientHelper to oClientWSHelper

To use this helper you need to:

1. Copy the code: "Use WebClientHelper.vw" and paste it in the top of your component source code.

2. Uncomment the line: Set phoSoapClientHelper to oClientWSHelper

When you do this, every web-service request to this client will cause a helper view to be activated showing you what is happening.

To disable this helper view, add the comment or set phoSoapClientHelper to 0.