Specific fields for SOAP attributes

Figure 191. Attribute Information page
SOAP Attribute Information window with XPath query as the Attribute Type

In the Attribute information window Figure 191, there are two fields for SOAP attributes that define how data is collected from the SOAP response. The Attribute Type field can be any value from a list that controls the information about the response that is returned. Some attribute types require a value in the Type Value field. The default attribute type is XPath Query, which runs an XPath query against the SOAP server response content. The type value is the XPath query that is run. The following table describes all of the attribute types and the type value when one is required:

Table 22. SOAP Attribute Information
Attribute type Description Type value Data type returned Differences with FTP and file protocols
XPath Query Runs an XPath query on the content returned from a URL connection. The query must be written to return data useful for an attribute, not a list of nodes. The XPath query to run against the content obtained from a URL connection. If a row selection query was defined, this XPath query should be relative to the row selection query. The data returned can be a string, a numeric, or a timestamp value. The Agent Builder browser for SOAP generally detects the correct data type for the attribute from the data being browsed. If the data is in the XML DateTime format, you can specify timestamp as the attribute type and the agent converts the value to a Candle Timestamp. None
Response Time The amount of time in milliseconds that it took to download the content from the requested URL. None Integer (number of milliseconds) None
Response Message The HTTP response message that is returned by the server. None String The response message applies only if the URL uses the HTTP or HTTPS protocols.
Response Code The HTTP response code that is returned by the server. None Integer The response code applies only if the URL uses the HTTP or HTTPS protocols. It is always 0 for file or FTP URLs.
Response Length The size of the content in bytes that was downloaded from the requested URL None Integer (size in bytes) None
Response Header The response header can be used to retrieve a value from one of the URL response header fields. The argument specifies which field is requested. The response header field to collect. String Generally FTP and file protocols do not have any headers that can be collected.
Request URL The connection was made to this URL. All of the response keywords provide information about the connection to this URL. The XPath Query can be used to obtain information obtained from the content returned by accessing this URL. None String None