AX1752
Scheduler task: Copy On Demand Plan Files
This task copies on demand plan files from one file group to another. It performs the same actions as the Copy On Demand Plan Files command in the Command Library.
This is an advanced feature and should only be used if it is the only way to achieve the desired population of plan files between two related file groups. It is the responsibility of the solution designer to ensure that the copied plan files will behave as expected in the target file group. For example, the plan file must be designed to dynamically save to the appropriate tables and columns within the context of the new file group.
The Copy On Demand Plan Files task uses two tabs to define the properties of the task.
- Options: Defines the options to be used for the copy operation
- Plan Files: Specifies the plan files to copy
Options tab
The following options are available on the Options tab. Note that all of these options can be changed dynamically by using system variables.
| Item | Description |
|---|---|
|
Source File Group |
The file group to copy plan files from. Click the folder icon to select a file group. You can select any on-demand file group, or any file group alias that currently points to an on-demand file group. |
|
Destination File Group |
The file group to copy plan files to. Click the folder icon to select a file group. You can select any on-demand file group, or any file group alias that currently points to an on-demand file group. |
|
Keep original plan file creator |
Specifies whether the plan file creator for the copied plan files is set to the same creator as the original plan files. By default, this option is enabled. If this option is disabled, then the plan file creator for the copied plan files is set to the user identity used by the Scheduler job when it is run. |
|
Use default template |
(missing or bad snippet) |
|
Copy plan file attachments |
(missing or bad snippet) |
|
Save plan files after copy |
Specifies whether the new plan files are processed and saved in the target file group after the copy is performed. This is intended to perform a save-to-database within the context of the new file group. By default, this option is disabled. If you enable this option, then after the plan files are copied to the new file group, they are opened, refreshed, and saved (including a save-to-database). The refresh includes all active Axiom queries where Refresh during document processing is enabled. Regardless of whether this option is enabled, if it is ever intended to save the copied plan files in the target file group, then they must be designed so that they save data to the appropriate tables after being copied. NOTES:
|
|
Copy data utility |
(missing or bad snippet) |
|
Default Values |
Optional. This section can be used to apply default values to any columns in the target plan code table, when the new record is created in the target file group. For more information, see Defining default values. |
Plan Files tab
On the Plan Files tab, specify the plan files from the source file group that you want to copy to the target file group. There are three different options that you can use to specify the plan files: Choose from list, Use filter, and All.
The most common option when copying plan files using Scheduler is to define a filter. You can dynamically copy a subset of designated plan files using the filter. If the Scheduler task is triggered by using RunEvent, you can pass in the filter from the source of the RunEvent (such as an Axiom form).
Copy a filtered set of plan files
To use a filter to copy a subset of plan files, select Use Filter. When the Scheduler task is executed, Axiom Budgeting and Forecasting for Higher Education will process only the plan files that meet the filter. You can specify the filter directly, or use a job variable.
To specify the filter, click the Filter Wizard button. You can also manually type a filter criteria statement into the filter box. The filter must use the plan code table of the source file group, or a lookup table. For example: CapReq2020.Transfer=1, where CapReq is the plan code table.
Once you have entered a filter, you can click Refresh plan file list to show the plan files that currently match the filter. The refresh feature is intended to help you determine whether you have defined the filter correctly.
If you want to set the filter dynamically, you can use the Filter system variable to override the filter defined in the task. This is intended for use when running Scheduler jobs via RunEvent. If a variable value is specified when triggering the event, such as the value CapReq2020.CapReq IN (45,67,98) , then that filter statement is used to determine the plan files to be copied instead of the filter defined in the task.
Copy all plan files
To copy all plan files, select All. When the Scheduler task is executed, Axiom Budgeting and Forecasting for Higher Education will copy all plan files in the file group (except for those hidden via the Show on List column). This is not a common use case for the copy feature, but can be used if needed.
Copy selected plan files
To copy certain plan files, select Choose from list, and then select the check boxes for the plan files that you want to copy. When the Scheduler task is executed, Axiom Budgeting and Forecasting for Higher Education will copy only the selected plan files. This is not a common use case for the copy feature, but can be used if needed.
NOTE: This option is not available when using a file group alias as the source 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.
(missing or bad snippet)Overriding task settings using system variables
All of the settings for the Copy On Demand Plan Files task can be overridden using system variables. This is intended for use when the task is being triggered by RunEvent (such as from within an Axiom form), and you want to pass in variable values to determine how the task is run.
The variable names for this task are as follows:
| Variable | Description |
|---|---|
CopyDataSourceFileGroupID | Overrides the Source File Group. Must be set to a valid file group ID. File group names or alias names cannot be used. |
CopyDataTargetFileGroupID | Overrides the Destination File Group. Must be set to a valid file group ID. File group names or alias names cannot be used. |
CopyDataUtilityPath | Overrides the Copy data utility. Must be set to a valid document path in Axiom Budgeting and Forecasting for Higher Education. |
Filter | Overrides the Plan File Filter to specify the plan files to copy. Must be set to a valid filter criteria statement. |
KeepOriginalPlanFileCreator | Overrides the option Keep original plan file creator. Must be set to a valid Boolean value (True/False). |
UseDefaultTemplate | Overrides the option Use default template. Must be set to a valid Boolean value (True/False). |
CopyPlanFileAttachments | Overrides the option Copy plan file attachments. Must be set to a valid Boolean value (True/False). |
SavePlanFilesAfterCopy | Overrides the option Save plan files after copy. Must be set to a valid Boolean value ( True/False). |
To override task properties using these variables:
Add the variables that you want to use to the Job Variables tab. For example, if you want to override the source and target file groups, the copy data utility, and the plan file filter, then add those variables to the Job Variables tab. You do not need to add a variable name if you do not plan to override it.
Example Job Variables tab to override certain settings for the copy task
You do not need to define a default value for the variable. If the value is blank, then the setting defined in the task is used. The corresponding task property will only be overridden if the variable has a defined value.
You do not need to add the variables to the task properties. The variables automatically overwrite the task properties if they have defined values.
When configuring RunEvent, define values for the variables as needed. For example, you could have a form where you allow the user to select the source and target file group for the copy action. Based on the user's selected file group names, you can use the GetFileGroupID function to determine the IDs for those file groups. You can then pass those IDs as variable values for the variables CopyDataSourceFileGroupID and CopyDataTargetFileGroupID.
Example RunEvent properties to pass certain variable values to the copy task
