PhixFlow Help
HTTP Exporter
Basic Settings
Field | Description |
|---|---|
Name | Name of the HTTP Exporter. |
Enabled | Tick when the configuration is complete and the HTTP Exporter is ready to be used. |
Datasource | The HTTP Datasource that this exporter will send data to. |
HTTP Request Method | |
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>Note : internal variables are referenced via %USERNAME% %PASSWORD% syntax. Expressions are enclosed in {} The statement 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. |
Send Message
Define details of the data that will be sent to the HTTP Datasource.
Field | Description |
|---|---|
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 |
HTTP Headers
This section has a toolbar with standard buttons. The grid contains a list of the HTTP headers defined for this exporter. To add a HTTP header to the list, click
Response
Define how the responses from the HTTP Datasource will be handled if the the connection is either successful or fails.
Field | Description |
|---|---|
Result to record on the Stream | Expression to evaluate the value to put on the stream. For example: if(_success, _response, listToString($errors._MSGTEXT)) |
Check if the response indicates successful export | Expression to evaluate the response from the HTTP datasource, where a connection was made. For example: countElements($errors = xmlToItems(_response,"//ERROR")) == 0 |
Result to record on the Stream after a connection failure | Value to put on the Stream in the event that the HTTP connection attempt failed. For example: _error |
Inputs
This section has a list of the HTTP Headers defined for this exporter.
Advanced
Field | Description |
|---|---|
Record Export Time | If required, select an attribute from the input Stream from the drop down list. If an attribute is selected, when the exporter writes a message to the target location (HTTP datasource) the selected attribute in the input record will be updated with the export time. |
Record Export Status | If required, select an attribute from the input Stream from the drop down list. If an attribute is selected, when the exporter writes a record to the target location (HTTP datasource) the selected attribute in the input record will be updated with the export status (success or fail). |
Record Response | If required, select an attribute from the input Stream from the drop down list. If an attribute is selected, when the exporter writes a record to the target location (HTTP datasource) the selected attribute in the input record will be updated with any export error messages. |
Parallel Exporters | If required, you can specify that the exporter should use a number of parallel exporters. Each buffer of records read from the input pipe will be divided across the parallel exporters. The restriction applied to this is that if Group By fields are specified in the input Pipe to the exporter, all records with the same Group By key will be exported by the same exporter. If no value is specified here then only a single exporter will be used. |
Errors Before Rollback | If required, you can set the maximum number of errors found, while exporting across all exporters, before the exporter will rollback all uncommitted transactions from all exporters. Up to this number of errors, any errors reported from the exporter will appear as warnings in the log entries. The export will not be considered failed unless the number of errors is above this threshold. |
Commit Size | Tells the exporter to commit records in batches of the specified size. |
Errors Before Stopping | If required, you can set the maximum number of errors found, while exporting across all exporters, before the exporter will stop attempting to export records to the datasource. |
Timeout (secs) | Tells the exporter to timeout each export operation after a number of seconds. If an export operation does time out, the operation will be abandoned and an error will be reported. Each record that is timed out is considered to be a single error when assessing whether the entire export should be stopped and/or rolled back - see Errors Before Rollback below. If no value is specified, the duration of an export operation is unlimited. |
Icon | Path name for image file. |
Input Multiplier | This expression works in the same way as the Input Multiplier Expressions on Streams and Database Exporters. A complete export is carried out for each value in the list of values returned by the Input Multiplier Expression. If the Input Multiplier Expression evaluates to an empty list then no export will be carried out. If no Input Multiplier Expression is set, a single export will be carried out. |
Datasource Instance Expression | The target datasource for this exporter may list multiple HTTP Datasource instances. |
Log Traffic |
|