...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
When streamsTask Properties
| Insert excerpt | ||||||
|---|---|---|---|---|---|---|
|
Basic Settings
| Field | Description | ||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| Name | Enter the name of the task. | ||||||||||||||||
| Mandatory |
| ||||||||||||||||
| Order | Specify the order that the task will be run in the task plan. For example, if there are a total of 4 tasks in the task plan, and you want this task to run third, enter 3. | ||||||||||||||||
| Task Type | PhixFlow displays the type of this task, which can be:
| ||||||||||||||||
| Archive All | Available when Task Type = Archive Task.
To save an archive task, it must:
|
Streams
This section is only available for analysis tasks and archive tasks. The grid shows the list of streams assigned to the task.
| Tip |
|---|
When you are creating a new task, remember to name and save the task properties so that the Streams section toolbar becomes available. |
There are different ways you can add streams to the list.
- From a model, hover your mouse pointer over the stream to display the pop-up toolbar. Click
and drag it into the grid.Insert excerpt _object_drag _object_drag nopanel true - From the repository, click
to display the list of the streams in the repository. Drag a stream from the list into the grid.Insert excerpt _streams_show _streams_show nopanel true - From the stream properties, drag the icon into the grid.
If you add multiple streams to the task, PhixFlow will process the streams in any order when the task runs. Only use this method if there is you are sure there are no dependencies between the streams.
Types of Task
| Anchor | ||||
|---|---|---|---|---|
|
Use an analysis task to run analysis on the stream(s) in the task.
| Anchor | ||||
|---|---|---|---|---|
|
Use a rollback task to effectively undo run analysis on a stream. When you run a rollback task it rolls back all data in each of the listed streams, deleting the stream-sets. The list of stream sets is empty and there are no data records in the stream (tbc). For information about how to rollback streams manually, see Rollback.
| Anchor | ||||
|---|---|---|---|---|
|
Use an archive task to delete or archive stream data or stream sets that you no longer need in PhixFlow. Archive data is saved into a zip file - to get at this? You can (in theory) reinstate archive data.
Whether or not PhixFlow deletes or archives stream sets depends on how the archive settings in the stream are configured.
| Note |
|---|
Phixflow can only run an archive task on streams that have Archive Settings specified. If a stream does not have any archive settings, PhixFlow never deletes or archives the data. Stream sets will accumulate, leading to space and performance issues. |
Running an archive task on a large number of streams, or on a stream with a large data set can take some time. We recommend scheduling archiving tasks for times when the system is quiet, for example overnight.
| Note |
|---|
All streams in an archive task must have their Archive Settings specified. |
Archive without specifying streams
...
Archiving Specific Streams
You can create an archiving task for a specific stream or streams. PhixFlow creates a single zip file containing the specified streams. For example, you might want to create a single archive for:
- data from several related streams
- a stream that contains a large amount of data
- a stream that you want to be able to restore from the backup. This is easier when the data is in its own zip.
Archiving Any Stream
You can create a single archive task to delete or archive the data in streams:
- that are not in another archive task
- and have archiving settings configured.
To do this, select the Archive All option
When you run the task, PhixFlow:
- deletes stream sets that are older than the specified archive settings in the stream
- creates a zip archive of all the stream sets within the specified archive settings in the stream.
This is a single archive containing all the data from all the streams processed.
...
Archiving a specific stream
If you want to have separate zip files containing data for a specific stream, create an archive task and add only that stream. The stream must have Archive Settings.
You can create an archiving task for a specific stream or streams. For example, you might want to create a single archive for:
...
Archive tasks must have:
- either at least one stream added
- or have the Archive All option ticked.
If streams are deleted from the repository, their names will automatically be removed from tasks that refer to them. This means a saved task can become empty/redundant. PhixFlow will no longer run the task - log mesages??
Finding the Archive file
When a stream is archived, PhixFlow logs information in the system console → Archive Log. This includes information about the data archived and any archive file created. This is a single archive containing all the data from the streams processed.. Optionally, the archived data can be saved to a file. If this is done, the data can reloaded into PhixFlow using Restore Archive.
...
| Warning |
|---|
This should be a warning in the Streams page. Streams that do not have any Archive Settings will never have their data deleted or archived. This can cause large amounts of data to build up in PhixFlow, affecting performance. Remember to set your archive settings!!! For data in a stream to be deleted or archived, the stream must have Archive Settings applied. If a stream does not have any archive settings, the data will accumulate, leading to performance issues. |
| Anchor | ||||
|---|---|---|---|---|
|
Use a system task to perform system-wide housekeeping activities. These include deleting:
- managed file entries
- email entries
- temporary files created by file exporters to send by email
- data from incomplete stream sets
- log messages and optionally archiving them.
| Note |
|---|
The system task should be run daily, or at a minimum every week. If incomplete stream sets are not deleted, they can slow down PhixFlow's performance. Depending on your PhixFlow database, queries that have to exempt many incomplete stream sets can reach system limits. This can prevent PhixFlow and its applications from running. |
The archiving periods, and whether to archive log messages before they are deleted, are controlled by the following parameters in System Configuration:
...
Task Properties
...
Basic Settings
...
PhixFlow displays the type of this task, which can be:
- Analysis Task
- Archive Task
- Rollback Task
- System Task
| Tip |
|---|
You select the task type when first add the task. This field is visible after the task is saved for the first time. You cannot change the task type. |
...
Available when Task Type = Archive Task.
...
To save an archive task, it must:
- either have this option ticked
- or have at least one stream.
Streams
This section is only available for analysis tasks and archive tasks. The grid shows the list of streams assigned to the task.
| Tip |
|---|
When you are creating a new task, remember to name and save the task properties so that the Streams section toolbar becomes available. |
There are different ways you can add streams to the list.
...
...