Creating a Task
- In a task plan properties → Tasks section, click
.Insert excerpt _add _add nopanel true - 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.
.Insert excerpt _save _save nopanel true - Optionally set other properties and add streams.
Task Properties
Insert excerpt | ||||||
---|---|---|---|---|---|---|
|
Basic Settings
Field | Description | ||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
Name | Enter the name of the task. | ||||||||||||||||
Mandatory |
| ||||||||||||||||
All Streams | Available when Task Type is Stream Data Delete Task.
PhixFlow runs this stream-data-delete task on all streams that are not listed specifically in another stream-data-delete task.
To save a stream-data-delete task, it must:
| ||||||||||||||||
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 | Available when a new task has been saved. PhixFlow displays the type of this task, which can be:
See Types of Task for details.
|
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
. PhixFlow shows all the streams in the repository. Drag a stream into the grid.Insert excerpt _streams_show _streams_show nopanel true - From a model, hover your mouse pointer over the stream to display the pop-up toolbar. Click
and drag it into the grid.Insert excerpt _object_drag _object_drag nopanel true - 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 nopanel true
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
to list all the user groups in the repository.Insert excerpt _user_group _user_group nopanel true - Drag user groups into this list to add them to the task.
To remove a user group from the role, use the
Insert excerpt | ||||||
---|---|---|---|---|---|---|
|
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:
|
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. |