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 
• HTTP collectors → URL expression or Statement Expression                                                                                                                                                              

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  Add New to create a new secret key.

Property Pane Toolbar

For information about the toolbar options, see the Common Properties page, Toolbars and Controls section.

Secret Key  Properties Tab

Parent Details

If this item is within or belongs to another, its parent name is shown here. See the Parent Details section on the Common Properties page for more details.

Basic Settings

Field	Description
Name	Enter a name.   Apply the properties. Use this name in expressions to refer to this key.
Key	Read-only. When you save the secret key, PhixFlow automatically generates a unique key in this field.
Enabled	Tick 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.  Untick means a reference to this secret key in an expression will fail.
Secret	Click  Add New 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  Edit. To delete a secret value, click  Delete.

Description

We recommend that you always enter a description to explain the purpose of this item.

 Audit Tab

Audit Summary

See the Common Properties page, Audit Summary section.

Local Secret  Properties Tab 

 Audit Tab

Audit Summary

See the Common Properties page, Audit Summary section.