Tasks in PhixFlow perform various jobs, including running analysis, archiving, and clearing old managed file and performance log records. Tasks are bundled into Task Plans, which can be requested by users, scheduled, or triggered by actions.
...
A Task Plan is a collection of Tasks.
Tasks configured in a Task Plan can be:
Tasks are configured to run in a certain order in a Task Plans, and can be set up to run on a scheduled date at a scheduled time.
| Panel | ||||
|---|---|---|---|---|
| ||||
A task plan that contains 1 task with 3 streams will process all streams at the same time. Whereas a task plan with 3 tasks, each containing 1 stream, will run the streams one by one. It will wait for the previous task to complete, before starting the next. If a mandatory task fails, then the next task should not be started. |
...
| Insert excerpt | ||||||||
|---|---|---|---|---|---|---|---|---|
|
...
...
If the Scheduled option is ticked, the following details will become available to edit:
...
...
...
...
...
...
...
...
...
...
...
Day of Week and Day of Month are mutually exclusive. One must be set to '?' (meaning no value specified), and the other defines the days that this Task Plan runs on.
...
Month element of the scheduled date/time, e.g. 1-12
Month can also be specified as short names e.g. JAN,OCT-DEC
...
Day of week element of the scheduled date/time, e.g. 1-7. The week starts on Sunday. So Sunday = 1, Monday = 2, etc.
Day of Week can also be specified as short names e.g. MON,WED-FRI
A day of week name or number followed by an 'L' means the last day of week in the month e.g. 'FRIL' means the last Friday, '2L' means the last Monday.
A day of week name or number followed by a hash ('#') and a number means the Nth day of week in the month e.g. '2#2' means the 2nd Monday in the month, 'FRI#5' means the 5th Friday in the month - if there is no 5th Friday in the month, that is equivalent to specifying no day of week.
If the '#' character is used, there can only be one expression in the day-of-week field, so "3#1,6#3" is not valid, since there are two expressions.
Day of Week and Day of Month are mutually exclusive. One must be set to '?' (meaning no value specified), and the other defines the days that this Task Plan runs on
...
Each of these elements can be specified with an explicit value (e.g 6), a range (e.g 9-12), a repeating group (e.g. 5/10 - equivalent to 5,15,25,35,...), or a list of single values, ranges, etc. e.g. 1,3-5,10,20/5.
Each of these elements other than Seconds can be set to a wild card ('*'), meaning all values.
Form Icons
The form provides the standard form icons
List: Tasks
Columns
The Task list shows a summary of each Task set up in the Task Plan.
List Icons
The Task list provides some of the standard list icons. The Task list also provides the icon:
Form: Send Result By Email
...
...
...
...
...
...
...
...
...
...
The following fields are configured through separate tabs on the form:
...
Note that if no streams are added into the archive task list then all streams configured to perform archiving that are not added to any other archive task will be archived.
Form Icons
Form Icons
The form provides the standard form icons.
The form provides the standard form icons.
The form also provides the following icons on the Streams tab:
...
...
Shows the list of Streams to select from.
...
...
Deletes the selected object from the list.
See Also
...
List: Email Recipients
Columns
The Recipients list shows a summary of each Recipient set up to receive the email. Selecting a recipient with a double click will bring up the details for that recipient in a User Notification Rule form.
| Field | Description |
|---|---|
| Name | The name of the recipient. This must be a user that has been set up in PhixFlow. |
| Expression | User Notification Rule - the rule that governs whether the email will be sent to this user. See Notification Rule for further details. |
List Icons
The Recipient list provides some of the standard list icons. The Recipient list also provides the icons:
...
...
Bring up the list of users configured in PhixFlow. A user can be selected from this list and dragged into the list of email recipients.
...
...
Add a new Recipient to the recipient list. This will bring up an empty User Notification Rule form.
See Also
A task with 3 streams will process all streams at the same time. Whereas having 3 tasks means that it will wait for the previous task to complete, before starting the next. With mandatory ticket, it shouldn't start the next task at all, if the previous task failed.
The Analysis Engine is initiated whenever the generation of a Stream Set or Alarm is requested. Users can do this by configuring Analysis Tasks in a Task Plan. Task Plans can be configured to run on a scheduled date at a scheduled time.
...
The following fields are configured on the Details tab:
...
The following fields are configured through separate tabs on the form:
| Field | Description |
|---|---|
| Stream/Alarm Generators | Streams and/or Alarm Generators can be dragged onto the list to add them to the analysis task. |
Form Icons
The form provides the standard form icons.
The form also provides the following icons on the Stream/Alarm Generators tab:
...
...
Shows the list of Alarm Generators to select from.
...
...
Shows the list of Streams to select from.
...
...
Deletes the selected object from the list.
...
An Archive Task can be created to archive data no longer needed in PhixFlow for processing. When a Stream is archived, PhixFlow creates an Archive Log with useful details of the data archived. Optionally, the archived data can be saved to a file. If this is done, the data can reloaded into PhixFlow using Restore Archive
...
A System Task performs system-wide housekeeping activities. These are:
- Deleting and (optionally) archiving Log Messages
- Deleting Managed File entries.
The archiving periods, and whether to archive log messages before they are deleted, are controlled by the following parameters in System Configuration:
Configuring tasks
The following fields are configured for each task:
...