...
...
...
...
...
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 | ||||||||
|---|---|---|---|---|---|---|---|---|
|
...
...
Basic Settings
...
...
Tasks
...
A list of tasks in the task plan.
To add a task, click 
and select the type of task you wish to add:
...
Schedule
This section only appears if the Scheduled box in Basic Settings is ticked.
...
...
...
...
Each of these elements other than Seconds can be set to a wild card ('*'), meaning all values.
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
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
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
Choose one of:
- To
- Cc
- Bcc
...
An Expression which governs whether the recipient will receive the email generated by the Task Plan on completion. The internal variables _errors, _warnings, _messages and _suspended can be used in the User Notification Expression.
In particular, the _suspended variable can be used to send an email to a recipient only if a Task in the Task Plan failed - leading to the Task Plan being suspended. While a Task Plan is suspended, no further emails will be sent even if the Task Plan is scheduled to run.
Further, using the _errors variable, this expression can be set up so that a recipient is sent an email only if there are more than a certain number of error messages.
...
Description
...
Analysis tasks run analysis on a number of streams.
...
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.
If you set up an archive task with no stream added, all streams configured for archive will be archived by this task, unless this stream has been added to another archive task. Even if you set up a catch-all archive task in this way, you might still want to have separate archiving for certain streams if they contain large amounts of data for each run, in which case archiving can sometimes task a while - this means you can schedule archiving for these streams in particular at a time when you system is quiet.
...
A Rollback Task can be created to roll-back one or more streams. On execution, it fully rolls back all data in the stream, deleting the stream-sets.
...
A System Task performs system-wide housekeeping activities. These include deleting:
- and optionally archiving log messages
- managed file entries
- email entries
- temporary files created by file exporters to send by email
- data from incomplete stream sets.
| 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:
- Delete Log Messages After Days
- Archive Deleted Log Messages To File
- Delete Statistics After Days
- Delete Emails After Days
Configuring tasks
The following fields are configured for each task:
...
Basic Settings
...
One of:
- Analysis Task
- Archive Task
- System Task
...
Streams
...
A list of streams assigned to the task. This section only appears for analysis tasks and archive tasks.
Press the button to bring up the list of streams - drag streams into this list so that they will be run (for analysis tasks) or archived (for archive tasks). Remember that for archive tasks, if no streams are added, all streams that have archiving configured will be archived, unless they have been added to another archive task.
...
Description
...
See Also
...
This section contains the additional button 
- this will bring up the list of users in PhixFlow. Drags users into this list to add them as an email recipient.
Doing this will add the users with a blank notification rule, which means that the users will get an email every time this task plan runs. Edit the users in the list to update the notification rule, or add users manually using the 
button. For each user notification rule configure the following settings: