Versions Compared

Key

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

Insert excerpt
_Banners
_Banners
nameanalysis
nopaneltrue


Fiona-todo: update http collector to add a link to this page

This page is for data modellers who need to provide securely-stored credentials to access data via HTTP.

Overview


When importing data via HTTP, you sometimes need to provide authentication to an external site. In order to provide a username and/or password securely,

Configure a key/value pair using the PhixFlow items:  

  1.   In a HTTP Datasource properties → Secret Key Details, create a secret key.
  2.   Add the value to the local secret. PhixFlow encrypts the local secret.

You can use the secret key name to refer to the encrypted value in the following places:

  • HTTP Datasources → Properties →  Secret Key Details
  • Datasource instances → Username/Password or Username Key/Password Key
  • HTTP Headers Properties → Basic Settings → Value (question)
  • HTTP collectors → URL expression or Statement Expression                                                                                                                                                              

When you run analysisPhixFlow then finds the secure credentials in the keystore and provides them , PhixFlow uses the Secret Key name to find the key, which finds the encrypted secret. It then provides the de-encrypted value to authenticate to the external site.

To create a key/value pair, in an HTTP datasource → Properties → Secret Key Details section, click 

Insert excerpt
_add
_add
nopaneltrue
 to create a new secret key.

Insert excerpt
_property_toolbar
_property_toolbar
nopaneltrue

Secret Key 
Insert excerpt
_property_tabs
_property_tabs
namebasic-h
nopaneltrue

Insert excerpt
_parent
_parent
nopaneltrue

Local Secret

Basic Settings

FieldDescription
KeyRead only. This key will match the key of the Secret Key.
SecretThe secret value that will be available in expressions where the Secret Key name is used.

Basic Settings

FieldDescription
NameEnter a name. You will use NameEnter a name.  
Insert excerpt
_save
_save
nopaneltrue
 the properties. Use this name in expressions to refer to this key.
KeyRead-only. When you save the secret key, PhixFlow automatically generates a unique key value used to refer to the secretin this field.
Enabled

 

Insert excerpt
_check_box_tick
_check_box_tick
nopaneltrue
 to indicate you have completed configuring the

properties

secret key and

the secret key

associated local secret value, and it is ready to use.

If ticked there will be a secret value corresponding to this key, which may

The local secret value may be null.

Insert excerpt
_check_box_untick
_check_box_untick
nopaneltrue
 means a reference to this secret key in an expression will fail.

SecretRead only. When the secret key has been saved, the secret can be edited.

Click 

Insert excerpt
_add
_add
nopaneltrue
 to create a local secret item, where you can enter the value, such as a password, that is paired with this secret key; see Local Secret Properties, below.

When you save the local secret, PhixFlow displays asterisks here to show that the secret value has been encrypted.

To edit a secret value, click 

Insert excerpt
_edit
_edit
nopaneltrue
.
To delete a secret value, click 
Insert excerpt
_delete
_delete
nopaneltrue
.

Insert excerpt
_description
_description
nopaneltrue

Insert excerpt
_audit
_audit
nopaneltrue

Local Secret 
Insert excerpt
_property_tabs
_property_tabs
namebasic-h
nopaneltrue
 
Anchor
value
value

FieldDescription
KeyRead only. The same automatically-generated key in the secret key paired with this local secret.
Secret

Enter the value that you want to encrypt, such as a password. To switch between displaying or hiding the value, click 

Insert excerpt
_password_view
_password_view
nopaneltrue
.

PhixFlow encrypts the value when storing it in the database, but when it is required to authenticate to an external site, PhixFlow supplies the unencrypted string. 

Insert excerpt
_audit
_audit
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

For links to all pages in this topic, see Analysis Models for Batch Processing Data.

Insert excerpt
_terms_changing
_terms_changing
nopaneltrue