...
| 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:
...
| Panel | ||||||||
|---|---|---|---|---|---|---|---|---|
| ||||||||
Some of the stream sets on the input stream will have dates in the future relative to some of the stream sets you are rebuilding. By default, pipes will ignore any stream sets with dates in the future relative to the stream set you are generating. 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 was first built. Similarly, when you run analysis on a stream with a transactional period, it is possible that as your analysis is 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, 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).
|
...
- 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
...
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 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. |
...