Forms: HTTP Exporter

An HTTP Exporter exports data held in a Stream to a HTTP Datasource.

For an overview of how HTTP Exporters can be used when creating models, see Exporting Data to HTTP.

Form: HTTP Exporter Details

The HTTP Exporter form contains a number of tabs:

Field	Description
Details	The main details required for HTTP Exporter configuration.
Send Message	Define details of the data that will be sent to the HTTP Datasource.
HTTP Headers	Details of each HTTP Header defined for this exporter is configured in an HTTP Header form.
Response	Define how the responses from the HTTP Datasource will be handled.
Advanced	Advanced settings for HTTP Exporters.
Description	A free text field for a description of the HTTP Exporter.

Form Icons

The form provides the standard form icons.

...

The following fields are configured on the Details tab:

Field	Description
Name	Name of the HTTP Exporter.
HTTP Data Source	The HTTP Datasource that this exporter will send data to.
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. 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.
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). 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.
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. 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.
Enabled	Tick when the configuration is complete and the HTTP Exporter is ready to be used.

...

The following fields are configured on the Send Message tab:

...

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 :

...

Insert excerpt

	_Banners
	_Banners
name	analysis
nopanel	true

This page is for data modellers who want to export data via HTTP.

Overview

An HTTP exporter outputs table data via a HTTP Datasource to an external web site or service, via HTTP.

To add a new HTTP exporter to an analysis model:

Go to the model's toolbar → Create group.
Click
Insert excerpt
_http
_http
nopanel true
to expand the menu.
Drag a
Insert excerpt
_http_exporter
_http_exporter
nopanel true
onto the analysis model.

To add an existing HTTP exporter to an analysis model, in the model diagram toolbar:

Go to the model toolbar → List group.
Click
Insert excerpt
_http
_http
nopanel true
to expand the menu.
Click
Insert excerpt
_http_exporter
_http_exporter
nopanel true
to open the list of available exporters.
Drag an HTTP exporter into the analysis model.

Insert excerpt

	_http_newlines
	_http_newlines
nopanel	true

Insert excerpt

	_property_toolbar
	_property_toolbar
nopanel	true

Insert excerpt
_property_tabs
_property_tabs
name basic-h
nopanel true

Insert excerpt

	_parent
	_parent
nopanel	true

Basic Settings

Field

Description

Name

Name of the HTTP Exporter.

Enabled

Insert excerpt

	_check_box_tick
	_check_box_tick
nopanel	true

when the configuration is complete and the HTTP exporter is ready to be used.

Send Message

Define details of the data that will be sent to the HTTP Datasource.

Field

Description

HTTP Request Method

Insert excerpt

	HTTP Collector
	HTTP Collector
nopanel	true

URL Expression

Insert excerpt

	_url_expression
	_url_expression
nopanel	true

Statement Expression

An expression to generate the data that will be sent by the exporter to the datasource.

...

Insert excerpt

	_expression_lang
	_expression_lang
nopanel	true

Code Block

&lt?xml version ="1.0"?&gt &lt!DOCTYPE CORPORATE DASHBOARD 
"corpDash.dtd"&gt &ltresults user="%USERNAME%" 
password="%PASSWORD%"&gt &ltmonthlyTotals region={'"' + Region +
 '"'} division={'"' + Division + '"'}&gt 
&lttotalBilled&gt{'"' + TotalBilled + 
'"'}&lt\totalBilled&gt &lttotalCollected&gt{'"' + 
TotalCollected + '"'}&lt\totalCollected&gt 
&ltmonthlyTotals&gt &lt\results&gt

...

Note : internal variables are referenced via %USERNAME% %PASSWORD% syntax.

Expressions are enclosed in {}

...

The following fields are configured on the Response tab:

...

countElements($errors = xmlToItems(_response,"//ERROR")) == 0

...

Insert excerpt

	_secret
	_secret
nopanel	true

HTTP Headers

The grid contains a list of the HTTP headers defined for this exporter. To add a HTTP header to the list, click

Insert excerpt

	_new
	_new
nopanel	true

. PhixFlow opens a new HTTP Header properties. To remove a HTTP header, use the

Insert excerpt

	_delete
	_delete
nopanel	true

in the toolbar.

Response

Define how the responses from the HTTP Datasource will be handled if the the connection is either successful or fails.

Field

Description

Connected successfully

Record Export Time

Optionally, in the drop-down list, select an attribute from the input table.

When the exporter writes a record to the target HTTP location, the selected attribute in the input record is updated with the export time.

If a record in the input table is not exported, the selected attribute is left blank.

If a record is exported but the export is rolled back, the attribute will be updated by the export, then rolled back to a blank record.

Warning
If a record fails to export, the attribute is updated and remains updated even if the export transaction in the target HTTP datasource is rolled back.

Record Export Status

Optionally, in the drop-down list, select an attribute from the input table.

When the exporter writes a record to the target HTTP location, the selected attribute in the input record is updated with the value from the Status expression.

Record Response

Optionally, in the drop-down list, select an attribute from the input table.

When the exporter writes a record to the target HTTP location, the selected attribute in the input record is updated with any export messages from:

either Value to record on success
or Value to record on failure

Status

Enter an expression to report a status. For example:

Code Block
if(_success, _response, listToString($errors._MSGTEXT))

...

_error

...

The following fields are configured on the Advanced tab:

...

Multipliers

Field

Description

Input Multiplier

Enter an expression that multiplies the data. This works in the same way as the Input Multiplier Expressions on tables and File Exporters. A complete export is carried out for each value in the list of values returned by this expression. If the expression evaluates to an empty list, then no export will be carried out. If no expression is set, a single export will be carried out.

See Expressions and PhixScripts.

Advanced

Field

Description

Datasource

The HTTP Datasource that this exporter will send data to.

Datasource Instance Expression

The target datasource for this exporter may list multiple HTTP Datasource instances.
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.

Exporter Icon

Enter the path for an image file that has been uploaded to the PhixFlow database. PhixFlow displays this icon in controls when the HTTP exporter is used.

Insert excerpt

	HTTP Collector
	HTTP Collector
name	icon
nopanel	true

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.

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.
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.

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.
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.

...

Log Traffic

When system logging → Log Database Exporter Statements is ticked, PhixFlow always logs details of connections made by database exporters, whatever is set here; see System Logging Configuration

Insert excerpt

	_log_traffic1
	_log_traffic1
nopanel	true

Commit Size

If you set Response options, the HTTP exporter is writing data into a PhixFlow table. Specify the number of records in a batch that the HTTP exporter writes to the database before committing changes.

Insert excerpt

	_model_prop
	_model_prop
nopanel	true

Insert excerpt

	_description
	_description
nopanel	true

Insert excerpt

	_audit
	_audit
nopanel	true

Live Search
spaceKey @self
additional none
placeholder Search all help pages
type page

Panel

borderColor	#00374F
titleColor	white
titleBGColor	#00374F
borderStyle	solid
title	Sections on this page

Table of Contents

maxLevel	3
indent	12px
style	none

Learn More

For links to all pages in this topic, see Analysis Models

Version	Old Version 2	New Version Current
Changes made by	Chris Welford	Zoe Baldwin
Saved on	Oct 08, 2015	Aug 12, 2024

Versions Compared

Key

Forms: HTTP Exporter

Form: HTTP Exporter Details

Form Icons

Overview

Insert excerpt
_property_tabs
_property_tabs
name basic-h
nopanel true

Basic Settings

Send Message

HTTP Headers

Response

See Also

Multipliers

Advanced

Live Search
spaceKey @self
additional none
placeholder Search all help pages
type page

Page Comparison

Versions Compared

Key

Forms: HTTP Exporter

Form: HTTP Exporter Details

Form Icons

Overview

Insert excerpt_property_tabs_property_tabsnamebasic-hnopaneltrue

Basic Settings

Send Message

HTTP Headers

Response

See Also

Multipliers

Advanced

Live SearchspaceKey@selfadditionalnoneplaceholderSearch all help pagestypepage

Insert excerpt
_property_tabs
_property_tabs
name basic-h
nopanel true

Live Search
spaceKey @self
additional none
placeholder Search all help pages
type page