AX1652

File Group Rollover command

Use the File Group Rollover command to clone an existing file group for a new year of planning. This command is intended to be used with year-based file groups, where each year you create a new file group for the new year of planning.

Can be used in

Ribbon tabs
Scheduler
Task panes

When the File Group Rollover command is selected from the Command Library as the shortcut target, it displays as command://RolloverFileGroup or command://RolloverFileGroupCommandAdapter (legacy syntax).

Shortcut parameters

This command uses the following shortcut parameters:

Item Description

Item	Description
Source file group	The existing file group to clone. This file group must be year-based, meaning it must have a defined File Group Year. Additionally, the `{FileGroupYear}` variable must be used in the file group name. The file group year is incremented by 1 when performing the clone.
Copy data utility	Optional. Specify a utility to process after the new file group is created. You can select any file in the Reports Library. After the new file group is created and after drivers have been processed in the new file group, a Scheduler job is automatically created to process the specified utility. Active Axiom queries are run in the utility (where Refresh during document processing is enabled) and then a save-to-database is performed. The user executing the command must have save data permissions for the utility file. NOTE: The file browser also allows selection of utility files in file groups, but this is of limited usefulness. If you select a file in the source file group, that is the file that will be run – the command will not automatically run the copied file in the new file group. Currently, there is no way to select a utility file for processing within the new file group.
File group alias	Optional. Select an alias to update as part of the file group rollover. You can select any file group alias defined in the system. If an alias name is specified, then after the new file group is created, the file group alias is updated to point to that new file group. Keep in mind that this means the new file group is immediately available to any other feature or file that uses the alias.

Source file group

The existing file group to clone. This file group must be year-based, meaning it must have a defined File Group Year. Additionally, the {FileGroupYear} variable must be used in the file group name. The file group year is incremented by 1 when performing the clone.

Copy data utility

Optional. Specify a utility to process after the new file group is created. You can select any file in the Reports Library.

After the new file group is created and after drivers have been processed in the new file group, a Scheduler job is automatically created to process the specified utility. Active Axiom queries are run in the utility (where Refresh during document processing is enabled) and then a save-to-database is performed. The user executing the command must have save data permissions for the utility file.

NOTE: The file browser also allows selection of utility files in file groups, but this is of limited usefulness. If you select a file in the source file group, that is the file that will be run – the command will not automatically run the copied file in the new file group. Currently, there is no way to select a utility file for processing within the new file group.

File group alias

Optional. Select an alias to update as part of the file group rollover. You can select any file group alias defined in the system.

If an alias name is specified, then after the new file group is created, the file group alias is updated to point to that new file group. Keep in mind that this means the new file group is immediately available to any other feature or file that uses the alias.

Clients with installed products may have access to preconfigured commands with a second parameter of Source Prototype. If a source prototype is listed, the new file group will be created by cloning a file group template provided by the product (the file group "prototype"), instead of by cloning the existing file group. Certain file group settings, such as display items and the process definition, are copied from the source file group to the new file group. For more information on using this command with a source prototype, see the separate product documentation.

File group clone process

When File Group Rollover is used to clone an existing file group, the process is the same as when using the normal file group clone feature, except that there are no user inputs. The new file group is created as follows:

The File Group Year of the file group is incremented by 1. For example, if the file group year is currently 2019, it will be changed to 2020 for the new file group.
If the plan code table for the source file group uses a file group year, such as CapReq2019, that table is cloned to create a new plan code table with the new year (CapReq2020). If the plan code table does not use a file group year, then the new file group will use the same plan code table.
New year-based tables will be created as needed for table variables and picklist variables, assuming the table and picklist variables use the {FileGroupYear} variable. As when performing a regular file group clone, the new tables are created by cloning the existing tables, including cloning table security. For reference tables and picklist tables, data is also copied.
Templates, drivers, utilities, and process definitions are all copied to the new file group.
Security is copied to the new file group.
Drivers are processed after the new file group is created.
If an alias is specified in the command, the alias is updated to point to the new file group.
If a utility is specified in the command, the utility is processed by Scheduler.

The user running the command must have the Administer File Groups security permission to create the new file group, the Administer Tables security permission to create the new tables. Additionally, the user must have the appropriate permissions to access the driver files and save data, or else the driver processing will fail.

Visibility in task panes and ribbon tabs

In task panes and ribbon tabs, items using this command are only visible if the current user has the Administer File Groups security permission. If the user does not have the appropriate permissions, then the item is hidden. You can use the Show restricted items option for the task pane or the ribbon tab to force the item to be visible at all times (but grayed out if unavailable).

Visibility does not apply when the command is used in a Scheduler job. If a user attempts to execute the command but does not have the appropriate permissions, the execution will fail with an error.