...
...
...
...
...
...
Tasks are configured to run in a certain order in a Task Plans, and can be set up to run on a scheduled date at a scheduled time.
| Panel | ||||
|---|---|---|---|---|
| ||||
A task plan that contains 1 task with 3 streams will process all streams at the same time. Whereas a task plan with 3 tasks, each containing 1 stream, will run the streams one by one. It will wait for the previous task to complete, before starting the next. If a mandatory task fails, then the next task should not be started. |
| Insert excerpt | ||||||||
|---|---|---|---|---|---|---|---|---|
|
...
...
...
...
Analysis tasks run analysis on a number of streams.
...
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.
...
A System Task performs 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:
- Delete Log Messages After Days
- Archive Deleted Log Messages To File
- Delete Statistics After Days
- Delete Emails After Days
Configuring tasks
The following fields are configured for each task:
...
Basic Settings
...
One of:
- Analysis Task
- Archive Task
- System Task
...
Streams
...
A list of streams assigned to the task. This section only appears for analysis tasks and archive tasks.
Press the button to bring up the list of streams - drag streams into this list so that they will be run (for analysis tasks) or archived (for archive tasks). 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 task.
...
Description
...
See Also
...
...
When the task plan configuration is complete, tick this box to enable it for use. To prevent the Task Plan being run, for example during maintenance, untick this box and the Task Plan will not run on the schedule or manually.
...
Tasks
...
A list of tasks in the task plan.
To add a task, click 
and select the type of task you wish to add:
...
Schedule
...
This section only appears if the Scheduled box in Basic Settings is ticked.
Each of these elements can be specified with an explicit value (e.g 6), a range (e.g 9-12), a repeating group (e.g. 5/10 - equivalent to 5,15,25,35,...), or a list of single values, ranges, etc. e.g. 1,3-5,10,20/5.
Each of these elements other than Seconds can be set to a wild card ('*'), meaning all values.
...
Day of Month element of the scheduled date/time, e.g. 1-31.
Day of Month can be specified relative to the end of the month e.g. 'L', the last day of the month, or 'L-2', two days before the last day of the month.
A day of month followed by a 'W' means the nearest week-day to that day in the same month e.g. '15W' means if the 15th falls on a Saturday the TaskPlan will run on the preceding Friday, and if it falls on a Sunday it will be moved to the following Monday, '1W' means the first week-day of the month, and 'LW' means the last week-day in the month.
Day of Week and Day of Month are mutually exclusive. One must be set to '?' (meaning no value specified), and the other defines the days that this Task Plan runs on.
...
Month element of the scheduled date/time, e.g. 1-12
Month can also be specified as short names e.g. JAN,OCT-DEC
...
Day of week element of the scheduled date/time, e.g. 1-7. The week starts on Sunday. So Sunday = 1, Monday = 2, etc.
Day of Week can also be specified as short names e.g. MON,WED-FRI
A day of week name or number followed by an 'L' means the last day of week in the month e.g. 'FRIL' means the last Friday, '2L' means the last Monday.
A day of week name or number followed by a hash ('#') and a number means the Nth day of week in the month e.g. '2#2' means the 2nd Monday in the month, 'FRI#5' means the 5th Friday in the month - if there is no 5th Friday in the month, that is equivalent to specifying no day of week.
If the '#' character is used, there can only be one expression in the day-of-week field, so "3#1,6#3" is not valid, since there are two expressions.
Day of Week and Day of Month are mutually exclusive. One must be set to '?' (meaning no value specified), and the other defines the days that this Task Plan runs on
...
You can set up an automated email to be sent with the results of a task plan run.
Emails are generated in an outbound queue and actually sent by a separate email demon process. If it is not possible to send emails immediately, e.g. because the email server is down, the email demon process will try to re-send periodically until either it succeeds or until a timeout period has passed.
...
Notification
...
A list of the users that will be notified with the results of the task plan.
This section contains the additional button 
- this will bring up the list of users in PhixFlow. Drags users into this list to add them as an email recipient.
Doing this will add the users with a blank notification rule, which means that the users will get an email every time this task plan runs. Edit the users in the list to update the notification rule, or add users manually using the 
button. For each user notification rule configure the following settings:
...
Choose one of:
- To
- Cc
- Bcc
...
An Expression which governs whether the recipient will receive the email generated by the Task Plan on completion. The internal variables _errors, _warnings, _messages and _suspended can be used in the User Notification Expression.
In particular, the _suspended variable can be used to send an email to a recipient only if a Task in the Task Plan failed - leading to the Task Plan being suspended. While a Task Plan is suspended, no further emails will be sent even if the Task Plan is scheduled to run.
Further, using the _errors variable, this expression can be set up so that a recipient is sent an email only if there are more than a certain number of error messages.
...
Description
...
| |||||||||||||||||
| All tables | Available when Task Type is Table Data Delete Task.
PhixFlow runs this table-data-delete task on all tables that are not listed specifically in another table-data-delete task.
To save a table-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.
|
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
. PhixFlow shows all the tables in the repository. Drag a table into the grid.Insert excerpt _table_show _table_show nopanel true - From a model, hover your mouse pointer over the table to display the popup toolbar. Click
and drag it into the grid.Insert excerpt _object_drag _object_drag nopanel true - 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.
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:
- 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. |
| Live Search | ||||||||
|---|---|---|---|---|---|---|---|---|
|
| Panel | ||||||||||
|---|---|---|---|---|---|---|---|---|---|---|
| ||||||||||
|