An HTTP Exporter exports data held in a Stream to a HTTP Datasource.
Form: HTTP Exporter Details
The form provides the standard form icons.
Configure the following fields to set up an HTTP Exporter:
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 | 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.
| |||||||||||||||||||||||||
Statement Expression | An expression to generate the data that will be sent by the exporter to the datasource. For example:
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. | ||||||||||||||||||||||||||
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:
| |||||||||||||||||||||||||
HTTP HeadersDetails of each HTTP Header This section has a toolbar with standard buttons. The grid contains a list of the HTTP headers defined for this exporter is configured in an HTTP Header form. | Name |
Code Block |
---|
Content-Type |
Value of the HTTP Exporter HTTP Header Item. For example:
Code Block |
---|
text/xml; charset=UTF-8 |
. To add a HTTP header to the list, click
Insert excerpt | ||||||
---|---|---|---|---|---|---|
|
Insert excerpt | ||||||
---|---|---|---|---|---|---|
|
Response
Define how the responses from the HTTP Datasource will be handled.
Expression to evaluate the value to put on the stream. For example:
Code Block |
---|
if(_success, _response, listToString($errors._MSGTEXT)) |
Expression to evaluate the response from the HTTP datasource, where a connection was made. For example:
Code Block |
---|
countElements($errors = xmlToItems(_response,"//ERROR")) == 0 |
Value to put on the Stream in the event that the HTTP connection attempt failed. For example:
Code Block |
---|
_error |
If a record in the input Stream is not exported, this attribute will be left blank.
If a record is exported - but the export is rolled back - the attribute will be updated, and set back to a blank record.
Warning: if a record fails to export then this attribute will still be populated, even in the case that the export transaction in the target HTTP datasource is rolled back.
If a record in the input Stream is not exported, this attribute will be left blank.
The field is populated with result from "Check if the response indicates successful export" from the response tab. If a record is exported - but the export is rolled back - the attribute will be updated, and set back to a blank record.
Warning: if a record fails to export then this attribute will still be populated, even in the case that the export transaction in the target HTTP datasource is rolled back.
If a record in the input Stream is not exported, this attribute will be left blank.
The field is populated with result from "Result to record on the Stream" (and/or "Result to record on the Stream after a connection failure"). If a record is exported - but the export is rolled back - the attribute will be updated, and set back to a blank record.
Warning: if a record fails to export then this attribute will still be populated, even in the case that the export transaction in the target HTTP datasource is rolled back.
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.
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.
If no value is specified, the exporter will never rollback, no matter how many errors are found.
If 1 is specified, a single error will cause a rollback.
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.
This is useful where you have set Errors Before Rollback (also configured on this tab), but wish to continue to try to export records to get view of how successful the remaining export would have been. Any records that the exporter attempts to export after the Errors Before Rollback limit has been passed will always be rolled back, even if they are successful.
If no value is entered, the exporter will stop when the Errors Before Rollback limit is reached.
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.
Each datasource instance is identified by a unique string. This expression should evaluate to a string which allows the HTTP Exporter to determine the instance to use.
If no value is entered then the exporter 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.