Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

Insert excerpt
_Banners
_Banners
nameanalysis
nopaneltrue


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

Overview

An HTTP datasource is a modelling object whose properties provide the information needed to connect to an external source of data via HTTP. This may be a web site, a web service or some other target that allows XML, HTTP or text data to transferred over HTTP.

You must have one HTTP datasource for each HTTP location to which you need to connect. Each HTTP datasource must have at least one HTTP datasource instance. You can add several instances if you want to configure different settings.

In an analysis model, you can add:

The HTPP datasources you create appear in the Basic Settings → HTTP Datasource list in HTTP collector and HTTP exporter properties. In the properties for collectors and exporters, you can optionally specify the HTTP datasource instance using the Advanced → Datasource Instance Expression.

To add a new HTTP datasource to an analysis model:

  1. Go to the model's toolbar → Create group.
  2. Click
    Insert excerpt
    _http
    _http
    nopaneltrue
     to expand the menu.
  3. Drag a 
    Insert excerpt
    _http_datasource
    _http_datasource
    nopaneltrue
     onto the analysis model.

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

  1. Go to the model toolbar → List group.
  2. Click
    Insert excerpt
    _http
    _http
    nopaneltrue
     to expand the menu.
  3. Click 
    Insert excerpt
    _http_datasource
    _http_datasource
    nopaneltrue
     to open the list of available HTTP datasources.
  4. Drag a HTTP datasource into the analysis model.

Insert excerpt
_property_toolbar
_property_toolbar
nopaneltrue

HTTP Datasource 
Insert excerpt
_property_tabs
_property_tabs
namebasic-h
nopaneltrue

Insert excerpt
_parent
_parent
nopaneltrue

Basic Settings

FieldDescription
NameEnter the name of the HTTP Datasource.
Enabled
Insert excerpt
_check_box_tick
_check_box_tick
nopaneltrue
 when the configuration is complete and the HTTP datasource is ready to be used.
Protect During Import

Insert excerpt
_check_box_untick
_check_box_untick
nopaneltrue
 to allow this HTTP datasource to be updated or deleted by during import.

Insert excerpt
_check_box_tick
_check_box_tick
nopaneltrue
 to retain these property settings if this HTTP datasource is imported from another PhixFlow instance.

Expand
titleMore ...

Insert excerpt
_protect_import
_protect_import
nopaneltrue


Connection TypeSelect:
  • http: the data will be transferred using standard HTTP (not encrypted).
  • https: the data will be transferred using HTTPS, a secure form of HTTP (encrypted).
The following properties are available when Connection Type is https
Check Certificate

Insert excerpt
_check_box_tick
_check_box_tick
nopaneltrue
 to validate the web site's security certificate.

This will check that the web site's certificate matches the web site address, is signed by a valid certification authority, and has not expired.

SSL Protocol


Warning

If you are not familiar with SSL Protocol settings, leave this field blank.

The SSL Protocol selects a list of actual protocols that are supported, and enables a sub-set of that list.

If this field is blank, PhixFlow will select a default value which will work in almost all cases.

Valid settings depend on the version of Java that PhixFlow is running under.

These are the allowed values for Oracle's Java 8: TLS, TLSv1, TLSv1.1, TLSv1.2

SSL Protocols Enabled


Warning

If you are not familiar with SSL Protocol settings, leave this field blank.

This field specifies the SSL Protocols that should be enabled (as a comma-separated list).

E.g. SSLv3,TLSv1,TLSv1.1,TLSv1.2

If this field is blank, the SSL Protocol (above) determines the Protocols that are enabled.

Datasource Instance Details

This section has a toolbar with standard buttons/wiki/spaces/HELP12/pages/9615612941.

The grid contains a list of HTTP datasource instances that belong to this HTTP datasource. Each datasource defines the connection details to an HTTP target. A number of instances can be defined to allow for several connections under a single HTTP datasource. You must define at least one HTTP datasource Instance for each HTTP datasource.

Double-click on a row to open the HTTP datasource instance properties. 

To add a HTTP datasource to the list, click

Insert excerpt
_new
_new
nopaneltrue
 . PhixFlow opens the properties for a new datasources instance; see HTTP Datasource Instance Properties, below.

To remove a datasource instance from the grid, use the toolbar button 

Insert excerpt
_delete
_delete
nopaneltrue

Secret Key Details

This section has a toolbar with standard buttons/wiki/spaces/HELP12/pages/9615612941.

The grid contains a list of the secret keys available to this datasource. A secret key is a way to securely store datasource authentication values; see Secret Key and Local Secret /wiki/spaces/HELP12/pages/9615611519. To use the secure values in HTTP collector or exporter expressions, refer to the secret key using:

_datasource.name

where name is the secret key name listed in this grid.

Rate Limiting

Insert excerpt
HTTP Configuration
HTTP Configuration
nameRateLimitingDesc
nopaneltrue

For /wiki/spaces/HELP12/pages/9615615875s this is per request and for /wiki/spaces/HELP12/pages/9615616020s this is per batch defined by its Commit Size setting

Insert excerpt
HTTP Configuration
HTTP Configuration
nameRateLimiting
nopaneltrue

Advanced

FieldDescription
Internal IDRead-only. PhixFlow displays the identifier for this datasource. The PhixFlow support team may ask for this identifier during troubleshooting.
Timeout (s)Sets the timeout for any HTTP Collectors and HTTP Exporters using the HTTP Datasource. This value overrides the default 180 second timeout for the connection timeout, request timeout and socket timeout.

Insert excerpt
_model_prop
_model_prop
nopaneltrue

Insert excerpt
_description
_description
nopaneltrue

Insert excerpt
_audit
_audit
nopaneltrue

HTTP Datasource Instance
Insert excerpt
_property_tabs
_property_tabs
namebasic-h
nopaneltrue
 
Anchor
instance
instance

Insert excerpt
_parent
_parent
nopaneltrue

Basic Settings

In addition to the standard icons, the properties toolbar includes 

Insert excerpt
_datasource_show_tables
_datasource_show_tables
nopaneltrue
, which opens a list of tables visible for this datasource using the default login details; see the Table Details /wiki/spaces/HELP12/pages/9615615852 window.

FieldDescription
NameEnter the name of the HTTP datasource instance. This must be unique, although one instance may be named "Default". Typically, if a datasource has only one instance then it usually named "Default".
Enabled

Insert excerpt
_check_box_tick
_check_box_tick
nopaneltrue
 when the configuration is complete and the HTTP datasource instance is ready to be used.

UsernameEnter a username for an account that can access the HTTP datasource instance.
PasswordEnter the password  for an account that can access the HTTP datasource instance.
URL

URL of the HTTP target for this instance, without the leading http:// prefix. E.g. rss.slashdot.org/Slashdot/slashdot

This field is made available as the _url internal variable in the Collector or Exporter Url Expression.

Insert excerpt
_description
_description
nopaneltrue


Live Search
spaceKey@self
additionalnone
placeholderSearch all help pages
typepage

Panel
borderColor#00374F
titleColorwhite
titleBGColor#00374F
borderStylesolid
titleSections on this page

Table of Contents
maxLevel3
indent12px
stylenone

Learn More

Exporting Data from an Analysis Model/wiki/spaces/HELP12/pages/9615618242

For links to all pages in this topic, see Analysis Models/wiki/spaces/HELP12/pages/9615607957