File group properties

The name of the file group or the file group scenario. You can use any file group variable in the name, including built-in variables such as {FileGroupYear}.

If the current file group is a scenario, then the name cannot be edited.

NOTES:  

• File group names cannot contain characters that are not allowed in Windows file paths. This includes the following characters: backslash and forward slash, colon, asterisk, question mark, double quotation mark, greater than and less than, and pipe.

• The resolved file group name (after substituting any variables with their values) must be unique. For example, you can have two file groups where the name is defined as Budget {FileGroupYear}, but only if the year values are unique for each file group. If both file groups are set to the same year, then the resolved names are not unique and you will be prevented from saving the duplicate name.

Optional. The year of planning for the file group. For example, if the file group is being used to create the budget for the 2020 fiscal year, then the File Group Year should be set to 2020.

If defined, this value can be used in the file group name, the display name, the tab prefix, and in other file group variables. Enter the full four-digit year number, not a two-digit year number. The two-digit version can be returned by using built-in variables for the file group. For more information, see Using years as variables in file groups.

To use the file group year in the file group name, click the use in file group name link to the right of the box. This link only displays if a value has been defined for the year. Clicking this link adds the {FileGroupYear} variable to the end of the File Group Name (for example: "Budget 2020" where 2020 is the file group year). Alternatively you can type the variable within the file group name or in any other supported field.

Optional. The category for the file group. File groups that belong to a category can display together on the ribbon and in the Explorer task pane.

The category must already be defined in order to assign a file group to it. For more information, see Using file group categories.

The reference table that defines the list of plan codes for the file group.

For example, budgets might be planned by department, forecasts might be planned by division, and capital plans might be planned by project. Generally, each item in the specified table will have a plan file in the file group. For more information, see Plan code tables for file groups.

This setting cannot be changed once any plan files have been created for the file group.

If the selected table uses an identity column for the key column, then the file group is automatically flagged as an on-demand file group. Tables that use an identity column are indicated in the drop-down list with a special icon ().

NOTES:  

• Key columns in plan code tables cannot contain characters that are not allowed in Windows file paths. This includes the following characters: backslash and forward slash, colon, asterisk, question mark, double quotation mark, greater than and less than, and pipe. The table will be validated for these characters when creating the file group, and when saving data to the table.

• Picklist tables and KPI tables are not eligible to be plan code tables.

The name to be displayed on the file group's button on the Axiom ribbon tab, in the Explorer task pane, and in other areas where file groups are displayed. This name is how users select file groups to work with.

By default, the display name is the same as the file group name. If you update the file group name, the display name will remain in sync. However, if you want to define a different display name, then type in any value. You can use any file group variable in the name, including built-in variables such as {FileGroupYear}.

If you have defined a different display name and you want to go back to using the file group name, click the Use file group name button to the right of the box.

If the current file group is a scenario, then the display name cannot be edited.

Optional. The text to be displayed on the file tab of files associated with this file group. The text displays before any other text on the file tab. The tab prefix applies to plan files and driver files.

The intent of this setting is to help users identify which files belong to which file groups, if they have multiple files open. For example, the tab prefix for the 2019 Budget file group could be "[BGT19]".

You can use any file group variable in the name, including built-in variables such as {ShortFileGroupYear}.

If left blank, then no file group identifier displays on the file tab when the file is opened. However, you can hover your cursor over the tab to see the file group name displayed in the tooltip.

Select this check box to allow use of the Create Plan Files utility for the file group, to create plan files from templates.

This option is selected by default for standard file groups, and disabled by default for on-demand file groups. However, you can change the setting for either file group as desired.

• If this check box is selected, then the Create Plan Files utility is available for the file group, for users with the appropriate rights.
• If this check box is not selected, then the utility is not available for the file group. For on-demand file groups, this is the default state, and users can create plan files as normal using the Open Plan Files dialog.

You might disable this check box for a standard file group as a means of "freezing" plan file creation for the file group, or if the file group is intended to be used only as a target file group for copying plan files.

The default template to use when building plan files for the file group. You can type a template name, or select from a drop-down list of existing templates for the file group. Do not include the file extension on the name.

File group variables can also be used in this setting. You might do this in order to dynamically change the default template by using a Save Type 4 utility that changes the value of the variable.

This setting is used in the following ways:

• If no template column is specified, then the default template is used to create all plan files.
• If a template column is specified, but a particular plan code does not have an entry in that column, then the default template is used for that plan code. However, if a plan code has an entry in the template column, but the entry is invalid, the default template is not used and an error results.

NOTE: If you are creating a new file group, then no templates exist for that file group yet. You can either manually type the name that you intend to give a template, or you can modify the settings later after you have created templates.

Optional. Select this check box to enable storing file attachments as supporting documents for plan files.

This option is disabled by default, which means that file attachment features will not be available for the file group.

If this option is enabled, then file attachment features will be available for the file group. Users can add, delete, and view file attachments that are associated with a particular plan file, depending on their security permissions to the plan file. For more information, see Using file attachments with file groups.

Optional. Select this check box to use virtual plan files with the file group.

This option is disabled by default, which means that persistent, physical plan files are generated and stored for each plan code in the file group.

If this option is enabled, then physical plan files are not stored for the file group. Instead, temporary, virtual plan files are generated as needed from the template. The template must be designed as "rebuildable" in order to support virtual plan files. For more information on using virtual plan files, see Using virtual plan files.

Optional. Select this check box if the default processing mode for plan files should be to process with utilities instead of normal processing. This is primarily intended for file groups that use form-enabled plan files, where the content of each plan file is sourced from various utility files instead of defined within the plan file itself (by use of embedded forms).

If enabled, this setting impacts the following behavior for this file group:

• The default processing mode for Process Plan Files is now Process with Utilities instead of Normal Processing.

• If a step in a plan file process definition is set to Save and validate plan file before advancing to next step, utility processing is performed for the plan file instead of saving the plan file itself.

Optional. The column in the plan code table that specifies whether a plan code should be included in file group lists and available to file group processes. You can select from any Boolean column in the plan code table.

If no column is specified, then all plan codes will be included in file group lists and available to file group processes.

If a column is specified, and a plan code is set to False in that column, then that plan code will not display in dialogs that list plan files, such as Create Plan Files or Open Plan Files. The plan code cannot be included in file group processes.

For more information, see Using a Show On List column.

Optional. The default notification email address(es) for the file group. Separate multiple addresses with semicolons.

The default notification address is used if no Notification Address Column is specified, or if a column is specified but a plan code does not have an assigned value in the column.

This address can be used in Scheduler jobs by using the system variable {NotificationAddress}. A value will only be passed when the Scheduler job is executed by use of file group triggers.

Enter the text that you want to display to users to create a new plan file, such as "Add new file" or "Add new capital request".

This text will display in the top right-hand corner of the Open Plan Files dialog in the Excel Client and the Windows Client.

This text is required, even if end users will not be using this option to create plan files (for example, if all end users will use the Web Client).

Optional. Specify an Axiom form to use as the "input form" to collect starting values for the plan code table when creating a new plan file. You can select any form-enabled file stored in the Utilities folder for the file group (recommended), or in the Reports Library.

If an Axiom form is specified, then when a user clicks the "add new file" command in the Open Plan Files dialog, the form will be opened as a "dialog" within the application so that the user can complete inputs on the form. This form replaces the built-in prompt for validated columns.

For more information on using this feature, see Using an Axiom form as an "add file" dialog for an on-demand file group.

Specifies whether the event is active. This check box is enabled by default, which means that the event will be triggered any time data is saved from plan files in the file group.

To disable the event, clear the check box. In this case, saving data will not trigger the event. This is primarily intended for situations where you want to temporarily disable the event, with the intent of re-enabling it at some future time.

If you no longer need an event, you can delete it instead of disabling it.

The name of the event to trigger when data is saved from plan files in the file group.

When the event is triggered, Axiom Software looks for any Scheduler jobs that contain an event handler with this name. If any jobs are found, they are added to the schedule and are eligible to be processed immediately, depending on Scheduler thread availability and any other higher-priority jobs already in the queue.

If no matching jobs are found, no further action occurs, and no errors are generated.