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 and the different types of task. It also explains strategies for tasks that affect streams.

Overview

When working with data, applications and IT systems, there are routine processes that you need to run. A task is a specific job, often linked to a stream. You do not run tasks directly. You must add them to a task plan; see Task Plans.

The task properties tab is not available from the repository. It opens from the task plan properties tab.

For information about how tasks and task plans work together, and about types of task, see About Using Tasks and Task Plans 

See Also


Panel
borderColor#7da054
titleColorwhite
titleBGColor#7da054
borderStylesolid
titleSections on this page

Table of Contents
indent12px
stylenone


Creating a Task

  1. In a task plan properties → Tasks section, click 
    Insert excerpt
    _add
    _add
    nopaneltrue
  2. Select one of the task types from the menu; see Types of Task.
  3. PhixFlow opens a new task properties tab.
  4. Enter a name in Basic Settings → Name.
  5. Specify the order in which the task must be run. This is important if a stream depends on the data in other streams.
  6. Insert excerpt
    _save
    _save
    nopaneltrue
    .
  7. Optionally set other properties and add streams.

Task Properties

Insert excerpt
_standard_settings
_standard_settings
nopaneltrue

Basic Settings

FieldDescription
NameEnter the name of the task.
Mandatory

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
nopaneltrue
 to specify that, even if this task fails, the next task in the task plan can run.

All Streams

Available when Task Type is Stream Data Delete Task.

Insert excerpt
_check_box_ticked
_check_box_ticked
nopaneltrue
 to delete or keep data according to a stream's Data Retention Settings.

 PhixFlow runs this stream-data-delete task on all streams that are not listed specifically in another stream-data-delete task.

Insert excerpt
_check_box_untick
_check_box_untick
nopaneltrue
 to apply this task to specific streams. Add the streams in the Streams section.

To save a stream-data-delete task, it must:

  • either have this option ticked
  • or have at least one stream.
OrderSpecify 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 Type

Available when a new task has been saved.

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

  • Analysis Task: runs analysis on selected streams
  • Rollback Task: reverses a previous analysis run.
  • Stream Data Delete Task: deletes old data from streams.
  • System Task: runs system maintenance processes
  • Configuration Export Task: exports selected items or a full configuration as a zip file and saves it to the download area; see Using the Download Area and Configuring the Download Area.

See Types of Task for details.

Tip

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


Streams

Tip

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

This section is available when Task Type is Analysis Task or Stream Data Delete Task.

Use this section to specify the streams that the task affects. This section has:

  • a toolbar with standard buttons
  • a grid that shows the list of streams assigned to the task.

There are different ways to add streams to the list.

  • In the section toolbar, click 
    Insert excerpt
    _streams_show
    _streams_show
    nopaneltrue
    . PhixFlow shows all the streams in the repository. Drag a stream into the grid.
  • 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 a model, double-click on a stream to open its properties. From the stream properties, drag the stream icon from the top left of the properties tab into the grid.

If you add multiple streams to the task, PhixFlow will process the streams in any order when the task runs. Only use this method you are sure there are no dependencies between the streams.

Additional Sections for Configuration Export Tasks

The following sections are only available when Task Type is Configuration Export Task

Items to Export

This section has:

  • the Export Full Configuration check box
  • a toolbar with standard buttons
  • a grid that shows the list of items to export.

All the specified items will be saved into a single zip file. Specify the file name and description in the File Settings section.

User Groups

This section has a toolbar with standard buttons and 

Insert excerpt
_user_group
_user_group
nopaneltrue
.

The grid contains a list of user groups whose members can either run the task or access the generated files in the download area. To add a user group to the list:

  1. Click
    Insert excerpt
    _user_group
    _user_group
    nopaneltrue
     to list all the user groups in the repository.
  2. Drag user groups into this list to add them to the task. 

To remove a user group from the role, use the

Insert excerpt
_delete
_delete
nopaneltrue
 in the toolbar.

File Settings

FieldDescription
File NameEnter the file name for the zip file that the task generates.
File DescriptionEnter a description. This text will appear in:
  • the download area
  • the header.xml file in the configuration export zip file
  • log file messages generated by the export process and when the file is imported.


Mandatory Tasks

The tasks are run in the order they are listed in the the task plan.

You can specify that a task is Mandatory. If a mandatory task fails, PhixFlow will not run the following task in the task plan. You must resolve the issue preventing the task from running and then restart the task.

Note

Rerunning a task plan that previously failed means it continues that run from where it failed.

If data related to an previous task has changed this is not reflected in the results of the rerun. 

This means that after you have rerun a previously failed task, consider running the task again, to ensure all data or processes are up-to-date.