Versions Compared

Old Version 44

changes.mady.by.user Fiona Sargeant (Unlicensed)

Saved on

compared with

New Version 45

changes.mady.by.user Fiona Sargeant (Unlicensed)

Saved on

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.

...

Running Task Plans

Excerpt

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.

When a task plan runs, the listed 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.

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.

...

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.

...