Consuming a Web Service (Magic xpi 4.9)
To consume a Web service, follow these steps:
-
Define a Web services client resource in the Settings dialog box's Resource section. For more information, click here.
-
Place the Web Services utility into the main flow area to access the Properties pane.
-
Double-click or right-click on the Web Services utility and select Configuration from the context menu to open the Component Configuration: Web Service dialog box. This dialog box enables you to select and display the SOAP service operations and arguments, and has the following fields:
|
|
|
|
Details
|
|
Resource Name
|
This read-only field displays the name of the previously defined Web service resource that you selected in the Resource Name field's drop-down list in the Properties pane.
|
|
Operation Name
|
This drop-down list contains the operations listed in the service WSDL. Select the required operation from the drop-down list.
|
|
Parameter Details
|
|
Name
|
This read-only field displays the argument names of the operation that you selected from the drop-down list (above).
|
|
Type
|
This read-only field displays the argument types of the operation that you selected from the drop-down list (above).
|
|
XSD Type
|
This read-only field displays the XSD types of the operation that you selected from the drop-down list (above).
|
|
Direction
|
This read-only field displays the argument direction of the operation that you selected from the drop-down list (above).
|
|
XML Schema
|
This read-only field displays the XML schema of the operation that you selected from the drop-down list (above).
|
|
Mapping Variable
|
Click  to open the Variables List. Select a variable to hold the operation's mapped argument.
|
|
Return Details
|
|
Fault
|
Click to assign a variable for the storage of any fault returned by the external service.
|
|
Response BLOB Type
|
To match the response encoding type with the receiving BLOB, you can determine the response BLOB type for each operation.
Select one of the following from the drop-down list:
-
As Received (default)
-
Unicode
-
ANSI
This parameter is available only if the return parameter's Type is BLOB, and its XSD Type is XML Document (above).
|
This dialog box also contains the following buttons:
|
|
|
|
Header
|
This opens the Show Header Information dialog box. Here, you can assign and display the operation's Header_In and Header_Out variables.
Header_Out is used to hold the XML that is sent in the SOAP request header section. Header_In is used to hold the header section from the SOAP response.
The content of the Header property is an XML document with a root element named EDEV_SOAP_HEADERS. This XML document should contain one or more header blocks.
|
|
Attachments
|
This opens the Show Attachment Information dialog box. Here, you can assign and display the operation's attachments, if required.
|
|
Identity
|
When the SOAP service's security level is set to Transport or WS-Security, you can use the Show Identity Information dialog box to authorize your access to the Web service.
|
-
When you have finished creating your Web service, click OK to save the settings and to exit the dialog box. When you do this, the following validation checks are performed:
-
That the resource and operation fields are not empty
-
That a variable is assigned for each argument with an In/Out direction
-
That a variable or an expression is assigned for each argument with an In direction
Alternatively, you can click Cancel to exit the dialog box without saving your settings.
