AX1575
Create File Group Scenario command
Use the Create File Group Scenario command to create a scenario of an existing file group. This command performs the same action as Create Scenario on the file group menu, however, when using the command certain options can be preconfigured. Additionally, you can schedule the scenario creation and use server-side processing.
Can be used in
- Ribbon tabs
- Scheduler (Execute Command Adapter task)
- Task panes
When the Create File Group Scenario command is selected from the Command Library as the shortcut target, it displays as command://CreateFileGroupScenario.
Shortcut parameters
This command uses the following shortcut parameters:
| Item | Description |
|---|---|
|
File Group |
The file group for which to create a scenario. To select a file group, click the folder icon to the right of the box. In the Choose File Group dialog, select the desired file group or file group alias. If you select an alias, the command will be performed on the file group that is currently assigned to that alias. If you are using the command in a Scheduler task, and the Scheduler job is saved in a file group Utilities folder, then an additional option is available: Use Current File Group. This option means that the command will always point to the file group where the Scheduler job is currently located, even if you clone the file group or copy the file to a different file group. This option is located at the top of the Show file groups list. |
|
Scenario Name |
Enter a name for the scenario, such as If the specified scenario name is already in use for this file group, then the scenario creation process will fail. Each scenario must have a unique name. When running the command in Scheduler, job variables can be used to define the name. For example, you can enter a variable such as This field is required when running the command in Scheduler, and optional when running the command from a task pane or ribbon tab. If this field is left blank in a task pane or ribbon tab, then the Create Scenario dialog opens so that the user can define a scenario name. |
|
Table Suffix |
Optional. Enter a suffix to append to the tables that will be created for the scenario. For example, When the scenario is created, new tables will be created for all table variables in the file group that meet the following criteria:
When the new tables are created, the table suffix is appended to the table name. For example, if the original table name is BGT2022, and the table suffix is _V1, then the scenario table name is BGT2022_V1. The table suffix cannot use spaces or special characters (other than the underscore). The resulting table name must meet the normal table naming requirements. If Table Suffix is left blank, then Axiom Financial Institutions Suite will auto-generate a table suffix, such as _V1, _V1A, and so on. IMPORTANT: If the scenario table name matches an existing table name, then no new table is created. This may result in a situation where the parent file group and the scenario are saving to the same table, or multiple scenarios are saving to the same table, which is not desirable in most cases. If the scenario needs dedicated tables for saving data, then make sure that the table suffix is unique. |
|
Description |
Optional. Enter a description to be stored in the scenario properties. When running the command in Scheduler, job variables can be used in the description. |
File group variables
You can use the File Group Variables section to pass in values for file group variables defined in the source file group. These values will be applied to the scenario when it is created. For example, you can use this section to pass in a value to an Escalator variable that you want to change in the scenario.
This section can also be used to create new variables within the scenario file group. If a variable name defined here does not match an existing variable in the source file group, then that variable will be created in the scenario file group, with the value defined in the command.
To define variable values:
-
Click the plus button
to add a new variable/value pair to the File Group Variables section. -
In the left-hand box, type the name of the variable. For example:
PayrollEscalator. If the variable name exists in the source file group, then the variable value will be updated in the scenario file group. If the variable name does not exist in the source file group, then the new variable will be created in the scenario file group. -
In the right-hand box, type the value to be used for this variable. For example:
.08.If you are running the command in Scheduler, you can use a Scheduler job variable to set the value for the file group variable. For example, you can enter a job variable such as
{PayrollValue}. The file group variable will then be set to the value of the Scheduler job variable.
NOTE: If you use the File Group Variables section to pass in the value for a table variable, that value will be used as is. The Table Suffix will not be appended to the passed value. If the passed value matches an existing table name, then no scenario table is created for that table variable.
Command behavior
If the command is used in a task pane or ribbon tab, and the Scenario Name is left blank, then the Create Scenario dialog opens. The dialog is pre-populated with the information from the command, including the specified table suffix and any file group variable values. The user can define a scenario name in the dialog, and modify any other settings before initiating scenario creation.
If the command is used in a task pane or ribbon tab, and the Scenario Name is defined, then the Create Scenario dialog does not display to the user, and the user does not have any opportunity to change the scenario settings. The scenario creation process is automatically initiated based on the information in the command. However, any confirmation or warning dialogs that would normally display before scenario creation will still display to the user, and the user can cancel the process from those dialogs if needed.
If the command is run by Scheduler, then the scenario creation process is performed solely based on the information in the command.
For more information about file group scenarios and the creation process, see File group scenarios.
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.
