Versions Compared

Key

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

Overview

A pipe is a connector that links two elements in a PhixFlow model and sends data from the input to the output. Pipes allows you to control which attributes and which records from the input are delivered by to the output, although in most cases - with minimal configuration - you will get all columns and the records from the current run.

...

For advanced configuration, see Advanced Pipe Configuration.


Insert excerpt
_standard_settings
_standard_settings
nopaneltrue


Panel
bgColor#e6f0ff
titleBGColor#99c2ff

A pipe joining a datasource to a data collector has no details to edit. All the configuration for the output data set occurs in the collector - either a database collector for a database datasource, or an HTTP collector for an HTTP datasource.

Basic Settings

FieldDescription
Name

Enter a name. The name is used to refer to the pipe in other model elements

...

Panel
bgColor#e6f0ff
titleBGColor#99c2ff

The name can have no special characters except the underscore character '_', it has to start with a letter and cannot be an Attribute Function name.

Type

There are 3 options available:

...

. Pipe names default to in.

The name:

  • must start with a letter
  • must not be an Attribute Function name.
  • must not include special characters, except underscore _
Enabled

Insert excerpt
_check_box_untick
_check_box_untick
nopaneltrue

Insert excerpt
_check_box_ticked
_check_box_ticked
nopaneltrue

Static

Insert excerpt
_check_box_untick
_check_box_untick
nopaneltrue

Insert excerpt
_check_box_ticked
_check_box_ticked
nopaneltrue

Mandatory

Insert excerpt
_check_box_untick
_check_box_untick
nopaneltrue

Insert excerpt
_check_box_ticked
_check_box_ticked
nopaneltrue

Multiplier

Insert excerpt
_check_box_untick
_check_box_untick
nopaneltrue

Insert excerpt
_check_box_ticked
_check_box_ticked
nopaneltrue

Type

Select:

  • Pull: pull pipes are the most common type in PhixFlow - they "pull" data from the input to the output. Pull pipes are shown as solid arrows on models.
  • Look-up: look-up pipes are used to enrich data. Typically, you will have one of more pull pipes to supply the base data for an output, and if needed one or more look-up pipes to enrich the base data with values from additional inputs. Look-up pipes are shown as dashed lines on models.
  • Push: data is "pushed" rather than "pulled" into the output stream. Push pipes are most commonly used when sending data from streams to exporters (File Exporters, Database ExportersHTTP Exporters). Push pipes are shown as dotted lines on models.
Data to Read

Select the type of input data to use.

  • Latest: supply data from the current run (the latest stream set). This is the mostly commonly used option.
  • Previous: supply data from the previous run (the previous stream set). This is used when you are comparing data for the current run with data from the previous run, for example, today's data with yesterday's.
  • All: supply data from all runs (all stream sets). 
  • All Previous: supply data from all runs except the current run (all stream sets except the latest stream set).
  • Same Run: this option should only be used where the input and output streams are set to Period: Transactional. The pipe will only collect data from inputs in the same analysis run. This configuration support several analysis runs going on at the same time without interfering with each other. 
  • Custom: select this option to display additional settings, described in Advanced Pipe Configuration, below. We recommend that you only use the custom settings when directed to by PhixFlow consultants or support.
Read Future Data
Output


Data To Read

Specify what input data to use. There are 6 options available:

...

Only aggregate attributes which can be aggregated. For example, do not try to sum an attribute which contains text.

...

Custom Data to Read

Data to Read = Custom

The following fields are available in the Basic Settings section if you set Data To Read = Custom:

...