Versions Compared

Key

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

...

...

...

...

...

...

...

...

...

...

...

...

...

...

...

...

...

Insert excerpt

...

See Also

...

_Banners
_Banners
nametaskPlan
nopaneltrue

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 tables.

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 table. 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 Using Tasks and Task Plans 

See Also

Creating a Task

...

  1. In a task plan

...

  1. properties 

...

  1. Tasks section, click 
    Insert excerpt
    _

...

  1. new
    _

...

  1. new
    nopaneltrue
  2. Select one of the task types from the menu;

...

...

  1. .
  2. PhixFlow opens a new task properties tab.
  3. Enter a name in Basic Settings → Name.

...

Warning

For data in a stream to be deleted or archived, the stream must have Archive Settings applied. If a stream does not have any archive settings, the data will accumulate, leading to performance issues.

Types of Task

...

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

...

Use a rollback task to effectively undo run analysis on a 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.

...

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!!!

...

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 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.

The archiving periods, and whether to archive log messages before they are deleted, are controlled by the following parameters in System Configuration:

...

  1. Specify the order in which the task must be run. This is important if a table depends on the data in other tables.
  2. Insert excerpt
    _save
    _save
    nopaneltrue
    .
  3. Optionally set other properties and add tables.


Task Properties

Insert excerpt
_standard_settings
_standard_settings
nopaneltrue

Basic Settings

FieldDescription
NameEnter the name of the task.
Mandatory

Insert excerpt
_check_box_

...

tick
_check_box_

...

tick
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

...

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

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

...

.

...

...

All tables

Available when Task Type

...

is Table Data Delete Task.

Insert excerpt
_check_box_

...

tick
_check_box_

...

tick
nopaneltrue
 to delete or

...

keep data according to a

...

table's 

...

Data Retention Settings.

 PhixFlow runs this table-data-delete task on all tables that are not listed

...

specifically in another table-data-delete task.

Insert excerpt
_check_box_untick
_check_box_untick
nopaneltrue
 to apply this task to

...

specific tables. Add the streams in the

...

Tables section.

To save

...

a table-data-delete task, it must:

  • either have this option ticked
  • or have at least one

...

  • table.

Streams

...

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 tables
  • Rollback Task: reverses a previous analysis run.
  • Table Data Delete Task: deletes old data from tables; see Deleting Old Data.
  • 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. 


Tables

Tip

When you are creating a new task, remember to name and save the task properties so that the

...

Tables section toolbar becomes available.

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

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

  • a grid that shows the list of tables assigned to the task.

There are different ways

...

to add

...

tables to the list.

  • In the section toolbar, click 
    Insert excerpt
    _table_show
    _table_show
    nopaneltrue
    . PhixFlow shows all the tables in the repository. Drag a table into the grid.
  • From a model, hover your mouse pointer over

...

  • the table to display the

...

  • popup toolbar. Click 
    Insert excerpt
    _object_drag
    _object_drag
    nopaneltrue
     and drag it into the grid.
  • From a model, double-click on a table to open its properties. From

...

  • the table properties, drag the table icon from the top left of the properties tab into the grid.

Image Added

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

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 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

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
    _

...

  1. user_

...

  1. group
    _

...

  1. user_

...

  1. group
    nopaneltrue
     to

...

  1. list

...

  1. all the

...

  1. user groups in the repository.
  2. Drag

...

Image Removed

...

  1. 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.


Live Search
spaceKey@self
additionalnone
placeholderSearch all help pages
typepage

Panel
borderColor#00374F
titleColorwhite
titleBGColor#00374F
borderStylesolid
titleSections on this page

Table of Contents
maxLevel3
indent12px
stylenone