AX1391

GetFileGroupProperty function

Returns information about a file group, such as the file group name or the current plan code.

NOTE: You can use a data lookup to return the same information as a GetFileGroupProperty function. Whenever possible, it is recommended to use data lookup queries over Axiom functions for faster performance.

Syntax

GetFileGroupProperty("CodeName", FileGroupID)

(missing or bad snippet)

All non-numeric entries must be placed in double quotation marks, unless you are using cell references to reference the text held in another cell.

Remarks

  • When using this function within a file that belongs to a file group, you may see a small performance improvement if you include the file group ID in the function rather than omitting it to assume the current file group. In this case you should have a single designated cell that uses the GetFileGroupID function to return the ID for the current file group, and then reference that cell to get the ID.

  • GetFileGroupProperty is a non-volatile function.

Examples

=GetFileGroupProperty("FileGroupName")

This example returns the name of the current file group, assuming the function is used within a file that belongs to a file group. For example: Budget 2022.

=GetFileGroupProperty("PlanFile",Variables!$F$20)

This example returns the plan code for the current plan file. For example: 100. In this example the file group ID is being specified by pointing to a designated cell on the Variables sheet that contains a GetFileGroupID function.

=GetFileGroupProperty("ScenarioName",83)

This example returns the scenario name of the file group with ID 83. For example: V1. In a report file, the file group ID must be specified because there is no current file group context. In most cases the ID would not be "hard-coded" in the function as shown here—instead it would be returned via the GetFileGroupID function or from a query to a system table such as Axiom.FileGroups.

=GetFileGroupProperty("UtilitiesPath")

This example returns the path to the Utilities folder for the current file group. For example: \Axiom\SystemFolderName_FileGroups\Capital Requests\SystemFolderName_Utilities. This could be used to build up dynamic paths to certain driver files, so that the paths would automatically update when the file group is cloned.

See also