Versions Compared

Key

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

...

FieldDescription
NameThe name of the stream.
Stream FunctionThe type of function used to generate this stream - see stream functions Stream Functions. If this stream is to be populated through collection, then no function is selected.
EnabledWhether or not the stream is enabled to run.
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.

Start DateThe date that this stream starts. Data will be populated into the stream from this date onwards.
Last Run DateThe date and time that analysis was last run for this stream. This date is taken from the "to date" of the most recent streamset for this stream.
Storage TypeSpecifies how data for the Stream should be stored:
  • Database: Store the data in a regular table within the PhixFlow database. This is the most common option
  • Database (Partitioned): Store the data in a partitioned table within the PhixFlow database. This option provides improved performance for rollback and archiving of very large Streamsets. The option is only available if "partitioning" is available within your database installation.
  • In Memory: Data for the Stream will not be written to the database. This option can be used (for example) when you want to aggregate large amounts of unsorted data which can then be written to a stored Stream.
Index SchemeThis determines how indexes on the Stream are organised. There are two possible settings:
  • All: indexes on the Stream are optimised for selecting from all stream sets (non-historied reads).
  • Latest: indexes on the Stream are optimised for selecting from the latest stream set (i.e. for historied reads).

Note: it is not possible to change this setting if the Stream contains data.

PeriodThis is the period of the stream. This can be either a regular period, or variable. There are three possible settings:
  • Transactional: allows multiple users to run independent analysis tasks at the same time.
  • Daily: generate or collect data every day.
  • Monthly: generate or collect data every month.
  • Variable: generate or collect data since the more recent run of the stream to the current date.
  • Single: Used in Workflows only.
Prevent Parallel ProcessingThis 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.
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.

Default ViewThe default view selected for the stream. See help on Views for details of creating views on streams.
Anchor
keepForXDays
keepForXDays
Keep for X Days

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.

Apply Archive FilterIf 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.
Save Archive to FileIf Save Archive to File is set, archived data will be written to compressed archive files before being deleted.

...

Shows the list of File Collectors.

Shows the list of Streams.

Deletes the selected object from the list.

Adds a new Stream Attribute.

See Also