...
...
...
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. |
...
The following fields are configured for task plans:
...
Basic Settings
...
When the task plan configuration is complete, tick this box to enable it for use. To prevent the Task Plan being run, for example during maintenance, untick this box and the Task Plan will not run on the schedule or manually.
...
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 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.
...
Day of Month element of the scheduled date/time, e.g. 1-31.
Day of Month can be specified relative to the end of the month e.g. 'L', the last day of the month, or 'L-2', two days before the last day of the month.
A day of month followed by a 'W' means the nearest week-day to that day in the same month e.g. '15W' means if the 15th falls on a Saturday the TaskPlan will run on the preceding Friday, and if it falls on a Sunday it will be moved to the following Monday, '1W' means the first week-day of the month, and 'LW' means the last week-day in the month.
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
...
You can set up an automated email to be sent with the results of a task plan run.
Emails are generated in an outbound queue and actually sent by a separate email demon process. If it is not possible to send emails immediately, e.g. because the email server is down, the email demon process will try to re-send periodically until either it succeeds or until a timeout period has passed.
...
Notification
...
A list of the users that will be notified with the results of the task plan.
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:
...
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
...
Overview
| Insert excerpt | ||||||
|---|---|---|---|---|---|---|
|
Types of Task
| Anchor | ||||
|---|---|---|---|---|
|
...
- 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
Task Properties
| Insert excerpt | ||||||
|---|---|---|---|---|---|---|
|
Basic Settings
| Field | Description |
|---|---|
| Name | The name of the task. |
| Mandatory | If ticked, when the task plan to which this task is attached, is run this task must succeed before the Analysis Engine will continue with the next task in the task plan. |
| Order | The order that the task will be run in the task plan. |
| Task Type | One of:
|
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
...