...
...
...
...
...
Form: HTTP Collector Details
The form provides the standard form icons
Configure the following fields to set up an HTTP Collector:
...
Excerpt |
---|
Select one of the following HTTP methods to use for the request:
We recommend that you selecte a method but if you do not, PhixFlow uses GET or POST by default. If the Send Message → Statement Expression:
For information, see the w3schools page about HTTP methods. |
...
Send Message
Define details of the HTTP request sent to the HTTP Datasource to get the data required.
...
The URL to be used, without the leading http:// prefix. The URL may contain embedded expressions within { }. If this field is blank, the url field on the httpDatasourceInstance is used directly.
For Example, this expression adds to the base url provided by the HTTP Datasource Instance :
{_url}/sub1/sub2?param1=3
...
<?xml version ="1.0"?> <!DOCTYPE CORPORATE DASHBOARD "corpDash.dtd"> <results user="%USERNAME%" password="%PASSWORD%"> <monthlyTotals region={'"' + Region + '"'} division={'"' + Division + '"'}> <totalBilled>{'"' + TotalBilled + '"'}<\totalBilled> <totalCollected>{'"' + TotalCollected + '"'}<\totalCollected> <monthlyTotals> <\results>
The username and password for the HTTP Datasource Instance are available as %USERNAME% and %PASSWORD%.
The data will be encoded using the charset parameter specified by the Content-Type Header if one is present. If no Content-Type Header is set then ISO-8859-1 will be used. If the Content-Type header is set, but does not specify a charset then PhixFlow will use a default character set dependant on the content type.
...
HTTP Headers
For an HTTP request, define name value pairs to include as part of the HTTP header. (e.g. content-type)
...
Name of the HTTP Collector HTTP Header Item. You must not include a colon after the name. For example, Content-Type is a valid name, whereas Content-Type: is not. For example:
Code Block |
---|
Content-Type |
...
Value of the HTTP Collector HTTP Header Item. For example:
Code Block |
---|
text/xml; charset=UTF-8 |
...
Response
Define the data response type/format that will be returned:
- HTML: response type allows an XPath Expression to be specified in order to retrieve just specified sections of the data into XML structures.
- XML: response type allows an XPath Expression to be specified in order to retrieve just specified sections of the data into XML structures. XML response types also support XML namespaces. The Xml Namspaces tab will be available when this response type is chosen.
- String: response type will return the full data as a string value.
Please see Response Examples for how the returned data can be used and evaluated in the corresponding stream attribute expressions.
...
Xml Namespaces
The namespaces defined in an XML response. The names given to these namespaces must match those used in any Xpath expressions used to extract data from an XML response. See examples below.
...
Name of the XML namespace. By convention, it is recommended that you use the name used in the XML response. E.g. if the XML response contains xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" then make this soapenv.
However, this is not mandatory - you can give any namespace any name - all that matters is that the names defined here match those you use in XPath expressions to extract data from the XML response.
In particular, default namespaces, e.g. xmlns="urn:xmlns:company-com:message" can be given any name, providing that you use this name in XPath expressions.
See HTTP Collectors for examples of using namespaces in XPath expressions to extract data from XML responses.
For example:
Code Block |
---|
soapenv |
...
Value of the XML namespace. For example:
Code Block |
---|
http://schemas.xmlsoap.org/soap/envelope/ |
...
Stream Values in a HTTP Collector
To drive the lookups made by a HTTP Collector from a stream, the two must be connected using a lookup pipe. For example - If a URL for a server is captured, or calculated, on a stream in an attribute called "ServerURL" and passed to the HTTP Collector to be used in its URL Expression, the pipe connecting the two must be a lookup pipe. If the pipe is called "in", here is how the URL Expression would be written on the HTTP Collector: {substring(in.ServerUrl,9)}
...
XML Data <?xml version ="1.0"?> <root xmlns:h="http://www.w3.org/TR/html4/"> <main page="PF Main Page" > <h:title h:name="PF Title">PF Title Text <h:datarow> <h:data h:initials="AD">Ali Dawson</h:data> <h:data h:initials="GP">Gary Parden</h:data> </h:datarow> </h:title> <title name="Non namespace Title">Non namespace Title Text</title> </main> </root>
HTML Data <html> <body nodename="Html Body"> <table> <tbody> <tr> <td initials="AD">Ali Dawson</td> <td initials="GP">Gary Parden</td> </tr> </tbody> </table> </body> </html>
The following table shows the different types of responses that can be returned from an HTTP Collector and how these can be used in the corresponding stream attribute expressions. A HTTP Collector response type of XML/HTML will mimic the responses from XML/HTML Collectors respectively.
...
Note that the namspace prefix used here 'h' must be configured in the HTTP XML Namspaces form
...
<root xmlns:h="http://www.w3.org/TR/html4/"> <main page="PF Main Page" > <h:title h:name="PF Title">PF Title Text <h:datarow> <h:data h:initials="AD">Ali Dawson</h:data> <h:data h:initials="GP">Gary Parden</h:data> </h:datarow> </h:title> </main> </root>
...
Insert excerpt | ||||||||
---|---|---|---|---|---|---|---|---|
|
...
...
...
...
...
Note the use of a $ instead of our usual : namespace notation.
Note the use of a ^ to traverse to the immediate parent element.
...
...
...
...
...
...
...
...
...
...
Note the use of a ^ to traverse to the immediate parent element.
Note the use of the listToString function to handle multiple matching child elements/attributes.
Note the use of the optional html <tbody> tags. If these are not in your html data, then phixflow will insert them to conform with the HTML standards. Therefore when using absolute XPath expressions, note that the tbody tags need to be included even if they are not present in the incoming HTML data.
i.e /html/title/table/tr should be replaced with /html/title/table/tbody/tr. Alternativley you can use //tr
The same applies when referencing parent/child nodes within the stream attribute expressions.
...
The following example illustrates how a default namespace defined in an XML response is handled.
<?xml version="1.0" encoding="UTF-8"?> <soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns="urn:xmlns:company-com:message" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:pf="urn:phixflow.message.com"> <soapenv:Body> <queryResponse> <result xsi:type="QueryResult"> <done>true</done> <queryLocator xsi:nil="true"/> <record xsi:type="pf:sObject"> <pf:type>Account</pf:type> <pf:Name>Company1</pf:Name> <pf:CreatedDate>2013-10-31T11:26:21.000Z</pf:CreatedDate> </record> <record xsi:type="pf:sObject"> <pf:type>Account</pf:type> <pf:Name>Company2</pf:Name> <pf:CreatedDate>2013-10-31T11:26:21.000Z</pf:CreatedDate> </record> <size>2</size> </result> </queryResponse> </soapenv:Body> </soapenv:Envelope>
Since this document uses a default namespace ("urn:xmlns:company-com:message"), to refer to any element in an XPath expression that does not explicitly use a namespace you must use the default namespace. So to extract all record elements, you must first define a namespace in the collector for the default namespace. Suppose that you do and give this the name def. Then the XPath (defined in the XPath field on the Response tab) to extract all record elements will be //def:record
In a Stream that reads from this collector, any other namespaces defined in the document are used as normal. For example, to write the value from the element Name within each record element to a Stream attribute, you would use the attribute expression in.sf$Name
See Also
...
Given the following XML and HTML data that is being pointed to by either HTTP datasources or XML/HTML File collectors respectively.