Versions Compared

Key

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

Overview

Insert excerpt
Task Plan
Task Plan
nopaneltrue

...

Creating a Task

  1. In  task plan properties→ Tasks, click 
    Insert excerpt
    _add
    _add
    nopaneltrue
  2. Select one of the task types from the menu; see Types of Task, below.
  3. PhixFlow opens a new task properties tab.
  4. Enter a name in Basic Settings → Name.
  5. Insert excerpt
    _save
    _save
    nopaneltrue
    .
  6. Optionally set other properties and add streams; see Task Properties, below

Types of Task

Anchor
analysisTask
analysisTask
Analysis Tasks

...

Use an analysis task to run analysis on the stream(s) in the task. 

Anchor
rollbackTask
rollbackTask
Rollback Tasks

Use a rollback task to effectively undo run analysis on a number of streams.stream.  When you run a rollback task it rolls back all data in each of the listed streams, deleting the stream-sets. The list of stream sets is empty and there are no data records in the stream (tbc). For information about how to rollback streams manually, see Rollback.

Anchor
archiveTask
archiveTask
Archive Tasks

An Archive Task can be created to archive data no longer needed in PhixFlow for processing. When a Stream is archived, PhixFlow creates an Archive Log with useful details of the data archived. Optionally, the archived data can be saved to a file. If this is done, the data can reloaded into PhixFlow using Restore Archive.

If you set up an archive task with no stream added, all streams configured for archive will be archived by this task, unless this stream has been added to another archive task. Even if you set up a catch-all archive task in this way, you might still want to have separate archiving for certain streams if they contain large amounts of data for each run, in which case archiving can sometimes task a while - this means you can schedule archiving for these streams in particular at a time when you system is quiet.

...

A Rollback Task can be created to roll-back one or more streams. On execution, it fully rolls back all data in the stream, deleting the stream-sets.Use an archive task to delete or archive stream data or stream sets that you no longer need in PhixFlow. Running an archive task on a large number of streams, or on a stream with a large data set can take some time. We recommend scheduling archiving tasks for times when the system is quiet, for example overnight.

Note

All streams in an archive task must have their Archive Settings specified.

Archive without specifying streams

You can create an archive task without adding any streams. This task will affect streams:

  • that are not in another archive task
  • and have archiving settings configured.

When you run the task, PhixFlow:

  • deletes stream sets that are older than the specified archive settings in the stream
  • creates a zip archive of all the stream sets within the specified archive settings in the stream.
    This is a single archive containing all the data from all the streams processed.


Archiving a specific stream

If you want to have separate zip files containing data for a specific stream, create an archive task and add only that stream. The stream must have Archive Settings.

You can create an archiving task for a specific stream or streams. For example, you might want to create a single archive for:

  • data from several related streams
  • a stream that contains a large amount of data  
  • a stream that you want to be able to restore from the backup. This is easier when the data is in its own zip.

Finding the Archive file

When a stream is archived, PhixFlow logs information in the system console →  Archive Log. This includes information about the data archived and any archive file created. This is a single archive containing all the data from the streams processed.. Optionally, the archived data can be saved to a file. If this is done, the data can reloaded into PhixFlow using Restore Archive.

Note

This should be a warning in the Streams page.

Streams that do not have any Archive Settings will never have their data deleted or archived. This can cause large amounts of data to build up in PhixFlow, affecting performance. Remember to set your archive settings!!!


Anchor
systemTask
systemTask
System Tasks

A System Task performs Use a system task to perform system-wide housekeeping activities. These include deleting:

  • and optionally archiving log messages
  • managed file entries
  • email entries
  • temporary files created by file exporters to send by email
  • data from incomplete stream sets.
Note

The System Task system task should be run daily, or at a minimum every week. If incomplete stream sets are not deleted, they can slow down PhixFlow's performance. Depending on your PhixFlow database, queries that have to exempt many incomplete stream sets can reach system limits. This can prevent PhixFlow and its applications from running.

...

Basic Settings

FieldDescription
NameThe Enter the name of the task.
MandatoryIf ticked, when the task plan to which this task is attached, is run this task must succeed before the Analysis Engine will continue with the

Insert excerpt
_check_box_ticked
_check_box_ticked
nopaneltrue
 to specify that this task must succeed before attempting the next task in the task plan.

Insert excerpt
_check_box_untick
_check_box_untick
 to specify that, even if this task fails, the next task in the task plan can run.

OrderThe Specify the order that the task will be run in the task plan. For example, if there are a total of 4 tasks in the task plan, and you want this task to run third, enter 3.
Task TypeOne of

PhixFlow displays the type of this task, which can be:

  • Analysis Task
  • Archive Task
  • Rollback Task
  • System Task
Tip

You select the task type when first add the task. This field is visible after the task is saved for the first time. You cannot change the task type. 


Streams

This section is only available for analysis tasks and archive tasks. The grid shows the list of streams assigned to the task.

Tip

When you are creating a new task, remember to name and save the task properties so that the Streams section toolbar becomes available.

There are different ways you can add streams to the list.

  • From a model, hover your mouse pointer over the stream to display the pop-up toolbar. Click 
    Insert excerpt
    _object_drag
    _object_drag
    nopaneltrue
     and drag it into the grid.
  • From the repository, click 
    Insert excerpt
    _streams_show
    _streams_show
    nopaneltrue
     to display the list of the streams in the repository. Drag a stream from the list into the grid.
  • From the stream properties, drag the icon into the grid.

Remember that for archive tasks, if no streams are added, all streams that have archiving configured will be archived, unless they have been added to another archive taskIf you add multiple streams to the task, PhixFlow will process the streams in any order when the task runs. Only use this method if there is you are sure there are no dependencies between the streams.