...
| 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:
| Field | Description |
|---|---|
| Basic Settings | |
| Name | The name of the task plan. |
| Enabled | When the task plan configuration is complete, tick this box to enable it for use. |
| Scheduled | If ticked, an extra tab section will appear. This allows a regular schedule to be set up for the task plan. |
| Suspend on Failure | If ticked, the Suspended flag will be set to true if any error messages are generated by the Task Plan task plan during execution. |
| Suspended | If the field Suspend on Failure is ticked, if any error messages are generated when the Task Plan task plan is executed this box will be ticked. The next time the Task Plan task plan runs, if this flag is still ticked, it will simply generate a one line error message in the log file stating that it cannot run as it has been suspended. To un-suspend the Task Plantask plan, untick the field.Description |
| Tasks | |
A list of tasks in the task plan. | |
If the Scheduled option is ticked, the following details will become available to edit:
| Field | DescriptionTo add a task, click | |
|---|---|---|
| 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. | ||
| Seconds | Seconds element of the scheduled date/time, e.g. 0-59. | |
| Minutes | Minutes element of the scheduled date/time e.g. 0-59. | |
| Hours | Hours element of the scheduled date/time, e.g. 0-23. | |
| Day of Month | 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 | 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 | 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 | |
| Year | Year element of the scheduled date/time, e.g. 1970-2099. | |
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:
...
| Send |
...
| By Email |
...
You can set up an automated email to be sent with the results of a |
...
task plan run. |
...
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.
| Field | Description||
|---|---|---|
| Email From | The Email Address the generated email will appear from. | |
| Subject Expression | Allows the user to build a PhixFlow Expression which will be used to create the Email Subject. The internal variables _errors, _warnings, _messages and _taskPlan can be used in the Subject Expression. | |
| Message Expression | Allows the user to build a PhixFlow Expression which will be used to create the message body of the email. The internal variables _errors, _warnings, _messages and _taskPlan can be used in the Message Expression. | |
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.
| Notification | |
A list of the users that will be notified with the results of the task plan. This section contains the additional button 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 | |
| User | Select a user configured in PhixFlow from the drop down list. |
| Email As | Choose one of:
|
| Expression | 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. 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 | |
| Description | Description of the task plan. |
| Anchor | ||||
|---|---|---|---|---|
|
Analysis tasks run analysis on a number of streams.
| Anchor | ||||
|---|---|---|---|---|
|
...
The following fields are configured for each task:
| Field | Description |
|---|---|
| Basic Settings | |
| 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. | |
| Streams | |
A list of streams assigned to the task. This section only appears for analysis tasks and archive tasks. HELPDEVTODO: no stream icon | |
| Description | |
| Description | Description of the |
| task. |
The following fields are configured through separate tabs on the form:
| Field | Description |
|---|---|
| Streams | Streams can be dragged onto the list to add them to the list of Streams to be archived by this Task. 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 also provides the following icons on the Streams tab:
