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 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. To provide a username and/or password securely, configure a key/value pair.  

  1. In a HTTP Datasource properties → Secret Key Details, create a secret key.
  2. In the Secret field, click
    Insert excerpt
    _add
    _add
    nopaneltrue
     to create a new Local Secret item.
  3. In the local secret → Secret field, add the value, which PhixFlow stores encrypted.

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

  • HTTP collectors and exporters → URL Expression or Statement Expression fields in
  • HTTP Headers Properties → Basic Settings → Value.

by specifying ${_datasource.key}  where key is the Name of the secret key.                                                                                                                                                         

When you run analysis, 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

Basic Settings

FieldDescription
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 in this field.
Enabled

 

Insert excerpt
_check_box_tick
_check_box_tick
nopaneltrue
 to indicate you have completed configuring the secret key and associated local secret value, and it is ready to use. 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.

Secret

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


Using a Keystore

todo-fiona

Internal IDs

If you have configured a Java keystore Configure a Keystore and Aliases and Adding Data to a Keystore  you can use this to store secure credentials instead of using a Local Secret. 

Datasource and HTTP Datasource modelling objects have properties → Advanced → Internal ID.

This is a read-only field that provides the database identifier for the datasource. 

You can supply a key-value pair to the keystore. However, the username and password key or value requires the datasource ID.


EG. Datasource needs a username XYZ and password ABC 

Key datasource1-username - internalIDXYZ

Key datasource1-pw - internalIABC


Datasource 

  1. Store the username key-value pair in the keystore.
  2. Store the password key-value pair in the keystore.
  3. To reference them, in the expressions, use ${_datasource.key}  where key is the key

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