Overview
Streams are a key model component. They represent a structured store of data within PhixFlow receiving data from one or more components, processing it then storing it.
Insert excerpt _standard_settings _standard_settings nopanel true
The tab toolbar has the following additional buttons:
| Insert excerpt | ||||||
|---|---|---|---|---|---|---|
|
| Insert excerpt | ||||||
|---|---|---|---|---|---|---|
|
| Insert excerpt | ||||||
|---|---|---|---|---|---|---|
|
When you make changes to streams and stream attributes, PhixFlow automatically publishes them to the stream data tables in the database; see Publishing Streams.
Stream Properties
...
| Field | Description | ||||||||
|---|---|---|---|---|---|---|---|---|---|
| Name | The name of the stream. | ||||||||
| Enabled |
| ||||||||
| Static Data |
Updating a static streamIn general, static streams are not updated during an analysis run that is initiated on another stream in the model. The exception is when an incoming push pipe is triggered, as this will force the stream to update itself. Instead, to update the data in a static stream you must run analysis directly on the stream via:
| ||||||||
| Period | Select the time period for the stream. This can be either a regular period, or variable.
As transactional streams need a | ||||||||
| Default Data Range | This option affects the following items for which this is the backing stream:
If no option is is selected, PhixFlow assumes the default data range is All. You can override this setting using the options Use Custom Data Range and Data Range available: You cannot override this setting for a stream view. | ||||||||
| Stream Type | Select the stream type. The type indicates the function that operates on the data.
| ||||||||
| Supersede Items on Pipe | Select a loop pipe from the list of those available. A loop pipe links the stream back to itself. It compares new data records to the existing data records. If there is a repeated record PhixFlow uses the new one in the stream and marks the old one as | ||||||||
| Audit Manual Changes | This check box is available when the Period is Transactional.
When Audit Manual Changes is first set, the attributes
|
...
The grid contains a list of the stream attributes in the stream. This section has a toolbar with standard buttons and
and Insert excerpt _stream_show _stream_show nopanel true
.Insert excerpt _file_collector_show _file_collector_show nopanel true
The grid lists the attributes (data columns) in the stream data. To edit the properties of an attribute, double-click the attribute name to open the Stream Attributes properties.
...
To add an existing attribute to the list:
- Click
to list the streams available in the repository.Insert excerpt _stream_show _stream_show nopanel true - Expand a stream to show its attributes.
- Drag an attribute into this list to add it.
...
| Field | Description | ||||||||
|---|---|---|---|---|---|---|---|---|---|
| Input Multiplier | The input multiplier expression should evaluate to a list of one or more values. For each value in the list, the internal variable _inputMultiplier will be set to that value and the whole stream processing will be repeated i.e. the pull pipes will be read and the data from those pipes processed to generate output stream items to be added to the current stream set. For example : do ( $aRange = [], addElement($aRange, rng.RangeFrom), addElement($aRange, rng.RangeTo), $bRange = [], addElement($bRange, $aRange), $bRange ) Where rng.RangeFrom = 500 and rng.RangeTo = 1000, the above example evaluates to [[500,1000]], which is a list containing 1 element, which is itself a list containing 2 elements. An Input Multiplier that evaluates to [3,4,7,8] would run the Stream 4 times.Because Input Multipliers are evaluated first in the PhixFlow Timing Cycle they are often used to look up values that can be passed to Database or other Collectors. | ||||||||
| Log Input Multiplier Messages |
to cause PhixFlow to write a message to the log every time an Input Multiplier value changes during an analysis run. | ||||||||
| Output Multiplier | This field is an expression which should evaluate to an array of values. A separate output record will be produced for each value in the array and this value is available as _outputMultiplier in each of the stream output attribute expressions (each value in the array is also available through _type, although this is not recommended usage). In effect this will multiply each of the output records by the number of elements from the returned list. For example : ifNull(in.ASSET, [1,10,12] , // else do [5,7] ) will create 3 records for every record in the stream if in.ASSET contains a value (setting _type = 1, 10 and 12 in each case). Otherwise it will create 2 records for every record in the stream (and set _type = 5 and 7). An Output Multiplier may also evaluate to a record, or a group of records. For example an Output Multiplier with the expression:do( lookup(lkin, $num = in.BNumber), lkin ) will return a list of records which match the lookup on the lkin pipe. In this case the required data can be extracted from the Output Multiplier using the following expression : do ( $values = _type, $values.account_num ) If the output multiplier expression evaluates to _NULL, an empty list of values or an empty list of records then a single output record will be produced with _type set to _NULL, _NULL or an empty record respectively. | ||||||||
Select Records to Output | You can select a subset of records to output to the next modelling object. You select records using the data in any attribute that is in the stream output. Enter an expression that should evaluate to true or false (equivalently 1 or 0). When the expression evaluates to true or 1, the records found by the expression are selected and output to the next modelling object. For example:
To select active accounts, enter the expression |
...
The grid contains a list of actions that use the stream. This section has a toolbar with standard buttons.
To edit the properties of an action, double-click the attribute name. To add an action to the list, click
| Insert excerpt | ||||||
|---|---|---|---|---|---|---|
|
...
The grid contains a list of stream item actions that can update the stream. This section has a toolbar with standard buttons.
To edit the properties of an action, double-click the attribute name. To add an action to the list, click
| Insert excerpt | ||||||
|---|---|---|---|---|---|---|
|
...
The grid contains a list of the data views for this stream. This section has a toolbar with standard buttons.
o edit the properties of an stream view, double-click the attribute name to open its Stream View properties tab.
...
| Field | Description | ||||||||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| Stream Download Limit | The maximum number of records that a user can download from a stream view or card view on this stream. If no value is set, PhixFlow uses the default limit set in System Configuration→ System Tuning → Default Download File Limit. | ||||||||||||||||||||||||
| Allow Unlimited Downloads |
| ||||||||||||||||||||||||
| User Groups | Available when Allow Unlimited Downloads is ticked. Use this section to select the user groups whose members can download an unlimited number of records. This section has a toolbar with standard buttons and The grid contains a list of user groups that are exempt from the Stream Download Limit. To add a user group to the list:
To remove user groups, use the
|
...
Store Stream Views
To do
Access Permissions
By default, the permissions to access stream data is set in System Configuration → Allow access to data by default. You can add specific user groups to restrict access to the stream; see Common Properties → Access Permissions.
...
| Field | Description | ||||||
|---|---|---|---|---|---|---|---|
| Advanced Properties | Only use this field with advice from PhixFlow support. | ||||||
| Database View | Use this option if your database administrator wants to query stream data in the PhixFlow database. Enter a string in the format By default, this field is blank and no stream view is created in the database. See also Configuring Access to Database Views. | ||||||
| Storage Options | |||||||
Index Scheme
| This determines how indexes on the stream are organised.
| ||||||
| Storage Type | Specifies how data for the Stream should be stored:
| ||||||
| Data Generation Options | |||||||
| Start Date | The date that this stream starts. Data will be populated into the stream from this date onwards. | ||||||
| In Memory Cache Size | The size of the cache that will be maintained when you are using an in-memory stream. See Manage Unsorted Data Using an In-Memory Stream. | ||||||
| Allow Partial Set Processing | If ticked, when analysis reaches the end of a buffer block it submits the candidate set for processing, even if the next buffer block has a different key. | ||||||
| Prevent Parallel Processing | This field only appears if the Period is set to Transactional. If ticked, it ensures that only a single stream set can be generated at a time even if the stream receives several concurrent requests to generate data. This can be useful where you want to make sure that two analysis runs don't attempt to update the same records at the same time e.g. as a result of two people selecting the same records in a view and then hitting the same action button at the same time to process those records. | ||||||
| Run Alone | If this flag is ticked then whenever the analysis engine needs to generate data for this stream it will first wait for all running tasks to complete before it starts. Any additional analysis tasks submitted while this stream is waiting to start, or while it is generating data, will wait until this stream has completed its analysis before they start. | ||||||
| Key Tolerances | When building a candidate set, data can be grouped together using a specific key value, e.g. Account Number. If the key value is a number, setting a key tolerance will identify numbers within the given tolerance as the the same key value. | ||||||
| Default View | The default view selected for the stream. See help on Views for details of creating views on streams. | ||||||
| Last Run Date (Read only) | The date and time that analysis was last run for this stream. This date is taken from the "to date" of the most recent stream set for this stream. | ||||||
| Last Run By | The user that last ran this stream. | ||||||
...