PhixFlow Help
Task Plans
Running Task Plans
You can run a task plan:
- manually, using the property tab toolbar button Start Task Plan.
- automatically at a scheduled date and time, using the Scheduled check box and related Schedule section.
- by linking it to an application action, in the action properties → Run Task Plan section; see Action.
When the user clicks something in the application, such as a button or a data row, the task plan runs.
When a task plan runs, its tasks are run in the order they are listed.
You can optionally set up a list of users who will receive an email about the outcome of running the task plan.
Task Plan Properties
For information about the properties toolbar, and about the sections Parent Details, Analysis Models, Description and Audit Summary, see Common Properties. For a full list of all the PhixFlow property tabs and windows, see Property Tabs.. The property tab toolbar includes the Start Task Plan button. Click this to manually run the task plan.
Basic Settings
Field | Description |
---|---|
Name | The name of the task plan. |
Enabled | Tick to indicate the task plan configuration is complete and it can be run. Untick to prevent the task plan being run. For example, during maintenance, you may not want the task plan to run at the scheduled time. |
Scheduled | Tick to add a Schedule section to the properties, where you can configure the day and time that the task plan will run. Untick for task plans that you want to run manually. |
Suspend on Failure | Tick to set PhixFlow to automatically tick the Suspended checkbox if running the task plan generates an error message. You can find the error messages in the log file; see Server Log Files. Untick so that a task plan can report errors without preventing the next run. |
Suspended | Tick prevents the next run of the task plan. PhixFlow automatically ticks this box if the task plan generated an error message on its previous run. This means the task plan will not run again until you have:
Untick indicates the task plan can run as no errors were reported in the previous run. |
Tasks
This section has a toolbar with standard buttons. The grid contains a list of of tasks in the task plan. To create a task and add it to the list:
- Click Add. PhixFlow displays a list of task types; see Types of Task.
- Select a task type.
- Complete the task properties; see Task.
To remove tasks, use the toolbar button Permanently Delete.
Schedule
This section is displayed when Basic Settings → Scheduled is ticked. Specify the day and time on which the task plan runs.
In the fields, you can enter:
- an explicit value:
6
- a range:
9-12
- a repeating group:
5/10
This is equivalent to5,15,25,35
etc. - a comma-separated list of single values, ranges or repeating groups:
1,3-5,10,20/5
- a wild card to mean all values:
*
Note: You cannot use a wild card in the Seconds field.
The Schedule section has fields for Day of Month and Day of Week . These fields are mutually exclusive. Use one to specify a day, and enter a ?
to indicate no value is specified in the other.
Field | Description |
---|---|
Seconds | Enter the seconds part of the scheduled time, for example, 0-59. |
Minutes | Enter the minutes part of the scheduled time, for example, 0-59. |
Hours | Enter the hours part of the scheduled time, for example, 0-23. |
Day of Month | Enter the day of the scheduled date. You can enter:
|
Month | Enter the month of the scheduled date. You can enter the months as:
The month short names must be in block capital letters. |
Day of Week | Enter the day of the scheduled date. You can enter:
|
Year | Enter the year of the scheduled date, for example, 2020. You can specify a range of years, for example, 1970-2099. |
Send By Email
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 are sent by a separate email demon process. If the demon cannot send the emails immediately, for example, because the email server is down, the email demon process will try to re-send periodically until:
- either it succeeds
- or it exceeds a timeout period.
Field | Description |
---|---|
Email From | Enter the email address from which the generated email will appear to be sent. |
Subject Expression | Enter a PhixFlow expression to create the email subject. The expression must evaluate to a plain text string. Use the internal variables _errors, _warnings, _messages, _suspended and _taskPlan. |
Message Expression | Enter a PhixFlow Expression to create the message body for the email. The expression must evaluate to a plain text string. Email messages can have unlimited characters. Use the internal variables _errors, _warnings, _messages, _suspended and _taskPlan. |
Notification | This section has a toolbar with standard buttons. The grid contains a list of the notification rules that belong to the task plan. To create and add a notification to the list, cick Add. PhixFlow opens the properties tab for a new User Notification Rule.
To remove a user notification rule from the task, use the toolbar button Permanently Delete. |
Please let us know if we could improve this page feedback@phixflow.com