Versions Compared

Key

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

Overview

Excerpt

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 and are configured to run in a specific order. Task plans can be requested by users, triggered by actions or schedule to run on a specific date and time.

Panel
bgColor#e6f0ff
titleBGColor#99c2ff
titleTasks and Streams

A task plan that contains 1 task with 3 streams will process all streams at the same time.

A task plan that contains 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.


...

Insert excerpt
_standard_settings
_standard_settings
nopaneltrue

Basic Settings

FieldDescription
NameThe name of the task plan.
Enabled

When the task plan configuration is complete, tick this box to enable it for use. To prevent the Task Plan being run, for example during maintenance, untick this box and the Task Plan will not run on the schedule or manually.

ScheduledIf ticked, an extra section will appear. This allows a regular schedule to be set up for the task plan.
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.

...

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

Schedule

This section only appears if the Scheduled box in Basic Settings is ticked.

...

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 actually sent by a separate email demon process. If it is not possible to send emails immediately, e.g. 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 the generated email will appear from.
Subject ExpressionAllows the user to build a PhixFlow Expression which will be used to create the Email Subject. The internal variables _errors, _warnings, _messages, _suspended  and _taskPlan can be used in the Subject Expression.
Message ExpressionAllows 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_suspended and _taskPlan can be used in the Message Expression.

...