...
| Field | Description | ||||||
|---|---|---|---|---|---|---|---|
| Name | The name of the stream. | ||||||
| Stream Function | The type of function used to generate this stream - see Stream Functions. If this stream is to be populated through collection, then no function is selected. | ||||||
| Enabled | Whether 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 Date | The date that this stream starts. Data will be populated into the stream from this date onwards. | ||||||
| Last Run Date | The 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 Type | Specifies how data for the Stream should be stored:
| ||||||
| Index Scheme | This determines how indexes on the Stream are organised. There are two possible settings:
| ||||||
| Period | This is the period of the stream. This can be either a regular period, or variable. There are three possible settings:
| ||||||
| 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. | ||||||
| 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 View | The default view selected for the stream. See help on Views for details of creating views on streams. | ||||||
| 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 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. | ||||||
| Save Archive to File | If Save Archive to File is set, archived data will be written to compressed archive files before being deleted. |
...
| Field | Description | ||||||
|---|---|---|---|---|---|---|---|
| Track Superseded Date | If ticked, new records will be compared to existing records and if a repeated record is found, the old one will be marked as 'superseded'. | ||||||
| Using Pipe | Name of the pipe used to retrieve existing records from the stream. This must be a pipe linking the stream back into itself. | ||||||
| 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. |
...