Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

This page is for data modellers, application designers and system administrators. It explains how to create a task plan, which will run one or more tasks.

...

When working with data, applications and IT systems, there are routine processes that you need to run. PhixFlow makes it easy for you to set up and manage these processes using task plans. For example:

  • application designers or system administrators can automatically update data in applications
  • data modelers can run analysis on models or specific streams 
  • administrators can clear old information from the PhixFlow system, by archiving data from:
    • stream sets
    • processing logs
    • performance statistics.

Use the task plan properties tab to configure a task plan. Set the options and add individual Tasks., to which you add Tasks.

See Also

Running Task Plans

You can run a task plan:

  • manually, using the toolbar button 
    Insert excerpt
    _taskplan_start
    _taskplan_start
    nopaneltrue
  • automatically at a scheduled date and time, using the Scheduled check box and related Schedule section
  • by linking it to an application action. When the user clicks a button or item in the application, the task plan runs.

...

You can optionally set up a list of users who will receive an email about the outcome of running the task plan.

See Also

...

Properties

Insert excerpt
_standard_settings
_standard_settings
nopaneltrue

Basic Settings

FieldDescription
NameThe name of the task plan.
Enabled

Insert excerpt
_check_box_ticked
_check_box_ticked
nopaneltrue
 to indicate the task plan configuration is complete and it can be run.

Insert excerpt
_check_box_untick
_check_box_untick
nopaneltrue
 to prevent the task plan being run. For example, during maintenance, you may not want the task plan to run at it's scheduled time.

Scheduled

Insert excerpt
_check_box_ticked
_check_box_ticked
nopaneltrue
 to add a Schedule section to the properties, where you can configure the day and time that the task plan will run. 

Insert excerpt
_check_box_untick
_check_box_untick
nopaneltrue
 for task plans that you want to run manually. 

Suspend on FailureIf ticked, the Suspended flag will be set to true if any error messages are generated by the task plan during execution.
SuspendedIf the field Suspend on Failure is ticked, this box will be ticked by the system if any error messages are generated when the task plan is executed. This indicates that there is a problem which should be fixed before the Task Plan is run again. 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.

Tasks

A list of tasks in the task plan; see Task. To add a task, click  and select the type of task you want to add; see Types of Task.

Schedule

This section is displayed when Basic Settings → Scheduled is ticked. Specify the day and time at which the task plan runs. In the fields, you can enter:

...

FieldDescription
SecondsSeconds element of the scheduled date/time, e.g. 0-59.
MinutesMinutes element of the scheduled date/time e.g. 0-59.
HoursHours 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 task plan 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

YearYear element of the scheduled date/time, e.g. 1970-2099.

Anchor
email_user
email_user
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 until a timeout period has passed.

FieldDescription
Email FromThe email address from which the generated email will appear to be sent.
Subject ExpressionEnter a  PhixFlow Expression to create the Email Subject. Use the internal variables _errors, _warnings, _messages, _suspended  and _taskPlan.
Message ExpressionEnter a PhixFlow Expression to create the message body of the email. Use the internal variables _errors, _warnings, _messages_suspended and _taskPlan.

Notification

A list of the users that will be notified with the results of the task plan.

...