Versions Compared

Key

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

...

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 field, which may be used with Transactional streams.

  • 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 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: Advanced fields are 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.


Panel
bgColor#e6f0ff
titleBGColor#99c2ff
titleAdvanced considerations - future stream sets

In some circumstances the input Stream may have Stream Sets that have dates in the future relative to the Stream Set being generated for the output Stream. This may happen, for example, if you have rolled back a number of Stream Sets on the output Stream but have not rolled back the corresponding Stream Sets on the input Stream, and have then requested that the output Stream is brought up to date. 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. This is so that if you are rebuilding an old Stream Set the pipe will retrieve the same data on the rerun as it retrieved when the Stream Set was first built.

Similarly, if you are running a Transactional Stream, it is possible that while 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 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, 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.

...

FieldDescription
From OffsetThe offset applied to the start of the collection period, relative to the period in the output stream that requires populating.
To OffsetThe offset applied to the end of the collection period, relative to the period in the output stream that requires populating.
Max Stream SetsIn 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 runEvery 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.
HistoriedIf 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 are running a transactional stream then it is possible that while your analysis run is taking place, other analysis runs which started after yours may have managed to complete before yours, generating additional stream sets on the input stream. These additional stream sets will then have a future data relative to the date of the stream set you are generating. By default PhixFlow will ignore input stream sets that have a date in the future relative to the stream set being generated.

However, for transactional streams it is possible to tell the pipe to include future stream sets by ticking this box.

This field is only available if the input stream is transactional and:

  • Data To Read = Custom
  • Only collect from same run is not ticked
  • Max Stream Sets is blank or zero
  • Historied is not ticked

or

  • Data To Read = All

Advanced section

The following fields are configured in the Advanced section:

...