An HTTP Collector reads data from a HTTP Datasource. The collector defines how the data needed from the datasource will be extracted to be used in PhixFlow.
...
| Field | Description | ||
|---|---|---|---|
| Name | Name of the HTTP Collector. | ||
| Enabled | Tick when the configuration is complete and the collector is ready to be used. | ||
| HTTP Data Source | The HTTP datasource that this collector will collect from. | ||
| HTTP Request Method | The HTTP method to use for the request. 'GET or POST' means the request will be a GET if the Statement Expression evaluates to null or empty string, or a POST if the statement is not empty. It is recommended that the correct method is explicitly selected. | ||
| Icon | The Icon to display in controls when this collector is used. | ||
| Timeout (secs) | The number of seconds to wait for a response from the corresponding HTTP datasource before a timeout is recorded. | ||
| Allow Non-Scheduled Collection | If this is turned on, then the collector will run as part of any ad-hoc Analysis Engine run which requires this data. If not, it will only run as part of a scheduled Task Plan under the Analysis Engine. | ||
| Datasource Instance Expression | The datasource to which this collector is connected may list multiple instances from which the data may be accessed. Each HTTP Datasource Instance is identified by a unique string. This expression should evaluate to a string which allows the collector to determine the specific instance to use. If the expression is blank then the collector will assume that there is only one instance and will use that one by default. If there is more than one instance and no expression is provided here then an error will be thrown during analysis since the collector will be unable to determine which source to use. | ||
Send Message Define details of the HTTP request sent to the HTTP Datasource to get the data required. | |||
| URL Expression | 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 | ||
| Statement Expression | An expression to generate the data that will be sent by the exporter to the datasource. For Example <?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 | 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:
| ||
| Value | Value of the HTTP Collector HTTP Header Item. For example:
| ||
| Description | Optional: a description of the header line. | ||
Response Define the data response type/format that will be returned:
Please see Response Examples for how the returned data can be used and evaluated in the corresponding stream attribute expressions. | |||
| Response Type | The type of the expected response : XML/HTTP/String | ||
| XPath | The XPath expression used to resolve or filter the data that comes back in XML or HTML format. Note that Xpath namespaces syntax can only be used for XML response types. | ||
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 | 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:
| ||
| Value | Value of the XML namespace. For example:
| ||
| Description | |||
| Description | A free-form description of the HTTP collector. | ||
...