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 | ||||||
|---|---|---|---|---|---|---|
|
...
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.
...
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.
...
| Note |
|---|
It is possible for this list to include pipes that have no input. This occurs if the source stream has been deleted, or if a model has been moved to a different PhixFlow instance (export/import), leaving behind a referenced stream. Any pipes with no input are highlighted in yellow. To resolve pipes with no input you can:
|
Action Flows
To do
| Anchor | ||||
|---|---|---|---|---|
|
| Field | Description | ||||||
|---|---|---|---|---|---|---|---|
| The number of days data to keep in the stream. When an archive task runs for a stream, all stream data is deleted if it is at least Keep for X Days old or if it is older than the Keep for Y Stream Sets most recent valid stream sets. If both Keep for X Days and Keep for Y Stream Sets are set, stream data will be deleted only if it meets both conditions. If neither are set, stream data is kept indefinitely. If Save Archive to File is ticked, deleted items are first saved to archive files. The age of data in a stream set is its 'to' date relative to the 'to' date of the newest valid stream set in the stream. See here for how to set up and schedule an Archive Task. Please see the section below on Archiving Examples to see how this value can be used within Archiving strategies. | ||||||
| Keep for Y StreamSets | The number of stream sets data to keep in the stream. See Keep for X Days for the main description of archiving. | ||||||
| The number of days for which to keep superseded data in the stream. If Track Superseded Data is ticked, then this field will become visible/enabled. In a stream where the superseded date is tracked, the stream data will contain a mixture of superseded records and "active" records - that is, records that have not been superseded. When an archive task runs for a stream, records that were marked as superseded more than Keep Superseded for X Days days or more than Keep Superseded for Y Stream Sets stream sets ago are deleted. If both Keep Superseded for X Days and Keep Superseded for Y Stream Sets are set, superseded records will be deleted only if they meet both conditions. If neither are set, superseded records are not deleted. This means, for example, that if you have set Keep Superseded for X Days to 4, you will be able to roll back 3 days, making the 4th day the latest valid day. If Save Archive to File is ticked, deleted items are first saved to archive files. Please see the section below on Archiving Superceded Examples to see how this value can be used within Archiving strategies. | ||||||
| Keep Superseded for Y StreamSets | The number of stream sets for which to keep superseded data in the stream. If Track Superseded Data is ticked, then this field will become visible/enabled. See Keep Superseded for X Days for the main description of archiving superseded records. | ||||||
| Save Archive to File | If Save Archive to File is set, archived data will be written to compressed archive files before being deleted. | ||||||
| Apply Archive Filter | If this flag is ticked then a dialog box appears within which a filter can be created. This filter will be applied during archiving and only the records which match the filter will be archived and deleted. |
Store Stream Views
To do
Access Permissions
| Field | Description |
|---|---|
| All Users Can View Data | If checked, this specifies that all users can view this data by default (provided they have the basic privilege to view streams). If this field is not checked, then access to the underlying data is controlled by dropping user groups onto the stream's "User Group" tab. Note that the default setting for this field on streams is controlled by the system parameter allowAccessToDataByDefault. |
...
The advanced properties field should only be set by, or under the guidance of, PhixFlow support.
| Field | Description | ||||||
|---|---|---|---|---|---|---|---|
| Database View Name | to do | ||||||
| Advanced Properties | to do | ||||||
| Storage Options | |||||||
Index Scheme
| This determines how indexes on the Stream are organised. There are two possible settings:
| ||||||
| 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 How To: Summarise unsorted data with In Memory Streams. | ||||||
| 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. | ||||||
| Write in Single Transaction | If this is ticked, all of the records for a Stream Set will be written to the database in a single transaction. | ||||||
| Maximum Records to Write | The maximum number of records per Stream Set if Write in Single Transaction is ticked. | ||||||
| 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. | ||||||
...