...
For advanced configuration, see Advanced Pipe Configuration.
| Panel | ||||
|---|---|---|---|---|
| ||||
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. |
...
| Panel | ||||
|---|---|---|---|---|
| ||||
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:
...
Specify what input data to use. There are 4 6 options available:
- 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).
- Custom: If you are setting up a transactional model, choose this option so that you can select Only collector from same run. There are other fields revealed by selecting this option (see Advanced Pipe Configuration), but you are recommended not to update these unless directed to by PhixFlow consultants or support.
...
| bgColor | #e6f0ff |
|---|---|
| titleBGColor | #99c2ff |
...
- Selecting All displays the Read Future Data checkbox, which may be used with streams set to Period Transactional.
- All Previous: supply data from all runs except the current run (all stream sets except the latest stream set).
From version 8.0.6 onwards, the Read Future Data checkbox is always available. - 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.
| Panel | ||||||||
|---|---|---|---|---|---|---|---|---|
| ||||||||
Some of the Stream Sets stream sets on the input Stream stream will have dates in the future relative to some of the Stream Sets stream sets you are rebuilding. By default, pipes will ignore any Stream Sets stream sets with dates in the future relative to the Stream Set stream set you are generating. This is so that if you are rebuilding an old Stream Set the pipe will You want to ignore future stream sets when you rebuild an old stream set, because you want the pipe to retrieve the same data on the rerun as it retrieved when the Stream Set stream set was first built. Similarly, if you are running a Transactional Streamwhen you run analysis on a stream with a transactional period, it is possible that while as your analysis run is taking place, other analysis runs which started after yours may have completed before yours. These will have generated additional Stream Sets on the input Stream still running, a different run can start and complete. This run can generate additional stream sets on the input stream with a future data relative to the date of the Stream Set you are generating. For Transactional input Streams it is possible to tell the pipe not to ignore these future Stream Sets by ticking the Read Future Data tick box on the Advanced tab.of the stream set you are generating. For transactional input streams, you want the pipe to use these future streams. To do this, tick the Read Future Data checkbox, which is available when Data To Read is All (or Custom).
|
Static
Normally when a pipe requests data from a non-static input stream, that stream will first attempt to bring itself up to date, generating new stream sets as necessary, before supplying the data requested. However, if this field is ticked, the input stream will not run. Pipes from collectors cannot be marked as static.
...
| Field | Description |
|---|---|
| Filter | Allows the user to set up a filter on the pipe. Also allows to set the flag to Include Audit Records. If not set, superseded records will be filtered out. |
| Sort/Group | Specify the group/ order by attributes on the pipe. |
| Aggregate attributes | Specify any aggregate attributes on the pipe. |
| Advanced | Configure advanced features on the pipe. |
| Anchor | ||||
|---|---|---|---|---|
|
...
For case 1, when using a lookup pipe, data retrieved is stored in a cache. See cache size for details. The cache extraction filter allows you, as you are processing a set of output records, to use different cached entries from the lookup for each of the records are you are processing. This is very fast compared to looking up from the source (i.e. going back to an external DB table or even another PhixFlow stream) for each output record.
...
- an attribute in a source stream, if you are reading from a stream
- if you are reading from an external database table, one of the fields returned by the database collector AND an attribute in the output stream - i.e. to use an attribute with the source as a database collector, there must be an attribute of matching name in the output stream
- an attribute in the destination stream, in which case you will refer to it using the format
_out.AttributeName
| Anchor | ||||
|---|---|---|---|---|
|
A Pipe can be grouped and sorted by attributes of the input stream. These are set up in the Group/Order section of the Pipe form. In fact, this section is called Sort/Group for pull and push pipes, and Order/Index for lookup pipes.
...
Aggregate Attributes define the aggregated properties that are available when data is read from an aggregating Pipe. Note that Aggregate Attributes are not available on Pipes from Database Collectors (any aggregation can be performed in the query SQL), nor are they available on Pipes from File Collectors.
Possible aggregate values are counts, summations, averages and maximum or minimum values of Stream Items grouped in the Group/Order tab of the Pipe.
| Field | Description |
|---|---|
| Stream Function | The Aggregate Function e.g. Count or Sum. |
| Attribute | The name of the Stream Attribute to be aggregated. Note that the value in this field is not used if the Aggregate Function is Count. |
| Name | A new name for the aggregated attribute. Note that this can be the same as the original Attribute. |
| Order | The order of the aggregate attribute. |
...
| Field | Description | ||||||
|---|---|---|---|---|---|---|---|
| From Offset | The offset applied to the start of the collection period, relative to the period in the output stream that requires populating. | ||||||
| To Offset | The offset applied to the end of the collection period, relative to the period in the output stream that requires populating. | ||||||
| Max Stream Sets | In almost all cases this specifies the number of stream sets to be retrieved from the input stream. However, if this is a push pipe with positive offsets this value indicates the maximum number of stream sets that can be created i.e. the maximum number of cycles this pipe can initiate. | ||||||
| Only collect from same run | Every time the analysis engine runs, all of the stream sets that are created by all of the streams affected by that analysis run are given the same Run ID. If this flag is ticked then the pipe will only collect stream sets from the input stream that have the same Run ID as the stream set currently being created by the output stream. You should only use this flag is both the input and output streams are transactional. | ||||||
| Historied | If ticked, the pipe will collect data from the input stream by period. So if the from and to offsets are both 0.0, and the output stream requires stream generation for the period 17/10/07 - 18/10/07, data will be collected from the input stream for the period 17/10/07 - 18/10/07. If not ticked, all data will be collected from the input stream, regardless of period. In this case, the offsets are still used to determine whether the required data periods in the input stream exist before the stream calculation can be carried out. | ||||||
| Read Future Data | If
If you have been directed to use the Custom options by PhixFlow consultants, then this checkbox is available when:
Note: From version 8.0.6 onwards, the Read Future Data checkbox is always available. |
Advanced section
The following fields are configured in the Advanced section:
...