AX2559

Scheduler task: Create Plan Files

This task creates plan files for a file group. It works the same way as the Create Plan Files utility that is available from the file group menu.

This task has two tabs of settings in the Task Details area: General and Plan Files.

NOTE: If you are using Create Plan Files to create new on-demand plan files, those plan files will be automatically started in the designated Plan File Process for the file group. This only applies when creating a brand new plan file. If an existing plan file is overwritten, its process status will be left as is.

General tab

The following settings are available on the General tab:

Item	Description
Select File Group	The file group for which plan files will be created. You can select any file group or file group alias. NOTE: If you select an alias, then you cannot select individual plan files on the Plan Files tab. Only the Use Filter and All options are supported for use with aliases. This is because the alias could change to point to any file group, which could result in a different list of plan files.
Overwrite existing plan files?	By default, this option is not selected, which means that existing plan files will not be overwritten, even if the plan file is selected to be created. If selected, existing plan files will be overwritten.

Item

Description

Select File Group

The file group for which plan files will be created. You can select any file group or file group alias.

NOTE: If you select an alias, then you cannot select individual plan files on the Plan Files tab. Only the Use Filter and All options are supported for use with aliases. This is because the alias could change to point to any file group, which could result in a different list of plan files.

Overwrite existing plan files?

By default, this option is not selected, which means that existing plan files will not be overwritten, even if the plan file is selected to be created.

If selected, existing plan files will be overwritten.

Plan Files tab

On the Plan Files tab, specify the plan files that you want to create. This tab lists all plan codes that you have the right to access. (If a plan code has been set to False in the designated Show On List Column for the plan code table, then it is not available in this list.)

You can create plan files in any of the following ways:

Create all plan files: To create all plan files, select All. This will cause all plan files to be created, for all existing and future plan codes.

Alternatively, you can select Choose from list and then select the check box in the column header, causing all plan codes to be selected, but then the list of plan codes is fixed and will not adjust for any future changes. For example, if you add a new department in the future, that new department will only be created by this task if you use the All option.
Create selected plan files: To create certain plan files, select Choose from list and then select the check boxes for the desired plan codes.

To find the plan files you are looking for, you can sort, filter, and group the list using standard Axiom grid features. You can show additional columns and hide columns by right-clicking in the column header. If you have filtered the list, you can select the check box in the header to select only the plan codes that currently display in the dialog.

NOTE: This option is not available when using a file group alias as the selected file group for the task. This is because the alias could change to point to any file group, which could result in a different list of plan files.
Create a subset of plan files using a filter: To use a filter to create a subset of plan files, select Use filter, and then type a filter into the filter box. You can also use the Filter Wizard to build the filter. The filter must use the plan code table or a reference table that the plan code table links to. For example: DEPT.Region='West'.

Once you have entered a filter, you can click Refresh plan file list to show only those plan codes that currently match the filter. This feature is to help you determine whether you have defined the filter as intended. The filter will be applied to the list of plan codes when the Scheduler job is processed, so if changes have been made to the plan code table since then, the actual list of plan files processed will reflect those changes.

You can also use a job variable for the filter. For example, you can define a job variable named "filter" and then place the text {filter} in the filter box. This is intended for use when running Scheduler jobs by using the RunEvent function. If a value is specified in the RunEvent function, such as "Filter=dept.region='west'", then that filter will be used in place of the {filter} variable to determine the list of plan files to be created.

NOTE: If you use a variable, and you leave the default value for that variable blank within the Job Variables tab, then all plan codes will be created if no value is passed by the RunEvent function (or if the value is invalid). You may want to define a default filter that results in no values (such as 1=0), so that plan files are only created if a valid filter value is passed.

IMPORTANT: For all of these options, the Overwrite existing plan files option on the General tab determines whether all selected plan files are created, or only the plan files that do not already exist.