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 Tasks, Task Plans and Archiving

Creating a Task

In a task plan properties → Tasks section, click Add.
Select one of the task types from the menu; see Types of Task.
PhixFlow opens a new task properties tab.
Enter a name in Basic Settings → Name.
Specify the order in which the task must be run. This is important if a stream depends on the data in other streams.
Save.
Optionally set other properties and add streams.

Task Properties

For information about the properties toolbar, and about the sections Parent Details, Analysis Models, Description and Audit Summary, see Common Properties. For a full list of all the PhixFlow property tabs and windows, see Property Tabs.

Basic Settings

Field	Description
Name	Enter the name of the task.
Mandatory	Tick to specify that this task must succeed before attempting the next task in the task plan. Untick to specify that, even if this task fails, the next task in the task plan can run.
Order	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 Type	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 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. 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.
All Streams	Available when Task Type is Stream Data Delete Task. Tick to delete or keep data according to a stream's Data Retention Settings. This applies to all streams that are not listed in any Stream Data Delete Task task. Untick to apply this task to one or more streams. Add the streams in the Streams section. To save Stream Data Delete Task task, it must: either have this option ticked or have at least one stream.

Streams

This section is only 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.

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 to add streams to the list.

In the section toolbar, click Show streams. 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 Drag Object 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 User Groups.

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:

Click User Groups to list all the user groups in the repository.
Drag user groups into this list to add them to the task.

To remove a user group from the role, use the Permanently Delete in the toolbar.

File Settings

Field	Description
File Name	Enter the file name for the zip file that the task generates.
File Description	Enter 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.

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.

Task