HTTP Header


This page is for data modellers who need to import or export data via HTTP.

Overview

Use the HTTP properties tab to define an HTTP header for an HTTP collector, HTTP exporter or HTTP Action.

This property tab is not available from the repository. It opens from:

Property Pane Toolbar

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

 Properties Tab

Parent Details

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

Basic Settings

FieldDescription
Name

Enter the name of the HTTP header Item. You must not include a colon after the name. For example:

Content-Type
Value

Enter the value of the HTTP header Item. For example: text/xml; charset=UTF-8

You can embed expressions within a statement by enclosing the expression in ${…}; see Embedded Expressions. For example, to refer to a specific attribute on a lookup pipe that connects to a HTTP collector or HTTP exporter, include:

${pipe_name.attribute_name}

where:

  • pipe_name is the name of the pipe
  • attribute_name is the name of the attribute.

This is useful if the value you need changes. For example, a character set is defined in the attribute "lang". The actual character set varies depending on the language used in the source HTTP. To read the character set from the pipe "in", specify:

text/xml; charset=${in.lang}

For how to configure and use usernames and passwords for a site, see Authenticating for an API and  Secret Key and Local Secret
To reference:

  • HTTP datasource instance Username and Password properties, use the variables:  %USERNAME% and %PASSWORD%.
  • encrypted values, use  ${_datasource.key}  where key is the Name of the secret key.

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.

HTTP Header Exceptions

Depending on your system's API, some headers may either be ignored or added.

The following headers may be ignored if you create a HTTP Header for them.

  • Access-Control-Request-Headers
  • Access-Control-Request-Method
  • Content-Length
  • Content-Transfer-Encoding
  • Host
  • Keep-Alive
  • Origin
  • Trailer
  • Transfer-Encoding
  • Upgrade
  • Via
  • any header starting with sec-.

Some headers will be automatically added if you do not create a HTTP Header for them:

  • Content-length
  • Host
  • User-agent
  • Accept: text/html, image/gif, image/jpeg, *; q=.2, */*; q=.2
  • Connection: keep-alive
  • Pragma: no-cache
  • Cache-Control: no-cache

Sections on this page

Learn More

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


Terminology changes in progress

As part of the redesign of PhixFlow, we are changing the following terms:

dashboard → screen   
stream → table
stream attributes → attributes
stream item → record
stream set → recordset
stream view → view
stream item action → record-action 
stream action → table-action
driver class → database driver