GetData for Web Services Settings

balecomputerSecurity

Nov 3, 2013 (3 years and 5 months ago)

60 views

Onset Technology

GetData for Web Services


Settings
11/4/2013

1

of
8



GetData for Web Services


Settings

This document describes form parameters accessible via the GetData for Web Services Flow
Properties dialog
Settings…

button.

For instructions on how to configure GetData flow source, sending, and alert protocols, ref
er to
Chapter 8 of the METAmessage for Wireless Administrator’s Guide, “Configure a GetData
Flow.”

For instructions how to design and distribute forms, refer to Chapter 9 of the METAmessage for
Wireless Administrator’s Guide, “Design and Distribute GetDat
a Forms.”



To access GetData form parameters, click
Settings…

in the Flow Properties dialog.

Onset Technology

GetData for Web Services


Settings
11/4/2013

2

of
8

The Web Services Dialog

Click
Settings…

in the GetData Flow Properties dialog to open the Web services tabbed dialog.
This dialog identifies all Web service acc
ess parameters.

WSDL Tab

This tab lets you take advantage of an existing WSDL resource for the Web service.

If a WSDL resource exists for the Web service you intend to access, it is highly recommended to
enter the resource on this tab and have it analyzed
. Once you have entered a valid WSDL
resource, you may fill in most of the fields on each subsequent tab by simply clicking the star
button at the bottom of each tab.

If a WSDL resource does not exist, or you prefer not to take advantage of one, this tab s
hould be
skipped and fields on subsequent tabs can be filled in manually.




WDSL (file or URL)


The WSDL resource which describes the Web service to be accessed by
GetData.

Analyze WSDL



Press this button to analyze the WSDL resource and make its cont
ents
available for the fields on the subsequent tabs.

Services


A list of services documented in the WSDL resource.

Operations


A list of operations supported by the selected service.

Profile


Additional information about the selected service and select
ed operation.

Onset Technology

GetData for Web Services


Settings
11/4/2013

3

of
8

Location Tab

This tab describes the location of the Web service and how it should be accessed.



If you have entered a valid WDSL on the first tab, you may fill in most of the fields on this tab by
simply clicking the star button at the bot
tom of the tab.

Transport


Specifies the transport mechanism used to access the service (for example, HTTP).

Host


Specifies the name of the machine hosting the service (for example,
www.somemachine.com).

Target


Specifies the target resource providing
the service (for example, /something/else).

Port


Specifies the HTTP port used to access the service (for example, 80).

Verb


Specifies the HTTP verb used to access the service (for example, GET or POST).

Version



Specifies the HTTP version used to acce
ss the service (for example, HTTP/1.1).

Onset Technology

GetData for Web Services


Settings
11/4/2013

4

of
8

Forms Tab

This tab describes specific information per form. The sub
-
tabs (Input, Output, Format, and Test)
refer to the form selected at the left.

You can enter a new form by double
-
clicking on the [new form] item i
n the list of forms.

Forms Tab


Input

This sub
-
tab describes how input should be supplied to the Web service.



Target extension


(Optional) Specifies any required extension to the target specified on the
location tab. This field is normally required wh
en the HTTP verb is GET. Input variables can be
embedded in this extension by embedding variable names preceded by “%%”.

Headers


(Optional) Specifies any non
-
standard HTTP headers which need to be supplied to
the service. Input variables can be embedded
in these headers by embedding variable names
preceded by “%%”.

Body


(Optional) Specifies any data which the service requires as part of the HTTP body. This
field is normally required when the HTTP verb is POST. Input variables can be embedded in this
bod
y by embedding variable names preceded by “%%”.

Body is XML


Indicates whether the body is XML.

Onset Technology

GetData for Web Services


Settings
11/4/2013

5

of
8

Forms Tab


Output

This sub
-
tab describes how output should be extracted from the service response.



Record XPath

(Optional) This field is used to extract
a a collection of records from the service
response. It is an XPath expression which evaluates to the XML node
-
set containing the records.

Fields


A list of fields. Each field has a name and an XPath expression. If Record XPath was
used above, each XPath
expression here identifies a specific field relative to a record element. If
Record XPath was not used, each XPath expression identifies data relative to the entire service
response.

Namespaces



(Optional) If the service response makes use of namespaces,
then the XPath
expressions above must use namespace prefixes to correctly refer to XML elements. Any prefix
used in the above XPath expressions must be defined here with its associated URI.

Onset Technology

GetData for Web Services


Settings
11/4/2013

6

of
8

Forms Tab


Format

This sub
-
tab describes how the output should b
e formatted for display on the device.



Title


(Optional) Specifies a title to display together with the results.

Form name


(Optional) Specifies the name of an output form to be used to display results.

Message



(Optional) Specifies a message to disp
lay on the device. When Record XPath is not
used, this is the only means to display results on the device. Fields can be embedded in this
message by embedding field names preceded by “%%”.

Onset Technology

GetData for Web Services


Settings
11/4/2013

7

of
8

Forms Tab


Test

This sub
-
tab allows you test the settings.



Inp
ut fields


A list of input variables. Each variable should be assigned a value to be used in the
test.

Invoke Web Service

Press this button to invoke the Web service.

Output

Displays the results. This will either be a list of records or a message with e
mbedded
fields.

Reset Input Fields

Reverts to the default values assigned to the input variables.

View Log

Displays the log to aid in diagnosing errors.

View Dump


Displays additional data to aid in diagnosing errors.

Onset Technology

GetData for Web Services


Settings
11/4/2013

8

of
8

XML Tab

This is an advanced tab wh
ich under normal circumstances should not be edited manually. For
more information, contact Onset technical support.