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.
| Anchor | ||||
|---|---|---|---|---|
|
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. |
Form: Task Plan Details
| Field | Description |
|---|---|
| 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 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 during execution. |
| Suspended | If the field Suspend on Failure is ticked, if any error messages are generated when the Task Plan is executed this box will be ticked. The next time the 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 Plan, untick the field. |
| Description | Description of the task plan. |
If the Scheduled option is ticked, the following details will become available to edit:
| Field | Description |
|---|---|
| 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.
...
The Task list provides some of the standard list icons. The Task list also provides the icon:
IconRepository > add16x16.png" data-linked-resource-default-alias="add16x16.png" data-linked-resource-container-id="97734861" data-linked-resource-container-version="1" data-location="HELP78 > IconRepository > add16x16.png" data-linked-resource-id="97741340" data-linked-resource-version="1" data-linked-resource-type="attachment" data-unresolved-comment-count="0" data-linked-resource-content-type="image/png" data-media-type="file" data-media-id="2b220f20-79c7-4a69-8f27-1792e45a21e2" data-base-url="https://phixflow.atlassian.net/wiki" data-image-width="16" data-image-src="https://phixflow.atlassian.net/wiki/download/attachments/97734861/add16x16.png?version=1&modificationDate=1444149573369&cacheVersion=1&api=v2" data-image-height="16" width="16"> | Add a new Task to the Task Plan. This brings up a menu, and the user chooses which type of Task to add: |
Form: Send Result By Email
On this tab you can set up an automated email to be sent with the results of a Task Plan run.
| 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:
IconRepository > user16x16.png" data-linked-resource-default-alias="user16x16.png" data-linked-resource-container-id="97734861" data-linked-resource-container-version="1" data-location="HELP78 > IconRepository > user16x16.png" data-linked-resource-id="97741634" data-linked-resource-version="1" data-linked-resource-type="attachment" data-unresolved-comment-count="0" data-linked-resource-content-type="image/png" data-media-type="file" data-media-id="6329f47f-5c50-4387-8c39-1fb59e1e9e99" data-base-url="https://phixflow.atlassian.net/wiki" data-image-width="16" data-image-src="https://phixflow.atlassian.net/wiki/download/attachments/97734861/user16x16.png?version=1&modificationDate=1444149572288&cacheVersion=1&api=v2" data-image-height="16" width="16"> | 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. |
IconRepository > add16x16.png" data-linked-resource-default-alias="add16x16.png" data-linked-resource-container-id="97734861" data-linked-resource-container-version="1" data-location="HELP78 > IconRepository > add16x16.png" data-linked-resource-id="97741340" data-linked-resource-version="1" data-linked-resource-type="attachment" data-unresolved-comment-count="0" data-linked-resource-content-type="image/png" data-media-type="file" data-media-id="2b220f20-79c7-4a69-8f27-1792e45a21e2" data-base-url="https://phixflow.atlassian.net/wiki" data-image-width="16" data-image-src="https://phixflow.atlassian.net/wiki/download/attachments/97734861/add16x16.png?version=1&modificationDate=1444149573369&cacheVersion=1&api=v2" data-image-height="16" width="16"> | 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.
...
 | Shows the list of Streams to select from. |
 | Deletes the selected object from the list. |
| Anchor | ||||
|---|---|---|---|---|
|